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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#execution_name_prefixString

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


16359
16360
16361
16362
16363
16364
16365
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16359

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

#role_arnString

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

Returns:

  • (String)


16359
16360
16361
16362
16363
16364
16365
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16359

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

#state_machine_nameString

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

Returns:

  • (String)


16359
16360
16361
16362
16363
16364
16365
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16359

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