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.
Idawscc.quicksight.templates

Fields

NameDatatypeDescription
created_timestring<p>Time when this was created.</p>
version_descriptionstring
source_entityobject<p>The source entity of the template.</p>
definitionobject
last_updated_timestring<p>Time when this was last updated.</p>
validation_strategyobject<p>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 &#95;&#95;CODE&#95;BLOCK&#95;0&#95;&#95;, validation is skipped for specific errors.</p>
namestring
versionobject<p>A version of a template.</p>
aws_account_idstring
permissionsarray
arnstring<p>The Amazon Resource Name (ARN) of the template.</p>
tagsarray
template_idstring
regionstringAWS region.

For more information, see AWS::QuickSight::Template.

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 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 awscc.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 awscc.quicksight.templates (
AwsAccountId,
TemplateId,
region
)
SELECT
'{{ AwsAccountId }}',
'{{ TemplateId }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM awscc.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