tags

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

Overview

Name	tags
Type	Resource
Id	aws.backupsearch.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	List of tags returned by the operation.

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		This operation returns the tags for a resource type.
untag_resource	update	resource_arn, tagKeys, region		This operation removes tags from the specified resource.
tag_resource	update	resource_arn, region		This operation puts tags on the resource you indicate.

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 Amazon Resource Name (ARN) that uniquely identifies the resource. This is the resource that will have the indicated tags.
tagKeys	array	This required parameter contains the tag keys you want to remove from the source.

SELECT examples

list_tags_for_resource

This operation returns the tags for a resource type.

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

UPDATE examples

untag_resource

This operation removes tags from the specified resource.

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

tag_resource

This operation puts tags on the resource you indicate.

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