airflow.providers.amazon.aws.operators.step_function

Module Contents

Classes

StepFunctionStartExecutionOperator

An Operator that begins execution of an AWS Step Function State Machine.

StepFunctionGetExecutionOutputOperator

An Operator that returns the output of an AWS Step Function State Machine execution.
class airflow.providers.amazon.aws.operators.step_function.StepFunctionStartExecutionOperator(*, state_machine_arn, name=None, state_machine_input=None, waiter_max_attempts=30, waiter_delay=60, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.step_function.StepFunctionHook]

An Operator that begins execution of an AWS Step Function State Machine.

Additional arguments may be specified and are passed down to the underlying BaseOperator.

See also

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

Parameters

  • state_machine_arn (str) – ARN of the Step Function State Machine

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

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

  • aws_conn_id – aws connection to uses

  • do_xcom_push – if True, execution_arn is pushed to XCom with key execution_arn.

  • waiter_max_attempts (int) – Maximum number of attempts to poll the execution.

  • waiter_delay (int) – Number of seconds between polling the state of the execution.

  • deferrable (bool) – If True, the operator will wait asynchronously for the job to complete. This implies waiting for completion. This mode requires aiobotocore module to be installed. (default: False, but can be overridden in config file by setting default_deferrable to True)

  • 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

aws_hook_class[source]
template_fields: Sequence[str][source]
ui_color = '#f9c915'[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

execute_complete(context, event=None)[source]
class airflow.providers.amazon.aws.operators.step_function.StepFunctionGetExecutionOutputOperator(*, execution_arn, **kwargs)[source]

Bases: airflow.providers.amazon.aws.operators.base_aws.AwsBaseOperator[airflow.providers.amazon.aws.hooks.step_function.StepFunctionHook]

An Operator that returns the output of an AWS Step Function State Machine execution.

Additional arguments may be specified and are passed down to the underlying BaseOperator.

See also

For more information on how to use this operator, take a look at the guide: Get an AWS Step Functions execution output

Parameters
aws_hook_class[source]
template_fields: Sequence[str][source]
ui_color = '#f9c915'[source]
execute(context)[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?