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

DescribeStateMachineForExecution

Describes the state machine associated with a specific execution.

Note

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

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 you want state machine information for.

Type: String

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

Required: Yes

Response Syntax

{ "definition": "string", "name": "string", "roleArn": "string", "stateMachineArn": "string", "updateDate": 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.

definition

The Amazon States Language definition of the state machine. See Amazon States Language.

Type: String

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

name

The name of the state machine associated with the execution.

Type: String

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

roleArn

The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

Type: String

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

stateMachineArn

The Amazon Resource Name (ARN) of the state machine associated with the execution.

Type: String

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

updateDate

The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

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: