airflow.providers.amazon.aws.sensors.quicksight¶

Classes¶

QuickSightSensor

Watches for the status of an Amazon QuickSight Ingestion.

Module Contents¶

class airflow.providers.amazon.aws.sensors.quicksight.QuickSightSensor(*, data_set_id, ingestion_id, max_retries=2160, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]¶

Bases: airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor[airflow.providers.amazon.aws.hooks.quicksight.QuickSightHook]

Watches for the status of an Amazon QuickSight Ingestion.

See also

For more information on how to use this sensor, take a look at the guide: Amazon QuickSight ingestion sensor

Parameters:

data_set_id (str) – ID of the dataset used in the ingestion.
ingestion_id (str) – ID for the ingestion.
max_retries (int) – Number of times before returning the current state. (default: 2160)
deferrable (bool) – If True, the sensor will operate in deferrable mode. This mode requires aiobotocore module to be installed. (default: False, but can be overridden in config file by setting default_deferrable to True)
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).
region_name – AWS region_name. If not specified then the default boto3 behaviour is used.
verify – Whether or not to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html
botocore_config – Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

aws_hook_class[source]¶

template_fields: collections.abc.Sequence[str] = ('data_set_id', 'ingestion_id', 'aws_conn_id')[source]¶

data_set_id[source]¶

ingestion_id[source]¶

max_retries = 2160[source]¶

deferrable[source]¶

success_status = 'COMPLETED'[source]¶

errored_statuses = ('FAILED', 'CANCELLED')[source]¶

execute(context)[source]¶

Derive when creating an operator.

The main method to execute the task. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_complete(context, event=None)[source]¶

poke(context)[source]¶

Pokes until the QuickSight Ingestion has successfully finished.

Parameters:: context (airflow.sdk.Context) – The task context during execution.
Returns:: True if it COMPLETED and False if not.
Return type:: bool