AWS Step Functions

Describe execution

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

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

Champ

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

Champ

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 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 X-Ray trace header that was passed to the execution.

mapRunArn

string

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

error

string

The error string if the state machine execution failed.

cause

string

The cause string if the state machine execution failed.

stateMachineVersionArn

string

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.

stateMachineAliasArn

string

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.

redriveCount

number

The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.

redriveDate

date-time

The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null. The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

redriveStatus

string

Indicates whether or not an execution can be redriven at a given point in time. For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error. For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions. For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions. You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

redriveStatusReason

string

When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven. For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons: State machine is in DELETING status. Execution is RUNNING and cannot be redriven. Execution is SUCCEEDED and cannot be redriven. Execution was started before the launch of RedriveExecution. Execution history event limit exceeded. Execution has exceeded the max execution time. Execution redrivable period exceeded. For a Distributed Map that includes child workflows of type EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

amzRequestId [required]

string