From b9a1c65a5907dd1675cb7599fb94f13444171174 Mon Sep 17 00:00:00 2001 From: droppingbeans Date: Tue, 3 Feb 2026 04:14:22 +0000 Subject: [PATCH 1/4] docs: include valid values for S3 checksum options Adds valid enum values to help text for --checksum-mode and --checksum-algorithm so generated documentation includes them. Fixes #10025 --- awscli/customizations/s3/subcommands.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/awscli/customizations/s3/subcommands.py b/awscli/customizations/s3/subcommands.py index f77d7196e488..a04c9e9373c6 100644 --- a/awscli/customizations/s3/subcommands.py +++ b/awscli/customizations/s3/subcommands.py @@ -455,12 +455,13 @@ CHECKSUM_MODE = { 'name': 'checksum-mode', 'choices': ['ENABLED'], 'help_text': 'To retrieve the checksum, this mode must be enabled. If the object has a ' - 'checksum, it will be verified.' + 'checksum, it will be verified. Valid values: ENABLED.' } CHECKSUM_ALGORITHM = { 'name': 'checksum-algorithm', 'choices': ['CRC64NVME', 'CRC32', 'SHA256', 'SHA1', 'CRC32C'], - 'help_text': 'Indicates the algorithm used to create the checksum for the object.' + 'help_text': 'Indicates the algorithm used to create the checksum for the object. ' + 'Valid values: CRC64NVME, CRC32, CRC32C, SHA1, and SHA256.' } BUCKET_NAME_PREFIX = { From 21f77434a1a3a1d1da32bfc4e47bf6071f9145dc Mon Sep 17 00:00:00 2001 From: droppingbeans Date: Thu, 5 Feb 2026 01:05:42 +0000 Subject: [PATCH 2/4] Apply formatting changes: use parentheses and backticks for valid values --- awscli/customizations/s3/subcommands.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/awscli/customizations/s3/subcommands.py b/awscli/customizations/s3/subcommands.py index a04c9e9373c6..103dd28f2569 100644 --- a/awscli/customizations/s3/subcommands.py +++ b/awscli/customizations/s3/subcommands.py @@ -454,14 +454,18 @@ CHECKSUM_MODE = { 'name': 'checksum-mode', 'choices': ['ENABLED'], - 'help_text': 'To retrieve the checksum, this mode must be enabled. If the object has a ' - 'checksum, it will be verified. Valid values: ENABLED.' + 'help_text': ( + 'To retrieve the checksum, this mode must be enabled. If the object has a ' + 'checksum, it will be verified. Valid value is ``ENABLED``.' + ) } CHECKSUM_ALGORITHM = { 'name': 'checksum-algorithm', 'choices': ['CRC64NVME', 'CRC32', 'SHA256', 'SHA1', 'CRC32C'], - 'help_text': 'Indicates the algorithm used to create the checksum for the object. ' - 'Valid values: CRC64NVME, CRC32, CRC32C, SHA1, and SHA256.' + 'help_text': ( + 'Indicates the algorithm used to create the checksum for the object. ' + 'Valid values are ``CRC64NVME``, ``CRC32``, ``CRC32C``, ``SHA1``, and ``SHA256``.' + ) } BUCKET_NAME_PREFIX = { From 72e1f0e9057774c791f9ff92f1a63f84c934aa91 Mon Sep 17 00:00:00 2001 From: droppingbeans Date: Fri, 6 Feb 2026 06:21:34 +0000 Subject: [PATCH 3/4] Apply formatting changes as requested - Remove backticks from ENABLED value - Change 'is' to ':' for checksum-mode - Change 'values' to 'choices' for checksum-algorithm - Use pipe separators instead of commas - Add default value for checksum-algorithm --- awscli/customizations/s3/subcommands.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/awscli/customizations/s3/subcommands.py b/awscli/customizations/s3/subcommands.py index 103dd28f2569..2af1247d4b85 100644 --- a/awscli/customizations/s3/subcommands.py +++ b/awscli/customizations/s3/subcommands.py @@ -456,7 +456,7 @@ 'name': 'checksum-mode', 'choices': ['ENABLED'], 'help_text': ( 'To retrieve the checksum, this mode must be enabled. If the object has a ' - 'checksum, it will be verified. Valid value is ``ENABLED``.' + 'checksum, it will be verified. Valid value: ENABLED.' ) } @@ -464,7 +464,7 @@ 'name': 'checksum-algorithm', 'choices': ['CRC64NVME', 'CRC32', 'SHA256', 'SHA1', 'CRC32C'], 'help_text': ( 'Indicates the algorithm used to create the checksum for the object. ' - 'Valid values are ``CRC64NVME``, ``CRC32``, ``CRC32C``, ``SHA1``, and ``SHA256``.' + 'Valid choices are: CRC64NVME | CRC32 | SHA256 | SHA1 | CRC32C. Defaults to \'CRC64NVME\'.' ) } From 4da361424b0a4dda8a2c1cbb68db104bb2e6f75a Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Fri, 13 Feb 2026 01:41:07 +0000 Subject: [PATCH 4/4] docs: use consistent terminology per review feedback - Changed 'Valid value: ENABLED.' to 'ENABLED is the only valid value.' (following SSE_C pattern) - Changed 'Valid choices are:' to 'Valid values:' for consistency --- awscli/customizations/s3/subcommands.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/awscli/customizations/s3/subcommands.py b/awscli/customizations/s3/subcommands.py index 2af1247d4b85..8fbd06f9c51e 100644 --- a/awscli/customizations/s3/subcommands.py +++ b/awscli/customizations/s3/subcommands.py @@ -456,7 +456,7 @@ 'name': 'checksum-mode', 'choices': ['ENABLED'], 'help_text': ( 'To retrieve the checksum, this mode must be enabled. If the object has a ' - 'checksum, it will be verified. Valid value: ENABLED.' + 'checksum, it will be verified. ENABLED is the only valid value.' ) } @@ -464,7 +464,7 @@ 'name': 'checksum-algorithm', 'choices': ['CRC64NVME', 'CRC32', 'SHA256', 'SHA1', 'CRC32C'], 'help_text': ( 'Indicates the algorithm used to create the checksum for the object. ' - 'Valid choices are: CRC64NVME | CRC32 | SHA256 | SHA1 | CRC32C. Defaults to \'CRC64NVME\'.' + 'Valid values: CRC64NVME | CRC32 | SHA256 | SHA1 | CRC32C. Defaults to \'CRC64NVME\'.' ) }