Source code for

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

from functools import cached_property
from typing import TYPE_CHECKING, Sequence

from airflow.exceptions import AirflowException, AirflowSkipException
from import QuickSightHook
from import StsHook
from airflow.sensors.base import BaseSensorOperator

    from airflow.utils.context import Context

[docs]class QuickSightSensor(BaseSensorOperator): """ Watches for the status of an Amazon QuickSight Ingestion. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:QuickSightSensor` :param data_set_id: ID of the dataset used in the ingestion. :param ingestion_id: ID for the ingestion. :param aws_conn_id: The Airflow connection used for AWS credentials. (templated) If this is None or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then the default boto3 configuration would be used (and must be maintained on each worker node). """
[docs] template_fields: Sequence[str] = ("data_set_id", "ingestion_id", "aws_conn_id")
def __init__( self, *, data_set_id: str, ingestion_id: str, aws_conn_id: str = "aws_default", **kwargs, ) -> None: super().__init__(**kwargs) self.data_set_id = data_set_id self.ingestion_id = ingestion_id self.aws_conn_id = aws_conn_id self.success_status = "COMPLETED" self.errored_statuses = ("FAILED", "CANCELLED")
[docs] def poke(self, context: Context) -> bool: """ Pokes until the QuickSight Ingestion has successfully finished. :param context: The task context during execution. :return: True if it COMPLETED and False if not. """"Poking for Amazon QuickSight Ingestion ID: %s", self.ingestion_id) aws_account_id = self.sts_hook.get_account_number() quicksight_ingestion_state = self.quicksight_hook.get_status( aws_account_id, self.data_set_id, self.ingestion_id )"QuickSight Status: %s", quicksight_ingestion_state) if quicksight_ingestion_state in self.errored_statuses: error = self.quicksight_hook.get_error_info(aws_account_id, self.data_set_id, self.ingestion_id) message = f"The QuickSight Ingestion failed. Error info: {error}" if self.soft_fail: raise AirflowSkipException(message) raise AirflowException(message) return quicksight_ingestion_state == self.success_status
[docs] def quicksight_hook(self): return QuickSightHook(aws_conn_id=self.aws_conn_id)
[docs] def sts_hook(self): return StsHook(aws_conn_id=self.aws_conn_id)

Was this entry helpful?