template_definitions

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

Overview

Name	template_definitions
Type	Resource
Id	aws.quicksight.template_definitions

Fields

The following fields are returned by SELECT queries:

describe_template_definition

Name	Datatype	Description
definition	object	The detailed definition of a template.
errors	array	Errors associated with the template version.
name	string	The descriptive name of the template.
request_id	string	The Amazon Web Services request ID for this operation.
resource_status	string	Status associated with the template. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED (CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, DELETED)
status	integer	The HTTP status of the request.
template_id	string	The ID of the template described. (pattern: <code>[\w-]+</code>)
theme_arn	string	The ARN of the theme of the template.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_template_definition	select	aws_account_id, template_id, region	version-number, alias-name	Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

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. You must be using the Amazon Web Services account that the template is in.
region	string	AWS region (default: us-east-1)
template_id	string	The ID of the template that you're describing.
alias-name	string	The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
version-number	integer (int64)	The version number of the template.

SELECT examples

describe_template_definition

Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

SELECT
definition,
errors,
name,
request_id,
resource_status,
status,
template_id,
theme_arn
FROM aws.quicksight.template_definitions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND template_id = '{{ template_id }}' -- required
AND region = '{{ region }}' -- required
AND `version-number` = '{{ version-number }}'
AND `alias-name` = '{{ alias-name }}'
;