API Gateway v2: Tag resource from the CLI

Part 315 of AWS from Zero. This is lesson 14 in the API Gateway v2 track.

What we are learning

Use tag-resource to add or remove ownership and lifecycle metadata on a API Gateway v2 resource. This lesson identifies the required input shape, saves the raw response, and keeps inspection separate from execution.

The AWS CLI operation is aws apigatewayv2 tag-resource. Required operation inputs: --resource-arn (string). 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}"
RESOURCE_ARN="replace-with-resource-arn"
aws apigatewayv2 tag-resource 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: API requests, data transfer, custom domains, and connected services can incur charges.

The command

aws apigatewayv2 tag-resource \
  --resource-arn "$RESOURCE_ARN" \
  --region "$REGION" \
  --output json > part-315-response.json

The response is saved to part-315-response.json so inspection is separate from execution. The explicit variables above keep required identifiers visible before the API call.

Inspect the result

# A zero-byte response can be normal for operations without a response body.
wc -c part-315-response.json
aws apigatewayv2 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-315-response.json \
  && node -e "console.log(require('./part-315-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-315-request.json part-315-response.json part-315-payload.bin part-315-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 API Gateway v2: Delete access log settings from the CLI.

Official AWS CLI reference