Repository navigation
Check that CLI examples use approved placeholders and fix existing violations - #10823
Merged
Merged
Conversation
added 2 commits
October 29, 2026 15:28
Use the style guide placeholders for account IDs, GUIDs, bucket names and regions. Follows https://aws.github.io/aws-cli/docs_styleguide.html.
Add a check for the sanitizing sensitive information rule of the AWS CLI code example style guide: account IDs, GUIDs, bucket names and regions use the approved placeholders. Examples that need a real value are listed in example_style_exceptions.json: resources that only exist in one region (such as CloudFront certificates or the ECR Public API in us-east-1), examples that need several regions or accounts, and AWS-owned accounts and buckets.
GarrettBeatty
approved these changes
Oct 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Check that CLI examples use approved placeholders and fix existing violations
Rules from the "Sanitizing sensitive information" section of the Style guide:
test_example_sanitizationtotests/functional/docs/test_examples.py:s3://, S3 ARNs,--bucket, and"Bucket"keys) and regions must use the approved placeholders.ami-066877671789bd71b) and S3 access point URIs (s3://arn:...) are not flagged.123456789111).example_style_exceptions.json(92 examples), each with its reason:Testing
pytest tests/functional/docs/test_examples.py -n autoBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.