airflow.providers.amazon.aws.operators.step_function

Module Contents

Classes

StepFunctionStartExecutionOperator

An Operator that begins execution of an Step Function State Machine

StepFunctionGetExecutionOutputOperator

An Operator that begins execution of an Step Function State Machine
class airflow.providers.amazon.aws.operators.step_function.StepFunctionStartExecutionOperator(*, state_machine_arn: str, name: Optional[str] = None, state_machine_input: Union[dict, str, None] = None, aws_conn_id: str = 'aws_default', region_name: Optional[str] = None, **kwargs)[source]

Bases: airflow.models.BaseOperator

An Operator that begins execution of an Step Function State Machine

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

See also

BaseOperator

Parameters

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

  • 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

  • aws_conn_id (str) -- aws connection to uses

  • do_xcom_push (bool) -- if True, execution_arn is pushed to XCom with key execution_arn.

template_fields :Sequence[str] = ['state_machine_arn', 'name', 'input'][source]
template_ext :Sequence[str] = [][source]
ui_color = #f9c915[source]
execute(self, context: airflow.utils.context.Context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

class airflow.providers.amazon.aws.operators.step_function.StepFunctionGetExecutionOutputOperator(*, execution_arn: str, aws_conn_id: str = 'aws_default', region_name: Optional[str] = None, **kwargs)[source]

Bases: airflow.models.BaseOperator

An Operator that begins execution of an Step Function State Machine

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

See also

BaseOperator

Parameters

  • execution_arn (str) -- ARN of the Step Function State Machine Execution

  • aws_conn_id (str) -- aws connection to use, defaults to 'aws_default'

template_fields :Sequence[str] = ['execution_arn'][source]
template_ext :Sequence[str] = [][source]
ui_color = #f9c915[source]
execute(self, context: airflow.utils.context.Context)[source]

This is the main method to 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?