tags

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

Overview

Name	tags
Type	Resource
Id	aws.workspaces_web.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	array	The tags of 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		Retrieves a list of tags for a resource.
tag_resource	update	resource_arn, region, tags		Adds or overwrites one or more tags for the specified resource.
untag_resource	update	resource_arn, tagKeys, region		Removes one or more tags from the specified resource.

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
region	string	AWS region (default: us-east-1)
resource_arn	string	The ARN of the resource.
tagKeys	array	The list of tag keys to remove from the resource.

SELECT examples

list_tags_for_resource

Retrieves a list of tags for a resource.

SELECT
tags
FROM aws.workspaces_web.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

tag_resource

Adds or overwrites one or more tags for the specified resource.

UPDATE aws.workspaces_web.tags
SET 
tags = '{{ tags }}',
clientToken = '{{ clientToken }}'
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;

untag_resource

Removes one or more tags from the specified resource.

UPDATE aws.workspaces_web.tags
SET 
-- No updatable properties
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;