tags

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

Overview

Name	tags
Type	Resource
Id	aws.iotsitewise.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	resourceArn, region		Retrieves the list of tags for an IoT SiteWise resource.
tag_resource	update	resourceArn, region, tags		Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
untag_resource	update	resourceArn, tagKeys, region		Removes a tag from an IoT SiteWise 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 to untag.
tagKeys	array	A list of keys for tags to remove from the resource.

SELECT examples

list_tags_for_resource

Retrieves the list of tags for an IoT SiteWise resource.

SELECT
tags
FROM aws.iotsitewise.tags
WHERE resourceArn = '{{ resourceArn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

tag_resource

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

UPDATE aws.iotsitewise.tags
SET 
tags = '{{ tags }}'
WHERE 
resourceArn = '{{ resourceArn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;

untag_resource

Removes a tag from an IoT SiteWise resource.

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