tags

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

Overview

Name	tags
Type	Resource
Id	aws.workspaces.tags

Fields

The following fields are returned by SELECT queries:

describe_tags

Name	Datatype	Description
tag_list	array	The tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_tags	select	region		Describes the specified tags for the specified WorkSpaces resource.
create_tags	insert	region, ResourceId, Tags		Creates the specified tags for the specified WorkSpaces resource.
delete_tags	delete	region		Deletes the specified tags from the specified WorkSpaces 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

describe_tags

Describes the specified tags for the specified WorkSpaces resource.

SELECT
tag_list
FROM aws.workspaces.tags
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_tags

Creates the specified tags for the specified WorkSpaces resource.

INSERT INTO aws.workspaces.tags (
ResourceId,
Tags,
region
)
SELECT 
'{{ ResourceId }}' /* required */,
'{{ Tags }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: tags
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the tags resource.
  - name: ResourceId
    value: "{{ ResourceId }}"
    description: |
      The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
  - name: Tags
    description: |
      The tags. Each WorkSpaces resource can have a maximum of 50 tags.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_tags

Deletes the specified tags from the specified WorkSpaces resource.

DELETE FROM aws.workspaces.tags
WHERE region = '{{ region }}' --required
;