tags

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

Overview

Name	tags
Type	Resource
Id	aws.iotdeviceadvisor.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	The tags attached to the IoT Device Advisor 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 attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action.
tag_resource	update	resource_arn, region, tags		Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action.
untag_resource	update	resource_arn, tagKeys, region		Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.

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 resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.
tagKeys	array	List of tag keys to remove from the IoT Device Advisor resource.

SELECT examples

list_tags_for_resource

Lists the tags attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action.

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

UPDATE examples

tag_resource

Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action.

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

untag_resource

Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.

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