Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListStateMachineAliases

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "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.

maxResults

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

nextToken

Type: String

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

Required: No

stateMachineArn

The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.

If you specify a state machine version ARN, this API returns a list of aliases for that version.

Type: String

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

Required: Yes

Response Syntax


{
   "nextToken": "string",
   "stateMachineAliases": [ 
      { 
         "creationDate": number,
         "stateMachineAliasArn": "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.

nextToken

Type: String

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

stateMachineAliases

Aliases for the state machine.

Type: Array of StateMachineAliasListItem objects

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

InvalidToken

The provided token is not valid.

HTTP Status Code: 400

ResourceNotFound

Could not find the referenced resource.

HTTP Status Code: 400

StateMachineDeleting

The specified state machine is being deleted.

HTTP Status Code: 400

StateMachineDoesNotExist

The specified state machine does not exist.

HTTP Status Code: 400