AWS Step Functions

Describe execution

Provide information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata.

Inputs

Field

Type

Description

region [required]

enum

default: us-east-1

executionArn [required]

string

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

Outputs

Expand All

Field

Type

Description

execution [required]

object

executionArn [required]

string

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

stateMachineArn [required]

string

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

name

string

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

status [required]

string

The current status of the execution.

startDate [required]

date-time

The date the execution is started.

stopDate

date-time

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

input

string

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.

inputDetails

object

included

boolean

Indicates whether input or output was included in the response. Always true for API calls.

output

string

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

outputDetails

object

included

boolean

Indicates whether input or output was included in the response. Always true for API calls.

traceHeader

string

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