Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeExecution

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. 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.

Note

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

Executions of an EXPRESS state machinearen't supported by DescribeExecution unless a Map Run dispatched them.

Request Syntax


{
   "executionArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

executionArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Response Syntax


{
   "cause": "string",
   "error": "string",
   "executionArn": "string",
   "input": "string",
   "inputDetails": { 
      "included": boolean
   },
   "mapRunArn": "string",
   "name": "string",
   "output": "string",
   "outputDetails": { 
      "included": boolean
   },
   "startDate": number,
   "stateMachineAliasArn": "string",
   "stateMachineArn": "string",
   "stateMachineVersionArn": "string",
   "status": "string",
   "stopDate": number,
   "traceHeader": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

cause

The cause string if the state machine execution failed.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32768.

error

The error string if the state machine execution failed.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

executionArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

input

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.

Type: String

Length Constraints: Maximum length of 262144.

inputDetails

Provides details about execution input or output.

Type: CloudWatchEventsExecutionDataDetails object

mapRunArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

name

The name of the execution.

A name must not contain:

white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

output

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

Note

This field is set only if the execution succeeds. If the execution fails, this field is null.

Type: String

Length Constraints: Maximum length of 262144.

outputDetails

Provides details about execution input or output.

Type: CloudWatchEventsExecutionDataDetails object

startDate

The date the execution is started.

Type: Timestamp

stateMachineAliasArn

The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

stateMachineArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

stateMachineVersionArn

The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

status

The current status of the execution.

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED | TIMED_OUT | ABORTED

stopDate

If the execution ended, the date the execution stopped.

Type: Timestamp

traceHeader

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: \p{ASCII}*

Errors

For information about the errors that are common to all actions, see Common Errors.

ExecutionDoesNotExist

The specified execution does not exist.

HTTP Status Code: 400

InvalidArn

The provided Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400