Tagging Amazon OpenSearch Serverless collections - Amazon OpenSearch Service
Permissions requiredWorking with tags (console)Working with tags (Amazon CLI)
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Tagging Amazon OpenSearch Serverless collections

Tags let you assign arbitrary information to an Amazon OpenSearch Serverless collection so you can categorize and filter on that information. A tag is a metadata label that you assign or that Amazon assigns to an Amazon resource.

Each tag consists of a key and a value. For tags that you assign, you define the key and value. For example, you might define the key as stage and the value for one resource as test.

With tags, you can do the following:

  • Identify and organize your Amazon resources. Many Amazon services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you could assign the same tag to an OpenSearch Serverless collection that you assign to an Amazon OpenSearch Service domain.

  • Track your Amazon costs. You activate these tags on the Amazon Billing and Cost Management dashboard. Amazon uses the tags to categorize your costs and deliver a monthly cost allocation report to you. For more information, see Use Cost Allocation Tags in the Amazon Billing User Guide.

In OpenSearch Serverless, the primary resource is a collection. You can use the OpenSearch Service console, the Amazon CLI, the OpenSearch Serverless API operations, or the Amazon SDKs to add, manage, and remove tags from a collection.

Permissions required

OpenSearch Serverless uses the following Amazon Identity and Access Management Access Analyzer (IAM) permissions for tagging collections:

  • aoss:TagResource

  • aoss:ListTagsForResource

  • aoss:UntagResource

Working with tags (console)

The console is the simplest way to tag a collection.

To create a tag (console)

  1. Sign in to the Amazon OpenSearch Service console at https://console.aws.amazon.com/aos/home.

  2. Expand Serverless in the left navigation pane and choose Collections.

  3. Select the collection that you want to add tags to, and go to the Tags tab.

  4. Choose Manage and Add new tag.

  5. Enter a tag key and an optional value.

  6. Choose Save.

To delete a tag, follow the same steps and choose Remove on the Manage tags page.

For more information about using the console to work with tags, see Tag Editor in the Amazon Management Console Getting Started Guide.

Working with tags (Amazon CLI)

To tag a collection using the Amazon CLI, send a TagResource request: 

aws opensearchserverless tag-resource
  --resource-arn arn:aws:aoss:us-east-1:123456789012:collection/my-collection 
  --tags Key=service,Value=aoss Key=source,Value=logs

View the existing tags for a collection with the ListTagsForResource command:

aws opensearchserverless list-tags-for-resource
  --resource-arn arn:aws:aoss:us-east-1:123456789012:collection/my-collection

Remove tags from a collection using the UntagResource command:

aws opensearchserverless untag-resource
  --resource-arn arn:aws:aoss:us-east-1:123456789012:collection/my-collection
  --tag-keys service