`airflow.providers.amazon.aws.sensors.step_function`¶

Module Contents¶

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, **kwargs)[source]¶

Bases: airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor[airflow.providers.amazon.aws.hooks.step_function.StepFunctionHook]

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 – 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

poke(context)[source]¶

Override when deriving this class.

Create and return a StepFunctionHook.