airflow.providers.amazon.aws.sensors.step_function

Module Contents

Classes

StepFunctionExecutionSensor

Asks for the state of the Step Function State Machine Execution until it
class airflow.providers.amazon.aws.sensors.step_function.StepFunctionExecutionSensor(*, execution_arn: str, aws_conn_id: str = 'aws_default', region_name: Optional[str] = None, **kwargs)[source]

Bases: airflow.sensors.base.BaseSensorOperator

Asks for the state of the Step Function State Machine Execution until it reaches a failure state or success state. If it fails, failing the task.

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

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(self, context: airflow.utils.context.Context)[source]

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

get_hook(self) → airflow.providers.amazon.aws.hooks.step_function.StepFunctionHook[source]

Create and return a StepFunctionHook

Was this entry helpful?