Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426173136.4 KB

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

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

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

Headers

X-Amz-Target'AWSStepFunctions.DescribeStateMachine' required

Request body

stateMachineArnstring required

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

Response

Success

stateMachineArnstring required

The Amazon Resource Name (ARN) that identifies the state machine.

namestring required
<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>" # % \ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>
status'ACTIVE' | 'DELETING'

The current status of the state machine.

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 used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

type'STANDARD' | 'EXPRESS' required

The <code>type</code> of the state machine (<code>STANDARD</code> or <code>EXPRESS</code>).

creationDatestring date-time required

The date the state machine is created.

labelstring

A user-defined or an auto-generated string that identifies a <code>Map</code> state. This parameter is present only if the <code>stateMachineArn</code> specified in input is a qualified state machine ARN.