Class: Aws::States::Types::StartSyncExecutionInput

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::StartSyncExecutionInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-states/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:input]

Instance Attribute Summary

• #included_data ⇒ String

  If your state machine definition is encrypted with a KMS key, callers must have ‘kms:Decrypt` permission to decrypt the definition.

• #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 X-Ray trace header.

Instance Attribute Details

#included_data ⇒ String

If your state machine definition is encrypted with a KMS key, callers must have ‘kms:Decrypt` permission to decrypt the definition. Alternatively, you can call the API with `includedData = METADATA_ONLY` to get a successful response without the encrypted definition.

Returns:

• (String)

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

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

#input ⇒ String

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

‘“input”: “: ”test“”`

<note markdown=“1”> If you don’t include any JSON input data, you still must include the two braces, for example: ‘“input”: “{}”`

</note>

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

Returns:

• (String)

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

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

#name ⇒ String

The name of the execution.

Returns:

• (String)

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

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

#state_machine_arn ⇒ String

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

Returns:

• (String)

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

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

#trace_header ⇒ String

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

Returns:

• (String)

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

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