Menu
AWS Step Functions
API Reference (API Version 2016-11-23)

DescribeExecution

Describes an execution.

Request Syntax

Copy
{ "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

Copy
{ "executionArn": "string", "input": "string", "name": "string", "output": "string", "startDate": number, "stateMachineArn": "string", "status": "string", "stopDate": number }

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.

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.

Type: String

Length Constraints: Maximum length of 32768.

name

The name of the execution.

A name must not contain:

  • whitespace

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

Type: String

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

output

The JSON output data of the execution.

Type: String

Length Constraints: Maximum length of 32768.

startDate

The date the execution was started.

Type: Timestamp

stateMachineArn

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

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 has already ended, the date the execution stopped.

Type: Timestamp

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: