airflow.providers.amazon.aws.sensors.athena

Module Contents

Classes

AthenaSensor

Poll the state of the Query until it reaches a terminal state; fails if the query fails.

class airflow.providers.amazon.aws.sensors.athena.AthenaSensor(*, query_execution_id, max_retries=None, sleep_time=10, **kwargs)[source]

Bases: airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor[airflow.providers.amazon.aws.hooks.athena.AthenaHook]

Poll the state of the Query until it reaches a terminal state; fails if the query fails.

See also

For more information on how to use this sensor, take a look at the guide: Wait on Amazon Athena query results

Parameters
  • query_execution_id (str) – query_execution_id to check the state of

  • max_retries (int | None) – Number of times to poll for query state before returning the current state, defaults to None

  • sleep_time (int) – Time in seconds to wait between two consecutive call to check query status on athena, defaults to 10

  • 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

INTERMEDIATE_STATES = ('QUEUED', 'RUNNING')[source]
FAILURE_STATES = ('FAILED', 'CANCELLED')[source]
SUCCESS_STATES = ('SUCCEEDED',)[source]
aws_hook_class[source]
template_fields: Sequence[str][source]
ui_color = '#66c3ff'[source]
poke(context)[source]

Override when deriving this class.

Was this entry helpful?