Tagging Amazon OpenSearch Ingestion pipelines - Amazon OpenSearch Service
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 Ingestion pipelines

Tags let you assign arbitrary information to an Amazon OpenSearch Ingestion pipeline 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.

Tags help you 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 Ingestion pipeline 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.

  • Restrict access to pipelines using attribute based access control. For more information, see Controlling access based on tag keys in the IAM User Guide.

In OpenSearch Ingestion, the primary resource is a pipeline. You can use the OpenSearch Service console, the Amazon CLI, OpenSearch Ingestion APIs, or the Amazon SDKs to add, manage, and remove tags from a pipeline.

Permissions required

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

  • osis:TagResource

  • osis:ListTagsForResource

  • osis:UntagResource

For more information about each permission, see Actions, resources, and condition keys for OpenSearch Ingestion in the Service Authorization Reference.

Working with tags (console)

The console is the simplest way to tag a pipeline.

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

  2. Choose Ingestion on the left navigation pane.

  3. Select the pipeline 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 pipeline using the Amazon CLI, send a TagResource request:

aws osis tag-resource --arn arn:aws:osis:us-east-1:123456789012:pipeline/my-pipeline --tags Key=service,Value=osis Key=source,Value=otel

Remove tags from a pipeline using the UntagResource command:

aws osis untag-resource --arn arn:aws:osis:us-east-1:123456789012:pipeline/my-pipeline --tag-keys service

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

aws osis list-tags-for-resource --arn arn:aws:osis:us-east-1:123456789012:pipeline/my-pipeline