@aws-sdk/client-sfn

TestStateCommandInput Interface

The input for TestStateCommand.

Members

Name
Type
Details
definition Requiredstring | undefined

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

input string | undefined

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

inspectionLevel InspectionLevel | undefined

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 boolean | undefined

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 string | undefined

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

variables string | undefined

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

Full Signature

export interface TestStateCommandInput extends TestStateInput