airflow.providers.amazon.aws.operators.quicksight¶

Classes¶

QuickSightCreateIngestionOperator

Creates and starts a new SPICE ingestion for a dataset; also helps to Refresh existing SPICE datasets.

Module Contents¶

class airflow.providers.amazon.aws.operators.quicksight.QuickSightCreateIngestionOperator(data_set_id, ingestion_id, ingestion_type='FULL_REFRESH', wait_for_completion=True, check_interval=30, **kwargs)[source]¶

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.quicksight.QuickSightHook]

Creates and starts a new SPICE ingestion for a dataset; also helps to Refresh existing SPICE datasets.

See also

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

Parameters:

data_set_id (str) – ID of the dataset used in the ingestion.
ingestion_id (str) – ID for the ingestion.
ingestion_type (str) – Type of ingestion. Values Can be INCREMENTAL_REFRESH or FULL_REFRESH. Default FULL_REFRESH.
wait_for_completion (bool) – If wait is set to True, the time interval, in seconds, that the operation waits to check the status of the Amazon QuickSight Ingestion.
check_interval (int) – if wait is set to be true, this is the time interval in seconds which the operator will check the status of the Amazon QuickSight Ingestion
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][source]¶

ui_color = '#ffd700'[source]¶

data_set_id[source]¶

ingestion_id[source]¶

ingestion_type = 'FULL_REFRESH'[source]¶

wait_for_completion = True[source]¶

check_interval = 30[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.