Skip to content

StepFunctionsAction

Source code in docs_src/capo_iot/types/step_functions_action.py
class StepFunctionsAction(TypedDict, closed=True):
    execution_name_prefix: NotRequired[
        "capo_iot.types.execution_name_prefix.ExecutionNamePrefix"
    ]
    """<p>(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.</p>"""
    state_machine_name: "capo_iot.types.state_machine_name.StateMachineName"
    """<p>The name of the Step Functions state machine whose execution will be started.</p>"""
    role_arn: "capo_iot.types.aws_arn.AwsArn"
    """<p>The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").</p>"""

execution_name_prefix instance-attribute

execution_name_prefix: NotRequired[ExecutionNamePrefix]

(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

role_arn instance-attribute

role_arn: AwsArn

The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

state_machine_name instance-attribute

state_machine_name: StateMachineName

The name of the Step Functions state machine whose execution will be started.