tags

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

Overview

Name	tags
Type	Resource
Id	aws.kendra.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 index, FAQ, data source, or other resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.
untag_resource	update	region, ResourceARN, TagKeys		Removes a tag from an index, FAQ, data source, or other resource.
tag_resource	update	region, ResourceARN		Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.

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

Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.

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

UPDATE examples

untag_resource

Removes a tag from an index, FAQ, data source, or other resource.

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

tag_resource

Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.

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