Class: Aws::States::Types::TestStateInput

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::TestStateInput

Defined in:

gems/aws-sdk-states/lib/aws-sdk-states/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:definition, :input, :variables, :state_name, :context]

Instance Attribute Summary

• #context ⇒ String

  A JSON string representing a valid Context object for the state under test.

• #definition ⇒ String

  The [Amazon States Language][1] (ASL) definition of the state or state machine.

• #input ⇒ String

  A string that contains the JSON input data for the state.

• #inspection_level ⇒ String

  Determines the values to return when a state is tested.

• #mock ⇒ Types::MockInput

  Defines a mocked result or error for the state under test.

• #reveal_secrets ⇒ Boolean

  Specifies whether or not to include secret information in the test result.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

• #state_configuration ⇒ Types::TestStateConfiguration

  Contains configurations for the state under test.

• #state_name ⇒ String

  Denotes the particular state within a state machine definition to be tested.

• #variables ⇒ String

  JSON object literal that sets variables used in the state under test.

Instance Attribute Details

#context ⇒ String

A JSON string representing a valid Context object for the state under test. This field may only be specified if a mock is specified in the same request.

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#definition ⇒ String

The Amazon States Language (ASL) definition of the state or state machine.

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#input ⇒ String

A string that contains the JSON input data for the state.

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#inspection_level ⇒ String

Determines the values to return when a state is tested. You can specify one of the following types:

• INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.

• DEBUG: Shows the final state output along with the input and output data processing result.

• TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

Each of these levels also provide information about the status of the state execution and the next state to transition to.

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#mock ⇒ Types::MockInput

Defines a mocked result or error for the state under test.

A mock can only be specified for Task, Map, or Parallel states. If it is specified for another state type, an exception will be thrown.

Returns:

• (Types::MockInput)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#reveal_secrets ⇒ Boolean

Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.

If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.

By default, revealSecrets is set to false.

Returns:

• (Boolean)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#state_configuration ⇒ Types::TestStateConfiguration

Contains configurations for the state under test.

Returns:

• (Types::TestStateConfiguration)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#state_name ⇒ String

Denotes the particular state within a state machine definition to be tested. If this field is specified, the definition must contain a fully-formed state machine definition.

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end

#variables ⇒ String

JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables,
  :state_name,
  :mock,
  :context,
  :state_configuration)
  SENSITIVE = [:definition, :input, :variables, :state_name, :context]
  include Aws::Structure
end