TestStateRequest Class | AWS SDK for .NET V3

Container for the parameters to the TestState operation. Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

A state's input and output processing data flow
An Amazon Web Services service integration request and response
An HTTP Task request and response

You can call this API on only one state at a time. The states that you can test include the following:

The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.

The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error.

TestState doesn't support Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StepFunctions.AmazonStepFunctionsRequest
      Amazon.StepFunctions.Model.TestStateRequest

Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z

Syntax

public class TestStateRequest : AmazonStepFunctionsRequest
         IAmazonWebServiceRequest

The TestStateRequest type exposes the following members

Constructors

	Name	Description
	TestStateRequest()

Properties

Name	Type	Description
Definition	System.String	Gets and sets the property Definition. The Amazon States Language (ASL) definition of the state.
Input	System.String	Gets and sets the property Input. A string that contains the JSON input data for the state.
InspectionLevel	Amazon.StepFunctions.InspectionLevel	Gets and sets the property InspectionLevel. 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.
RevealSecrets	System.Boolean	Gets and sets the property RevealSecrets. 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`.
RoleArn	System.String	Gets and sets the property RoleArn. The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
Variables	System.String	Gets and sets the property Variables. JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5