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

Class: Aws::States::Types::StartExecutionInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-states/lib/aws-sdk-states/types.rb

Overview

Note:

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

{
  state_machine_arn: "Arn", # required
  name: "Name",
  input: "Data",
}

Instance Attribute Summary collapse

Instance Attribute Details

#inputString

The string that contains the JSON input data for the execution, for example:

"input": "\{"first_name" : "test"\}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "\{\}"

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1420

class StartExecutionInput < Struct.new(
  :state_machine_arn,
  :name,
  :input)
  include Aws::Structure
end

#nameString

The name of the execution. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

An execution can't use the name of another execution for 90 days.

When you make multiple StartExecution calls with the same name, the new execution doesn't run and the following rules apply:

  • When the original execution is open and the execution input from the new call is different, the ExecutionAlreadyExists message is returned.

  • When the original execution is open and the execution input from the new call is identical, the Success message is returned.

  • When the original execution is closed, the ExecutionAlreadyExists message is returned regardless of input.

A name must not contain:

  • whitespace

  • brackets < > \{ \} [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1420

class StartExecutionInput < Struct.new(
  :state_machine_arn,
  :name,
  :input)
  include Aws::Structure
end

#state_machine_arnString

The Amazon Resource Name (ARN) of the state machine to execute.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1420

class StartExecutionInput < Struct.new(
  :state_machine_arn,
  :name,
  :input)
  include Aws::Structure
end