AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginTestState and EndTestState.
Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public abstract Task<TestStateResponse> TestStateAsync( TestStateRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the TestState service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InvalidArnException | The provided Amazon Resource Name (ARN) is not valid. |
| InvalidDefinitionException | The provided Amazon States Language definition is not valid. |
| InvalidExecutionInputException | The provided JSON input data is not valid. |
| ValidationException | The input does not satisfy the constraints specified by an Amazon Web Services service. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer