template_alias

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

Overview

Name	template_alias
Type	Resource
Id	aws.quicksight.template_alias

Fields

The following fields are returned by SELECT queries:

describe_template_alias

Name	Datatype	Description
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
template_alias	object	Information about the template alias.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_template_alias	select	aws_account_id, template_id, alias_name, region		Describes the template alias for a template.
create_template_alias	insert	aws_account_id, template_id, alias_name, region, TemplateVersionNumber		Creates a template alias for a template.
update_template_alias	update	aws_account_id, template_id, alias_name, region, TemplateVersionNumber		Updates the template alias of a template.
delete_template_alias	delete	aws_account_id, template_id, alias_name, region		Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

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
alias_name	string	The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.
aws_account_id	string	The ID of the Amazon Web Services account that contains the item to delete.
region	string	AWS region (default: us-east-1)
template_id	string	The ID for the template that the specified alias is for.

SELECT examples

describe_template_alias

Describes the template alias for a template.

SELECT
request_id,
status,
template_alias
FROM aws.quicksight.template_alias
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND template_id = '{{ template_id }}' -- required
AND alias_name = '{{ alias_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_template_alias

Creates a template alias for a template.

INSERT INTO aws.quicksight.template_alias (
TemplateVersionNumber,
aws_account_id,
template_id,
alias_name,
region
)
SELECT 
{{ TemplateVersionNumber }} /* required */,
'{{ aws_account_id }}',
'{{ template_id }}',
'{{ alias_name }}',
'{{ region }}'
RETURNING
request_id,
status,
template_alias
;

Manifest

# Description fields are for documentation purposes
- name: template_alias
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the template_alias resource.
  - name: template_id
    value: "{{ template_id }}"
    description: Required parameter for the template_alias resource.
  - name: alias_name
    value: "{{ alias_name }}"
    description: Required parameter for the template_alias resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the template_alias resource.
  - name: TemplateVersionNumber
    value: {{ TemplateVersionNumber }}

UPDATE examples

update_template_alias

Updates the template alias of a template.

UPDATE aws.quicksight.template_alias
SET 
TemplateVersionNumber = {{ TemplateVersionNumber }}
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND template_id = '{{ template_id }}' --required
AND alias_name = '{{ alias_name }}' --required
AND region = '{{ region }}' --required
AND TemplateVersionNumber = '{{ TemplateVersionNumber }}' --required
RETURNING
request_id,
status,
template_alias;

DELETE examples

delete_template_alias

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

DELETE FROM aws.quicksight.template_alias
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND template_id = '{{ template_id }}' --required
AND alias_name = '{{ alias_name }}' --required
AND region = '{{ region }}' --required
;