AWS SDK Version 3 for .NET
API Reference

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.

Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

Note:

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 BeginDescribeStateMachineForExecution and EndDescribeStateMachineForExecution.

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

Syntax

C#
public virtual Task<DescribeStateMachineForExecutionResponse> DescribeStateMachineForExecutionAsync(
         DescribeStateMachineForExecutionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.StepFunctions.Model.DescribeStateMachineForExecutionRequest

Container for the necessary parameters to execute the DescribeStateMachineForExecution service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeStateMachineForExecution service method, as returned by StepFunctions.

Exceptions

ExceptionCondition
ExecutionDoesNotExistException The specified execution does not exist.
InvalidArnException The provided Amazon Resource Name (ARN) is not valid.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also