tags

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

Overview

Name	tags
Type	Resource
Id	aws.iottwinmaker.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
next_token	string	The string that specifies the next page of results. (pattern: <code>.*</code>)
tags	object	Metadata that you can use to manage a resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		Lists all tags associated with a resource.
tag_resource	update	region, resourceARN, tags		Adds tags to a resource.
untag_resource	update	resourceARN, tagKeys, region		Removes tags from a 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)
resourceARN	string	The ARN of the resource.
tagKeys	array	A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.

SELECT examples

list_tags_for_resource

Lists all tags associated with a resource.

SELECT
next_token,
tags
FROM aws.iottwinmaker.tags
WHERE region = '{{ region }}' -- required
;

UPDATE examples

tag_resource

Adds tags to a resource.

UPDATE aws.iottwinmaker.tags
SET 
resourceARN = '{{ resourceARN }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND resourceARN = '{{ resourceARN }}' --required
AND tags = '{{ tags }}' --required;

untag_resource

Removes tags from a resource.

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