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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::StepFunctionsAction

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass StepFunctionsAction data as a hash:

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

Starts execution of a Step Functions state machine.

Instance Attribute Summary

• #execution_name_prefix ⇒ 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”).

• #state_machine_name ⇒ String

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

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.

# File 'lib/aws-sdk-iot/types.rb', line 9567

class StepFunctionsAction < Struct.new(
  :execution_name_prefix,
  :state_machine_name,
  :role_arn)
  include Aws::Structure
end

#role_arn ⇒ String

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

# File 'lib/aws-sdk-iot/types.rb', line 9567

class StepFunctionsAction < Struct.new(
  :execution_name_prefix,
  :state_machine_name,
  :role_arn)
  include Aws::Structure
end

#state_machine_name ⇒ String

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

# File 'lib/aws-sdk-iot/types.rb', line 9567

class StepFunctionsAction < Struct.new(
  :execution_name_prefix,
  :state_machine_name,
  :role_arn)
  include Aws::Structure
end