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(region_name: Optional[str] = None, *args, **kwargs)[source]

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

Interact with an AWS Step Functions State Machine.

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

See also

AwsBaseHook

start_execution(self, state_machine_arn: str, name: Optional[str] = None, state_machine_input: Union[dict, str, None] = None) → str[source]

Start Execution of the State Machine. https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions.html#SFN.Client.start_execution

Parameters

  • state_machine_arn (str) -- AWS Step Function State Machine ARN

  • name (Optional[str]) -- The name of the execution.

  • state_machine_input (Union[Dict[str, any], str, None]) -- JSON data input to pass to the State Machine

Returns

Execution ARN

Return type

str

describe_execution(self, execution_arn: str) → dict[source]

Describes a State Machine Execution https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/stepfunctions.html#SFN.Client.describe_execution

Parameters

execution_arn (str) -- ARN of the State Machine Execution

Returns

Dict with Execution details

Return type

dict

Was this entry helpful?