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 deprecated import deprecated

from airflow.exceptions import AirflowException, AirflowProviderDeprecationWarning, AirflowSkipException
from import QuickSightHook
from import AwsBaseSensor

    from airflow.utils.context import Context

[docs]class QuickSightSensor(AwsBaseSensor[QuickSightHook]): """ 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. 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 default boto3 configuration would be used (and must be maintained on each worker node). :param region_name: AWS region_name. If not specified then the default boto3 behaviour is used. :param verify: Whether or not to verify SSL certificates. See: :param botocore_config: Configuration dictionary (key-values) for botocore client. See: """
[docs] aws_hook_class = QuickSightHook
[docs] template_fields: Sequence[str] = ("data_set_id", "ingestion_id", "aws_conn_id")
def __init__(self, *, data_set_id: str, ingestion_id: str, **kwargs): super().__init__(**kwargs) self.data_set_id = data_set_id self.ingestion_id = ingestion_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) quicksight_ingestion_state = self.hook.get_status(None, self.data_set_id, self.ingestion_id)"QuickSight Status: %s", quicksight_ingestion_state) if quicksight_ingestion_state in self.errored_statuses: error = self.hook.get_error_info(None, 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
@cached_property @deprecated( reason=( "`QuickSightSensor.quicksight_hook` property is deprecated, " "please use `QuickSightSensor.hook` property instead." ), category=AirflowProviderDeprecationWarning, )
[docs] def quicksight_hook(self): return self.hook
@cached_property @deprecated( reason=( "`QuickSightSensor.sts_hook` property is deprecated and will be removed in the future. " "This property used for obtain AWS Account ID, " "please consider to use `QuickSightSensor.hook.account_id` instead" ), category=AirflowProviderDeprecationWarning, )
[docs] def sts_hook(self): from import StsHook return StsHook(aws_conn_id=self.aws_conn_id)

Was this entry helpful?