`airflow.providers.amazon.aws.hooks.quicksight`¶

Module Contents¶

Interact with Amazon QuickSight.

class airflow.providers.amazon.aws.hooks.quicksight.QuickSightHook(*args, **kwargs)[source]¶

Interact with Amazon QuickSight.

Additional arguments (such as aws_conn_id) may be specified and are passed down to the underlying AwsBaseHook. .. seealso:: AwsBaseHook

create_ingestion(self, data_set_id, ingestion_id, ingestion_type, wait_for_completion=True, check_interval=30)[source]¶

Creates and starts a new SPICE ingestion for a dataset. Refreshes the SPICE datasets

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 . "INCREMENTAL_REFRESH"|"FULL_REFRESH"
wait_for_completion (bool) -- if the program should keep running until job finishes
check_interval (int) -- the time interval in seconds which the operator will check the status of QuickSight Ingestion

Returns

Returns descriptive information about the created data ingestion having Ingestion ARN, HTTP status, ingestion ID and ingestion status.

Return type

Dict

get_status(self, aws_account_id, data_set_id, ingestion_id)[source]¶

Get the current status of QuickSight Create Ingestion API.

Parameters

Returns

An QuickSight Ingestion Status

Return type

str

wait_for_state(self, aws_account_id, data_set_id, ingestion_id, target_state, check_interval)[source]¶

Check status of a QuickSight Create Ingestion API

Parameters

aws_account_id (str) -- An AWS Account ID
data_set_id (str) -- QuickSight Data Set ID
ingestion_id (str) -- QuickSight Ingestion ID
target_state (set) -- Describes the QuickSight Job's Target State
check_interval (int) -- the time interval in seconds which the operator will check the status of QuickSight Ingestion

Returns

response of describe_ingestion call after Ingestion is is done