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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:input]

Instance Attribute Summary collapse

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) 


3862
3863
3864
3865
3866
3867
3868
3869
3870
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3862

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:

"{"first_name" : "Alejandro"}"

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

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

Returns:

  • (String) 


3862
3863
3864
3865
3866
3867
3868
3869
3870
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3862

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) 


3862
3863
3864
3865
3866
3867
3868
3869
3870
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3862

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) 


3862
3863
3864
3865
3866
3867
3868
3869
3870
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3862

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.

For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

Returns:

  • (String) 


3862
3863
3864
3865
3866
3867
3868
3869
3870
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 3862

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