Retrieves properties for an alias. This operation returns all alias metadata and
settings. To get an alias's target fleet ID only, use ResolveAlias.
To get alias properties, specify the alias ID. If successful, the requested alias record is returned.
Related actions
Request Syntax
{
"AliasId": "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.
- AliasId
-
The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.
Type: String
Pattern:
^alias-\S+|^arn:.*:alias\/alias-\S+Required: Yes
Response Syntax
{
"Alias": {
"AliasArn": "string",
"AliasId": "string",
"CreationTime": number,
"Description": "string",
"LastUpdatedTime": number,
"Name": "string",
"RoutingStrategy": {
"FleetId": "string",
"Message": "string",
"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.
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
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
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:
