tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.socialmessaging.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
status_code | integer | The status code of the response. |
tags | array | The tags for the resource. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_tags_for_resource | select | resourceArn, region | List all tags associated with a resource, such as a phone number or WABA. | |
tag_resource | update | region, resourceArn, tags | Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. | |
untag_resource | update | region, resourceArn, tagKeys | Removes the specified 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) |
resourceArn | string | The Amazon Resource Name (ARN) of the resource to retrieve the tags from. |
SELECT examples
- list_tags_for_resource
List all tags associated with a resource, such as a phone number or WABA.
SELECT
status_code,
tags
FROM aws.socialmessaging.tags
WHERE resourceArn = '{{ resourceArn }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- tag_resource
- untag_resource
Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value.
UPDATE aws.socialmessaging.tags
SET
resourceArn = '{{ resourceArn }}',
tags = '{{ tags }}'
WHERE
region = '{{ region }}' --required
AND resourceArn = '{{ resourceArn }}' --required
AND tags = '{{ tags }}' --required
RETURNING
status_code;
Removes the specified tags from a resource.
UPDATE aws.socialmessaging.tags
SET
resourceArn = '{{ resourceArn }}',
tagKeys = '{{ tagKeys }}'
WHERE
region = '{{ region }}' --required
AND resourceArn = '{{ resourceArn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
RETURNING
status_code;