API Gateway v2: Put routing rule from the CLI

Part 312 of AWS from Zero. This is lesson 11 in the API Gateway v2 track.

What we are learning

Use put-routing-rule to change one API Gateway v2 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 apigatewayv2 put-routing-rule. Required operation inputs: --actions (list), --conditions (list), --domain-name (string), --priority (integer), --routing-rule-id (string). The modeled top-level response contains Actions, Conditions, Priority, RoutingRuleArn, RoutingRuleId.

Before you run it

aws sts get-caller-identity
REGION="${AWS_REGION:-ap-south-1}"
DOMAIN_NAME="replace-with-domain-name"
PRIORITY="replace-with-priority"
ROUTING_RULE_ID="replace-with-routing-rule-id"
aws apigatewayv2 put-routing-rule 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 put-routing-rule \
  --generate-cli-skeleton input > part-312-request.json
 
# Edit every placeholder in part-312-request.json, then run:
aws apigatewayv2 put-routing-rule \
  --cli-input-json file://part-312-request.json \
  --region "$REGION" \
  --output json > part-312-response.json

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

Inspect the result

node -e "const r=require('./part-312-response.json'); console.log(Object.keys(r))"
node -e "const r=require('./part-312-response.json'); console.log(JSON.stringify(r, null, 2))"

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

node -e "const r=require('./part-312-response.json'); console.log(JSON.stringify(r["Actions"], null, 2))"

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-312-request.json part-312-response.json part-312-payload.bin part-312-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: Update API from the CLI.

Official AWS CLI reference