template_aliases
Creates, updates, deletes, gets or lists a template_aliases resource.
Overview
| Name | template_aliases |
| Type | Resource |
| Id | aws.quicksight.template_aliases |
Fields
The following fields are returned by SELECT queries:
- list_template_aliases
| Name | Datatype | Description |
|---|---|---|
alias_name | string | The display name of the template alias. (pattern: <code>[\w-]+|($LATEST)|($PUBLISHED)</code>) |
arn | string | The Amazon Resource Name (ARN) of the template alias. |
template_version_number | integer (int64) | The version number of the template alias. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_template_aliases | select | aws_account_id, template_id, region | next-token, max-result | Lists all the aliases of a template. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
aws_account_id | string | The ID of the Amazon Web Services account that contains the template aliases that you're listing. |
region | string | AWS region (default: us-east-1) |
template_id | string | The ID for the template. |
max-result | integer | The maximum number of results to be returned per request. |
next-token | string | The token for the next set of results, or null if there are no more results. |
SELECT examples
- list_template_aliases
Lists all the aliases of a template.
SELECT
alias_name,
arn,
template_version_number
FROM aws.quicksight.template_aliases
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND template_id = '{{ template_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-result` = '{{ max-result }}'
;