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 execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the StartExecution API
action, DescribeExecution
returns that ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an EXPRESS
state machine aren't supported by DescribeExecution
unless a Map Run dispatched them.
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeExecutionAsync.
Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public abstract DescribeExecutionResponse DescribeExecution( DescribeExecutionRequest request )
Container for the necessary parameters to execute the DescribeExecution service method.
Exception | Condition |
---|---|
ExecutionDoesNotExistException | The specified execution does not exist. |
InvalidArnException | The provided Amazon Resource Name (ARN) is not valid. |
KmsAccessDeniedException | Either your KMS key policy or API caller does not have the required permissions. |
KmsInvalidStateException | The KMS key is not in valid state, for example: Disabled or Deleted. |
KmsThrottlingException | Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller. |
.NET Framework:
Supported in: 4.5 and newer, 3.5