tags

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

Overview

Name	tags
Type	Resource
Id	aws.qbusiness.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	array	A list of tags associated with the Amazon Q Business application or data source.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	resource_arn, region		Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
tag_resource	update	resource_arn, region, tags		Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
untag_resource	update	resource_arn, tagKeys, region		Removes a tag from an Amazon Q Business application or a data source.

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)
resource_arn	string	The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
tagKeys	array	A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.

SELECT examples

list_tags_for_resource

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

SELECT
tags
FROM aws.qbusiness.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

tag_resource

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

UPDATE aws.qbusiness.tags
SET 
tags = '{{ tags }}'
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;

untag_resource

Removes a tag from an Amazon Q Business application or a data source.

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