Skip to content

Commit b6395f4

Browse files
committed
Add enum values to s3 checksum help text
The help text for --checksum-mode and --checksum-algorithm did not document accepted enum values, making it unclear what options are available without consulting external docs. Update --checksum-mode to state ENABLED is the only valid value. Update --checksum-algorithm to list valid values (CRC64NVME, CRC32, SHA256, SHA1, CRC32C) and note the default. Fixes aws#10025
1 parent 9277ea6 commit b6395f4

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

awscli/customizations/s3/subcommands.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -454,13 +454,17 @@
454454

455455
CHECKSUM_MODE = {
456456
'name': 'checksum-mode', 'choices': ['ENABLED'],
457-
'help_text': 'To retrieve the checksum, this mode must be enabled. If the object has a '
458-
'checksum, it will be verified.'
457+
'help_text': 'To retrieve the checksum, this mode must be enabled. ENABLED is the only '
458+
'valid value. If the object has a checksum, it will be verified.'
459459
}
460460

461461
CHECKSUM_ALGORITHM = {
462462
'name': 'checksum-algorithm', 'choices': ['CRC64NVME', 'CRC32', 'SHA256', 'SHA1', 'CRC32C'],
463-
'help_text': 'Indicates the algorithm used to create the checksum for the object.'
463+
'help_text': (
464+
'Indicates the algorithm used to create the checksum for the object. '
465+
'Valid values are: CRC64NVME | CRC32 | SHA256 | SHA1 | CRC32C. '
466+
'Defaults to \'CRC64NVME\'.'
467+
)
464468
}
465469

466470
BUCKET_NAME_PREFIX = {

0 commit comments

Comments
 (0)