tags

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

Overview

Name	tags
Type	Resource
Id	aws.transfer.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
key	string	The name assigned to the tag that you create.
value	string	Contains one or more values that you assigned to the key name you create.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.
tag_resource	update	region, Arn, Tags		Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call.
untag_resource	update	region, Arn, TagKeys		Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call.

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)

SELECT examples

list_tags_for_resource

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

SELECT
key,
value
FROM aws.transfer.tags
WHERE region = '{{ region }}' -- required
;

UPDATE examples

tag_resource

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. There is no response returned from this call.

UPDATE aws.transfer.tags
SET 
Arn = '{{ Arn }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND Arn = '{{ Arn }}' --required
AND Tags = '{{ Tags }}' --required;

untag_resource

Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. No response is returned from this call.

UPDATE aws.transfer.tags
SET 
Arn = '{{ Arn }}',
TagKeys = '{{ TagKeys }}'
WHERE 
region = '{{ region }}' --required
AND Arn = '{{ Arn }}' --required
AND TagKeys = '{{ TagKeys }}' --required;