tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.workspaces_thin_client.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
tags | object | A map of the key-value pairs for the tag or tags assigned to the specified 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 | Returns a list of tags for a resource. | |
tag_resource | update | resource_arn, region, tags | Assigns one or more tags (key-value pairs) to the specified resource. | |
untag_resource | update | resource_arn, tagKeys, region | Removes a tag or tags from a resource. |
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) of the resource that you want to untag. |
tagKeys | array | The keys of the key-value pairs for the tag or tags you want to remove from the specified resource. |
SELECT examples
- list_tags_for_resource
Returns a list of tags for a resource.
SELECT
tags
FROM aws.workspaces_thin_client.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- tag_resource
- untag_resource
Assigns one or more tags (key-value pairs) to the specified resource.
UPDATE aws.workspaces_thin_client.tags
SET
tags = '{{ tags }}'
WHERE
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;
Removes a tag or tags from a resource.
UPDATE aws.workspaces_thin_client.tags
SET
-- No updatable properties
WHERE
resource_arn = '{{ resource_arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;