Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1737274251.5 KB

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.

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.

post/#X-Amz-Target=AWSStepFunctions.DescribeStateMachineForExecution

Headers

X-Amz-Target'AWSStepFunctions.DescribeStateMachineForExecution' required

Request body

executionArnstring required

The Amazon Resource Name (ARN) of the execution you want state machine information for.

includedData'ALL_DATA' | 'METADATA_ONLY'

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

Response

Success

stateMachineArnstring required

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

namestring required

The name of the state machine associated with the execution.

definitionstring password required

The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.

roleArnstring required

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

updateDatestring date-time required

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

mapRunArnstring

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

labelstring

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

revisionIdstring
<p>The revision identifier for the state machine. The first revision ID when you create the state machine is null.</p> <p>Use the state machine <code>revisionId</code> 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 <code>definition</code> and <code>roleArn</code>.</p>
variableReferencesobject

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