airflow.providers.amazon.aws.sensors.athena

Module Contents

Classes

AthenaSensor

Asks for the state of the Query until it reaches a failure state or success state.
class airflow.providers.amazon.aws.sensors.athena.AthenaSensor(*, query_execution_id, max_retries=None, aws_conn_id='aws_default', sleep_time=10, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Asks for the state of the Query until it reaches a failure state or success state. If the query fails, the task will fail.

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 (Optional[int]) -- Number of times to poll for query state before returning the current state, defaults to None

  • aws_conn_id (str) -- aws connection to use, defaults to 'aws_default'

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

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

Function that the sensors defined while deriving this class should override.

hook(self)[source]

Create and return an AthenaHook

Was this entry helpful?