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

Inherits:

Struct

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

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-states/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:definition, :input, :variables]

Instance Attribute Summary

• #definition ⇒ String

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

• #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.

• #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.

• #variables ⇒ String

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

Instance Attribute Details

#definition ⇒ String

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

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html

Returns:

• (String)

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

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

#input ⇒ String

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

Returns:

• (String)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables)
  SENSITIVE = [:definition, :input, :variables]
  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 'lib/aws-sdk-states/types.rb', line 4428

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables)
  SENSITIVE = [:definition, :input, :variables]
  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`.

[1]: docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions

Returns:

• (Boolean)

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

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables)
  SENSITIVE = [:definition, :input, :variables]
  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 'lib/aws-sdk-states/types.rb', line 4428

class TestStateInput < Struct.new(
  :definition,
  :role_arn,
  :input,
  :inspection_level,
  :reveal_secrets,
  :variables)
  SENSITIVE = [:definition, :input, :variables]
  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 'lib/aws-sdk-states/types.rb', line 4428

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