Skip to main content

templates

Creates, updates, deletes or gets a template resource or lists templates in a region

Overview

Nametemplates
TypeResource
DescriptionDefinition of the AWS::QuickSight::Template Resource Type.
Idaws.quicksight.templates

Fields

NameDatatypeDescription
created_timestring

Time when this was created.

version_descriptionstring
source_entityobject

The source entity of the template.

definitionobject
last_updated_timestring

Time when this was last updated.

validation_strategyobject

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

namestring
versionobject

A version of a template.

aws_account_idstring
permissionsarray
arnstring

The Amazon Resource Name (ARN) of the template.

tagsarray
template_idstring
regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTAwsAccountId, TemplateId, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all templates in a region.

SELECT
region,
created_time,
version_description,
source_entity,
definition,
last_updated_time,
validation_strategy,
name,
version,
aws_account_id,
permissions,
arn,
tags,
template_id
FROM aws.quicksight.templates
WHERE region = 'us-east-1';

Gets all properties from an individual template.

SELECT
region,
created_time,
version_description,
source_entity,
definition,
last_updated_time,
validation_strategy,
name,
version,
aws_account_id,
permissions,
arn,
tags,
template_id
FROM aws.quicksight.templates
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<TemplateId>';

INSERT example

Use the following StackQL query and manifest file to create a new template resource, using stack-deploy.

/*+ create */
INSERT INTO aws.quicksight.templates (
AwsAccountId,
TemplateId,
region
)
SELECT
'{{ AwsAccountId }}',
'{{ TemplateId }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.templates
WHERE data__Identifier = '<AwsAccountId|TemplateId>'
AND region = 'us-east-1';

Permissions

To operate on the templates resource, the following permissions are required:

Read

quicksight:DescribeTemplate,
quicksight:DescribeTemplatePermissions,
quicksight:ListTagsForResource

Create

quicksight:DescribeTemplate,
quicksight:DescribeTemplatePermissions,
quicksight:CreateTemplate,
quicksight:DescribeAnalysis,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

Update

quicksight:DescribeTemplate,
quicksight:DescribeTemplatePermissions,
quicksight:UpdateTemplate,
quicksight:UpdateTemplatePermissions,
quicksight:PassDataSet,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

List

quicksight:ListTemplates

Delete

quicksight:DescribeTemplate,
quicksight:DeleteTemplate