template_permissions

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

Overview

Name	template_permissions
Type	Resource
Id	aws.quicksight.template_permissions

Fields

The following fields are returned by SELECT queries:

describe_template_permissions

Name	Datatype	Description
permissions	array	A list of resource permissions to be set on the template.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
template_arn	string	The Amazon Resource Name (ARN) of the template.
template_id	string	The ID for the template. (pattern: <code>[\w-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_template_permissions	select	aws_account_id, template_id, region		Describes read and write permissions on a template.
update_template_permissions	update	aws_account_id, template_id, region		Updates the resource permissions for 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.

Name	Datatype	Description
aws_account_id	string	The ID of the Amazon Web Services account that contains the template.
region	string	AWS region (default: us-east-1)
template_id	string	The ID for the template.

SELECT examples

describe_template_permissions

Describes read and write permissions on a template.

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

UPDATE examples

update_template_permissions

Updates the resource permissions for a template.

UPDATE aws.quicksight.template_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND template_id = '{{ template_id }}' --required
AND region = '{{ region }}' --required
RETURNING
permissions,
request_id,
status,
template_arn,
template_id;