tags

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

Overview

Name	tags
Type	Resource
Id	aws.quicksight.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
tags	array	Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	resource_arn, region		Lists the tags assigned to a resource.
untag_resource	update	resource_arn, keys, region		Removes a tag or tags from a resource.
tag_resource	update	resource_arn, region		Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user. Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following: Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.

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
keys	array	The keys of the key-value pairs for the resource tag or tags assigned to the resource.
region	string	AWS region (default: us-east-1)
resource_arn	string	The Amazon Resource Name (ARN) of the resource that you want to tag.

SELECT examples

list_tags_for_resource

Lists the tags assigned to a resource.

SELECT
request_id,
status,
tags
FROM aws.quicksight.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Removes a tag or tags from a resource.

UPDATE aws.quicksight.tags
SET 
-- No updatable properties
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND keys = '{{ keys }}' --required
AND region = '{{ region }}' --required
RETURNING
request_id,
status;

tag_resource

Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user. Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following: Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.

UPDATE aws.quicksight.tags
SET 
Tags = '{{ Tags }}'
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
request_id,
status;