Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeStateMachineForExecution

Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

Note

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

This API action is not supported by EXPRESS state machines.

Request Syntax


{
   "executionArn": "string",
   "includedData": "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

includedData

If your state machine definition is encrypted with a AWS KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

Type: String

Valid Values: ALL_DATA | METADATA_ONLY

Required: No

Response Syntax


{
   "definition": "string",
   "encryptionConfiguration": { 
      "kmsDataKeyReusePeriodSeconds": number,
      "kmsKeyId": "string",
      "type": "string"
   },
   "label": "string",
   "loggingConfiguration": { 
      "destinations": [ 
         { 
            "cloudWatchLogsLogGroup": { 
               "logGroupArn": "string"
            }
         }
      ],
      "includeExecutionData": boolean,
      "level": "string"
   },
   "mapRunArn": "string",
   "name": "string",
   "revisionId": "string",
   "roleArn": "string",
   "stateMachineArn": "string",
   "tracingConfiguration": { 
      "enabled": boolean
   },
   "updateDate": number,
   "variableReferences": { 
      "string" : [ "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.

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.

encryptionConfiguration

Settings to configure server-side encryption.

Type: EncryptionConfiguration object

label

A user-defined or an auto-generated string that identifies a Map state. This ﬁeld is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Type: String

loggingConfiguration

The LoggingConfiguration data type is used to set CloudWatch Logs options.

Type: LoggingConfiguration object

mapRunArn

The Amazon Resource Name (ARN) of the Map Run that started the child workflow execution. This field is returned only if the executionArn is a child workflow execution that was started by a Distributed Map state.

Type: String

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

name

The name of the state machine associated with the execution.

Type: String

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

revisionId

The revision identifier for the state machine. The first revision ID when you create the state machine is null.

Use the state machine revisionId parameter to compare the revision of a state machine with the configuration of the state machine used for executions without performing a diff of the properties, such as definition and roleArn.

Type: String

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.

tracingConfiguration

Selects whether AWS X-Ray tracing is enabled.

Type: TracingConfiguration object

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

variableReferences

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.

Type: String to array of strings map

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

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

KmsAccessDeniedException

Either your AWS KMS key policy or API caller does not have the required permissions.

HTTP Status Code: 400

KmsInvalidStateException

The AWS KMS key is not in valid state, for example: Disabled or Deleted.

HTTP Status Code: 400

KmsThrottlingException

Received when AWS KMS returns ThrottlingException for a AWS KMS call that Step Functions makes on behalf of the caller.

HTTP Status Code: 400