ListAliases
Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.
Note
Returned aliases are not listed in any particular order.
Related actions
Request Syntax
{
"Limit": number,
"Name": "string",
"NextToken": "string",
"RoutingStrategyType": "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.
Note
In the following list, the required parameters are described first.
- Limit
-
The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- Name
-
A descriptive label that is associated with an alias. Alias names do not need to be unique.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- NextToken
-
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- RoutingStrategyType
-
The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.
Possible routing types include the following:
-
SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.
-
TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
Type: String
Valid Values:
SIMPLE | TERMINALRequired: No
-
Response Syntax
{
"Aliases": [
{
"AliasArn": "string",
"AliasId": "string",
"CreationTime": number,
"Description": "string",
"LastUpdatedTime": number,
"Name": "string",
"RoutingStrategy": {
"FleetId": "string",
"Message": "string",
"Type": "string"
}
}
],
"NextToken": "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.
- Aliases
-
A collection of alias resources that match the request parameters.
Type: Array of Alias objects
- NextToken
-
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
Type: String
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
