airflow.providers.amazon.aws.sensors.step_function

Module Contents

Classes

StepFunctionExecutionSensor

Poll the Step Function State Machine Execution until it reaches a terminal state; fails if the task fails.
class airflow.providers.amazon.aws.sensors.step_function.StepFunctionExecutionSensor(*, execution_arn, aws_conn_id='aws_default', region_name=None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Poll the Step Function State Machine Execution until it reaches a terminal state; fails if the task fails.

On successful completion of the Execution the Sensor will do an XCom Push of the State Machine’s output to output

See also

For more information on how to use this sensor, take a look at the guide: Wait on an AWS Step Functions state machine execution state

Parameters

  • execution_arn (str) – execution_arn to check the state of

  • aws_conn_id (str) – aws connection to use, defaults to ‘aws_default’

INTERMEDIATE_STATES = ('RUNNING',)[source]
FAILURE_STATES = ('FAILED', 'TIMED_OUT', 'ABORTED')[source]
SUCCESS_STATES = ('SUCCEEDED',)[source]
template_fields: Sequence[str] = ('execution_arn',)[source]
template_ext: Sequence[str] = ()[source]
ui_color = '#66c3ff'[source]
poke(context)[source]

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

get_hook()[source]

Create and return a StepFunctionHook.

hook()[source]

Was this entry helpful?