tags

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

Overview

Name	tags
Type	Resource
Id	aws.wellarchitected.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	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	workload_arn, region		List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
untag_resource	update	workload_arn, tagKeys, region		Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
tag_resource	update	workload_arn, region		Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

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)
tagKeys	array	A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.
workload_arn	string

SELECT examples

list_tags_for_resource

List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

SELECT
tags
FROM aws.wellarchitected.tags
WHERE workload_arn = '{{ workload_arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

UPDATE aws.wellarchitected.tags
SET 
-- No updatable properties
WHERE 
workload_arn = '{{ workload_arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;

tag_resource

Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

UPDATE aws.wellarchitected.tags
SET 
Tags = '{{ Tags }}'
WHERE 
workload_arn = '{{ workload_arn }}' --required
AND region = '{{ region }}' --required;