You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::StepFunctionsAction

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StepFunctionsAction as input to an Aws::Client method, you can use a vanilla Hash:

{
  execution_name_prefix: "ExecutionNamePrefix",
  state_machine_name: "StateMachineName", # required
  role_arn: "AwsArn", # required
}

Starts execution of a Step Functions state machine.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#execution_name_prefix ⇒ String

(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.

Returns:

  • (String) —

    (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.

#role_arn ⇒ String

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

Returns:

  • (String) —

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

#state_machine_name ⇒ String

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

Returns:

  • (String) —

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