tags

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

Overview

Name	tags
Type	Resource
Id	aws.workspaces_instances.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	array	Collection of tags associated with the WorkSpace Instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		Retrieves tags for a WorkSpace Instance.
untag_resource	update	region, WorkspaceInstanceId, TagKeys		Removes tags from a WorkSpace Instance.
tag_resource	update	region, WorkspaceInstanceId		Adds tags to a WorkSpace Instance.

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

Retrieves tags for a WorkSpace Instance.

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

UPDATE examples

untag_resource

Removes tags from a WorkSpace Instance.

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

tag_resource

Adds tags to a WorkSpace Instance.

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