PARALLAX

stepfunctions_state_machine_execution

Start or stop execution of an AWS Step Functions state machine

Collection: community.aws

Full Name: community.aws.stepfunctions_state_machine_execution

Synopsis

Start or stop execution of an AWS Step Functions state machine

Parameters

NameTypeRequiredDefaultDescription
access_keystr
actionstrstart
aws_ca_bundlepath
aws_configdict
causestr
debug_botocore_endpoint_logsboolfalse
endpoint_urlstr
errorstr
execution_arnstr
execution_inputjsonmap[]
namestr
profilestr
regionstr
secret_keystr
session_tokenstr
state_machine_arnstr
validate_certsbooltrue

Example

yaml
- name: Start an execution of a state machine
  community.aws.stepfunctions_state_machine_execution:
    name: an_execution_name
    execution_input: '{ "IsHelloWorldExample": true }'
    state_machine_arn: "arn:aws:states:us-west-2:123456789012:stateMachine:HelloWorldStateMachine"

- name: Stop an execution of a state machine
  community.aws.stepfunctions_state_machine_execution:
    action: stop
    execution_arn: "arn:aws:states:us-west-2:123456789012:execution:HelloWorldStateMachineCopy:a1e8e2b5-5dfe-d40e-d9e3-6201061047c8"
    cause: "cause of task failure"
    error: "error code of the failure"
Search
    ↑ ↓ move↵ openesc close