tags

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

Overview

Name	tags
Type	Resource
Id	aws.osis.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 given pipeline.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	arn, region		Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
untag_resource	update	arn, region, TagKeys		Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.
tag_resource	update	arn, region		Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

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
arn	string	The Amazon Resource Name (ARN) of the pipeline to tag.
region	string	AWS region (default: us-east-1)

SELECT examples

list_tags_for_resource

Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

SELECT
tags
FROM aws.osis.tags
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

UPDATE aws.osis.tags
SET 
TagKeys = '{{ TagKeys }}'
WHERE 
arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
AND TagKeys = '{{ TagKeys }}' --required;

tag_resource

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

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