tags

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

Overview

Name	tags
Type	Resource
Id	aws.apigatewayv2.tags

Fields

The following fields are returned by SELECT queries:

get_tags

Name	Datatype	Description
tags	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tags	select	resource-arn, region		Gets a collection of Tag resources.
untag_resource	update	resource-arn, tagKeys, region		Deletes a Tag.
tag_resource	update	resource-arn, region		Creates a new Tag resource to represent a tag.

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 for the tag.
tagKeys	array	The Tag keys to delete

SELECT examples

get_tags

Gets a collection of Tag resources.

SELECT
tags
FROM aws.apigatewayv2.tags
WHERE `resource-arn` = '{{ resource-arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Deletes a Tag.

UPDATE aws.apigatewayv2.tags
SET 
-- No updatable properties
WHERE 
`resource-arn` = '{{ resource-arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;

tag_resource

Creates a new Tag resource to represent a tag.

UPDATE aws.apigatewayv2.tags
SET 
Tags = '{{ Tags }}'
WHERE 
`resource-arn` = '{{ resource-arn }}' --required
AND region = '{{ region }}' --required;