CloudFormation: List resource scan related resources from the CLI

Part 1083 of AWS from Zero. This is lesson 41 in the CloudFormation track.

What we are learning

Use list-resource-scan-related-resources to read or inventory resource scan related resources in CloudFormation. This lesson identifies the required input shape, saves the raw response, and keeps inspection separate from execution.

The AWS CLI operation is aws cloudformation list-resource-scan-related-resources. Required operation inputs: --resource-scan-id (string), --resources (list). The modeled top-level response contains RelatedResources, NextToken.

Before you run it

aws sts get-caller-identity
REGION="${AWS_REGION:-ap-south-1}"
RESOURCE_SCAN_ID="replace-with-resource-scan-id"
aws cloudformation list-resource-scan-related-resources 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: CloudFormation registry extensions and hook usage may be priced, and every resource created by a stack can incur charges.

The command

aws cloudformation list-resource-scan-related-resources \
  --generate-cli-skeleton input > part-1083-request.json
 
# Edit every placeholder in part-1083-request.json, then run:
aws cloudformation list-resource-scan-related-resources \
  --cli-input-json file://part-1083-request.json \
  --region "$REGION" \
  --output json > part-1083-response.json

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

Inspect the result

node -e "const r=require('./part-1083-response.json'); console.log(Object.keys(r))"
node -e "const r=require('./part-1083-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-1083-response.json'); console.log(JSON.stringify(r["RelatedResources"], 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

An empty response does not always mean the resource is absent. Confirm the account, Region, pagination behavior, filters, and caller permissions before concluding that nothing exists.

Cleanup

# This operation is read-only, operational, or needs resource-specific rollback.
# Re-read the command output before changing shared infrastructure.
rm -f part-1083-request.json part-1083-response.json part-1083-payload.bin part-1083-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 CloudFormation: List resource scan resources from the CLI.

Official AWS CLI reference