Skip to main content

template_aliases

Creates, updates, deletes, gets or lists a template_aliases resource.

Overview

Nametemplate_aliases
TypeResource
Idaws.quicksight.template_aliases

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
alias_namestringThe display name of the template alias. (pattern: <code>[\w-]+|($LATEST)|($PUBLISHED)</code>)
arnstringThe Amazon Resource Name (ARN) of the template alias.
template_version_numberinteger (int64)The version number of the template alias.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_template_aliasesselectaws_account_id, template_id, regionnext-token, max-resultLists 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.

NameDatatypeDescription
aws_account_idstringThe ID of the Amazon Web Services account that contains the template aliases that you're listing.
regionstringAWS region (default: us-east-1)
template_idstringThe ID for the template.
max-resultintegerThe maximum number of results to be returned per request.
next-tokenstringThe token for the next set of results, or null if there are no more results.

SELECT examples

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 }}'
;