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
Constant Summary collapse
- SENSITIVE =
[:definition, :input]
Instance Attribute Summary collapse
-
#definition ⇒ String
The [Amazon States Language][1] (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.
Instance Attribute Details
#definition ⇒ String
The Amazon States Language (ASL) definition of the state.
4115 4116 4117 4118 4119 4120 4121 4122 4123 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 4115 class TestStateInput < Struct.new( :definition, :role_arn, :input, :inspection_level, :reveal_secrets) SENSITIVE = [:definition, :input] include Aws::Structure end |
#input ⇒ String
A string that contains the JSON input data for the state.
4115 4116 4117 4118 4119 4120 4121 4122 4123 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 4115 class TestStateInput < Struct.new( :definition, :role_arn, :input, :inspection_level, :reveal_secrets) SENSITIVE = [:definition, :input] 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 setsinspectionLevel
toINFO
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.
4115 4116 4117 4118 4119 4120 4121 4122 4123 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 4115 class TestStateInput < Struct.new( :definition, :role_arn, :input, :inspection_level, :reveal_secrets) SENSITIVE = [:definition, :input] 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
.
4115 4116 4117 4118 4119 4120 4121 4122 4123 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 4115 class TestStateInput < Struct.new( :definition, :role_arn, :input, :inspection_level, :reveal_secrets) SENSITIVE = [:definition, :input] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
4115 4116 4117 4118 4119 4120 4121 4122 4123 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 4115 class TestStateInput < Struct.new( :definition, :role_arn, :input, :inspection_level, :reveal_secrets) SENSITIVE = [:definition, :input] include Aws::Structure end |