OpenSearch Service: Add tags from the CLI

Part 866 of AWS from Zero. This is lesson 13 in the OpenSearch Service track.

What we are learning

Use add-tags to change one OpenSearch Service configuration deliberately and inspect the resulting state. This lesson identifies the required input shape, saves the raw response, and keeps inspection separate from execution.

The AWS CLI operation is aws opensearch add-tags. Required operation inputs: --arn (string), --tag-list (list). The modeled top-level response contains no modeled response body.

Before you run it

aws sts get-caller-identity
REGION="${AWS_REGION:-ap-south-1}"
ARN="replace-with-arn"
aws opensearch add-tags help

Use a sandbox account or an approved learning environment. Read the operation help before supplying identifiers, ARNs, network ranges, policy documents, or customer data.

Cost note: Domains, serverless collections, storage, snapshots, and data transfer can incur substantial charges.

The command

aws opensearch add-tags \
  --generate-cli-skeleton input > part-866-request.json
 
# Edit every placeholder in part-866-request.json, then run:
aws opensearch add-tags \
  --cli-input-json file://part-866-request.json \
  --region "$REGION" \
  --output json > part-866-response.json

The response is saved to part-866-response.json so inspection is separate from execution. Review part-866-request.json, replace every placeholder, and remove unsupported optional fields before the real call.

Inspect the result

# A zero-byte response can be normal for operations without a response body.
wc -c part-866-response.json
aws opensearch help

Compare the returned identifiers and status fields with the account, Region, and resource you intended to target. For asynchronous operations, continue with the service's matching get, list, or describe command until it reaches a terminal state.

One tiny variation

test -s part-866-response.json \
  && node -e "console.log(require('./part-866-response.json'))" \
  || echo "The operation returned no response document."

This variation changes output inspection rather than adding another infrastructure concept. Keep the raw JSON while developing a query so a narrow projection does not hide an error or unexpected field.

Common mistake

Do not treat a zero exit code as proof that the intended state is active everywhere. AWS control planes can be eventually consistent, and some operations start asynchronous work.

Cleanup

# This operation is read-only, operational, or needs resource-specific rollback.
# Re-read the command output before changing shared infrastructure.
rm -f part-866-request.json part-866-response.json part-866-payload.bin part-866-debug.log

Local request and response files may contain account IDs, ARNs, names, or service configuration. Remove them when the lab is complete and follow dependency-aware cleanup for any AWS resource you created.

Next, we will learn OpenSearch Service: Start domain maintenance from the CLI.

Official AWS CLI reference