airflow.providers.amazon.aws.hooks.step_function

Module Contents

Classes

StepFunctionHook

Interact with an AWS Step Functions State Machine.
class airflow.providers.amazon.aws.hooks.step_function.StepFunctionHook(*args, **kwargs)[source]

Bases: airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook

Interact with an AWS Step Functions State Machine.

Provide thin wrapper around boto3.client("stepfunctions").

Additional arguments (such as aws_conn_id) may be specified and are passed down to the underlying AwsBaseHook.

See also

start_execution(state_machine_arn, name=None, state_machine_input=None)[source]

Start Execution of the State Machine.

See also

Parameters

  • state_machine_arn (str) – AWS Step Function State Machine ARN.

  • name (str | None) – The name of the execution.

  • state_machine_input (dict | str | None) – JSON data input to pass to the State Machine.

Returns

Execution ARN.

Return type

str

describe_execution(execution_arn)[source]

Describes a State Machine Execution.

See also

Parameters

execution_arn (str) – ARN of the State Machine Execution.

Returns

Dict with execution details.

Return type

dict

Was this entry helpful?