ListTemplateAliases
Lists all the aliases of a template.
Request Syntax
GET /accounts/AwsAccountId
/templates/TemplateId
/aliases?max-result=MaxResults
&next-token=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account that contains the template aliases that you're listing.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$
Required: Yes
- MaxResults
-
The maximum number of results to be returned per request.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The token for the next set of results, or null if there are no more results.
- TemplateId
-
The ID for the template.
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"NextToken": "string",
"RequestId": "string",
"TemplateAliasList": [
{
"AliasName": "string",
"Arn": "string",
"TemplateVersionNumber": number
}
]
}
Response Elements
If the action is successful, the service sends back the following HTTP response.
- Status
-
The HTTP status of the request.
The following data is returned in JSON format by the service.
- NextToken
-
The token for the next set of results, or null if there are no more results.
Type: String
- RequestId
-
The AWS request ID for this operation.
Type: String
- TemplateAliasList
-
A structure containing the list of the template's aliases.
Type: Array of TemplateAlias objects
Array Members: Maximum number of 100 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
An internal failure occurred.
HTTP Status Code: 500
- InvalidNextTokenException
-
The
NextToken
value isn't valid.HTTP Status Code: 400
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
- UnsupportedUserEditionException
-
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
HTTP Status Code: 403
Examples
Example
This example illustrates one usage of ListTemplateAliases.
Sample Request
GET /accounts/AwsAccountId/templates/TemplateId/aliases?max-result=MaxResults&next-token=NextToken HTTP/1.1
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: