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

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::StartExecutionInput

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: "SensitiveData",
  trace_header: "TraceHeader",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:input]

Instance Attribute Summary

• #input ⇒ String

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

• #name ⇒ String

  The name of the execution.

• #state_machine_arn ⇒ String

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

• #trace_header ⇒ String

  Passes the AWS X-Ray trace header.

Instance Attribute Details

#input ⇒ String

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": "\{\}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 2172

class StartExecutionInput < Struct.new(
  :state_machine_arn,
  :name,
  :input,
  :trace_header)
  SENSITIVE = [:input]
  include Aws::Structure
end

#name ⇒ String

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

A name must not contain:

• white space

• brackets < > \{ \} [ ]

• wildcard characters ? *

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

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

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 2172

class StartExecutionInput < Struct.new(
  :state_machine_arn,
  :name,
  :input,
  :trace_header)
  SENSITIVE = [:input]
  include Aws::Structure
end

#state_machine_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 2172

class StartExecutionInput < Struct.new(
  :state_machine_arn,
  :name,
  :input,
  :trace_header)
  SENSITIVE = [:input]
  include Aws::Structure
end

#trace_header ⇒ String

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Returns:

• (String)

# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 2172

class StartExecutionInput < Struct.new(
  :state_machine_arn,
  :name,
  :input,
  :trace_header)
  SENSITIVE = [:input]
  include Aws::Structure
end