Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426173136.4 KB

Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a 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 machine executions unless they were dispatched by a Map Run.

post/#X-Amz-Target=AWSStepFunctions.DescribeExecution

Headers

X-Amz-Target'AWSStepFunctions.DescribeExecution' required

Request body

executionArnstring required

The Amazon Resource Name (ARN) of the execution to describe.

Response

Success

executionArnstring required

The Amazon Resource Name (ARN) that identifies the execution.

stateMachineArnstring required

The Amazon Resource Name (ARN) of the executed stated machine.

namestring
<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
status'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'TIMED_OUT' | 'ABORTED' required

The current status of the execution.

startDatestring date-time required

The date the execution is started.

stopDatestring date-time

If the execution has already ended, the date the execution stopped.

inputstring password

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

outputstring password
<p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p> <note> <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p> </note>
traceHeaderstring

The X-Ray trace header that was passed to the execution.

mapRunArnstring

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

errorstring password

The error string if the state machine execution failed.

causestring password

The cause string if the state machine execution failed.