tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.workmail.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
tags | array | A list of tag key-value pairs. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_tags_for_resource | select | region | Lists the tags applied to an WorkMail organization resource. | |
untag_resource | update | region, ResourceARN, TagKeys | Untags the specified tags from the specified WorkMail organization resource. | |
tag_resource | update | region, ResourceARN | Applies the specified tags to the specified WorkMailorganization 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) |
SELECT examples
- list_tags_for_resource
Lists the tags applied to an WorkMail organization resource.
SELECT
tags
FROM aws.workmail.tags
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- untag_resource
- tag_resource
Untags the specified tags from the specified WorkMail organization resource.
UPDATE aws.workmail.tags
SET
ResourceARN = '{{ ResourceARN }}',
TagKeys = '{{ TagKeys }}'
WHERE
region = '{{ region }}' --required
AND ResourceARN = '{{ ResourceARN }}' --required
AND TagKeys = '{{ TagKeys }}' --required;
Applies the specified tags to the specified WorkMailorganization resource.
UPDATE aws.workmail.tags
SET
ResourceARN = '{{ ResourceARN }}',
Tags = '{{ Tags }}'
WHERE
region = '{{ region }}' --required
AND ResourceARN = '{{ ResourceARN }}' --required;