DescribeStateMachineAlias
Returns details about a state machine alias.
Related operations:
Request Syntax
{
"stateMachineAliasArn": "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.
- stateMachineAliasArn
-
The Amazon Resource Name (ARN) of the state machine alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Syntax
{
"creationDate": number,
"description": "string",
"name": "string",
"routingConfiguration": [
{
"stateMachineVersionArn": "string",
"weight": number
}
],
"stateMachineAliasArn": "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.
- creationDate
-
The date the state machine alias was created.
Type: Timestamp
- description
-
A description of the alias.
Type: String
Length Constraints: Maximum length of 256.
- name
-
The name of the state machine alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 80.
- routingConfiguration
-
The routing configuration of the alias.
Type: Array of RoutingConfigurationListItem objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
- stateMachineAliasArn
-
The Amazon Resource Name (ARN) of the state machine alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- updateDate
-
The date the state machine alias was last updated.
For a newly created state machine, this is the same as the creation date.
Type: Timestamp
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
- ResourceNotFound
-
Could not find the referenced resource.
HTTP Status Code: 400
- ValidationException
-
The input does not satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: