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

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

Overview

Constant Summary collapse

SENSITIVE =
[:input]

Instance Attribute Summary collapse

Instance Attribute Details

#included_dataString

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)


3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3564

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

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

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

Returns:

  • (String)


3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3564

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

#nameString

The name of the execution.

Returns:

  • (String)


3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3564

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

#state_machine_arnString

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

Returns:

  • (String)


3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3564

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

#trace_headerString

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

Returns:

  • (String)


3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3564

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