Skip to content

Document valid values for s3 cp checksum options #10090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjfxjas wants to merge 1 commit into
base: develop
Choose a base branch
from
+3 −2
Open

Document valid values for s3 cp checksum options #10090

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions awscli/customizations/s3/subcommands.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 value: ENABLED.'
Copy link
Contributor

@adev-code adev-code Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'checksum, it will be verified. Valid value: ENABLED.'
'help_text': 'To retrieve the checksum, this mode must be enabled. ENABLED is the only '
'valid value. If the object has a checksum, it will be verified.'

As per previous comment:
It looks like the existing pattern for a single value is "ENABLED is the only valid value." See SSE_C for an example.

}

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, SHA256, SHA1, CRC32C.'
Copy link
Contributor

@adev-code adev-code Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'Valid values: CRC64NVME, CRC32, SHA256, SHA1, CRC32C.'
'Valid values are: CRC64NVME | CRC32 | SHA256 | SHA1 | CRC32C.'

Nit: using same or format for choices.

}

BUCKET_NAME_PREFIX = {
Expand Down