tags

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

Overview

Name	tags
Type	Resource
Id	aws.s3files.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
key	string	The tag key. The key can't start with aws:. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-@]+)</code>)
value	string	The tag value. (pattern: <code>([\p{L}\p{Z}\p{N}_.:/=+-@]*)</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	resource_id, region	MaxResults, NextToken	Lists all tags for S3 Files resources.
tag_resource	update	resource_id, region, tags		Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.
untag_resource	update	resource_id, tagKeys, region		Removes tags from S3 Files resources.

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_id	string	The ID or Amazon Resource Name (ARN) of the resource to remove tags from.
tagKeys	array	An array of tag keys to remove from the resource.
MaxResults	integer	The maximum number of tags to return in a single response.
NextToken	string	A pagination token returned from a previous call to continue listing tags.

SELECT examples

list_tags_for_resource

Lists all tags for S3 Files resources.

SELECT
key,
value
FROM aws.s3files.tags
WHERE resource_id = '{{ resource_id }}' -- required
AND region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

UPDATE examples

tag_resource

Creates tags for S3 Files resources using standard Amazon Web Services tagging APIs.

UPDATE aws.s3files.tags
SET 
tags = '{{ tags }}'
WHERE 
resource_id = '{{ resource_id }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;

untag_resource

Removes tags from S3 Files resources.

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