DescribeStateMachine
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.
Request Syntax
{
"stateMachineArn": "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.
- stateMachineArn
-
The Amazon Resource Name (ARN) of the state machine to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Syntax
{
"creationDate": number,
"definition": "string",
"label": "string",
"loggingConfiguration": {
"destinations": [
{
"cloudWatchLogsLogGroup": {
"logGroupArn": "string"
}
}
],
"includeExecutionData": boolean,
"level": "string"
},
"name": "string",
"roleArn": "string",
"stateMachineArn": "string",
"status": "string",
"tracingConfiguration": {
"enabled": boolean
},
"type": "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.
- creationDate
-
The date the state machine is created.
Type: Timestamp
- 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.
- label
-
A user-defined or an auto-generated string that identifies a
Map
state. This parameter is present only if thestateMachineArn
specified in input is a qualified state machine ARN.Type: String
- loggingConfiguration
-
Type: LoggingConfiguration object
- name
-
The name of the state machine.
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 _.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
-
- roleArn
-
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 AWS resources.)
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- stateMachineArn
-
The Amazon Resource Name (ARN) that identifies the state machine.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- status
-
The current status of the state machine.
Type: String
Valid Values:
ACTIVE | DELETING
- tracingConfiguration
-
Selects whether AWS X-Ray tracing is enabled.
Type: TracingConfiguration object
- type
-
The
type
of the state machine (STANDARD
orEXPRESS
).Type: String
Valid Values:
STANDARD | EXPRESS
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArn
-
The provided Amazon Resource Name (ARN) is not valid.
HTTP Status Code: 400
- StateMachineDoesNotExist
-
The specified state machine does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: