tags

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

Overview

Name	tags
Type	Resource
Id	aws.greengrassv2.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

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 the list of tags for an IoT Greengrass resource.
tag_resource	update	resource_arn, region, tags		Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.
untag_resource	update	resource_arn, tagKeys, region		Removes a tag from an IoT Greengrass 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 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 Greengrass resource.

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

UPDATE examples

tag_resource

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

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

untag_resource

Removes a tag from an IoT Greengrass resource.

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