Skip to content

Document valid values for s3 cp checksum options#10090

Open
mjfxjas wants to merge 1 commit intoaws:developfrom
mjfxjas:jon/issue-10025-s3-checksum-values
Open

Document valid values for s3 cp checksum options#10090
mjfxjas wants to merge 1 commit intoaws:developfrom
mjfxjas:jon/issue-10025-s3-checksum-values

Conversation

@mjfxjas
Copy link
Copy Markdown

@mjfxjas mjfxjas commented Feb 19, 2026

Summary

  • update aws s3 cp option help text to explicitly list valid values for:
    • --checksum-mode
    • --checksum-algorithm
  • keeps existing behavior unchanged and only clarifies docs output

Testing

  • help text/docs-only change

Closes #10025

@mjfxjas
Copy link
Copy Markdown
Author

mjfxjas commented Feb 20, 2026

Friendly follow-up on this docs clarification.

This PR documents valid values for aws s3 cp checksum options to reduce trial and error for users. If maintainers prefer, I can also add a short note or example showing a recommended default workflow.

@adev-code adev-code self-requested a review February 26, 2026 20:02
@adev-code adev-code added the documentation This is a problem with documentation. label Feb 26, 2026
@adev-code
Copy link
Copy Markdown
Contributor

Thanks @mjfxjas for the PR! Made some comments on the changes.

@mjfxjas
Copy link
Copy Markdown
Author

mjfxjas commented Feb 26, 2026

Thanks @adev-code — I’m ready to address all feedback. I’m not seeing the inline review comments on my side yet. Could you re-submit/publish them (or paste them here), and I’ll update the PR right away.

'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
Copy Markdown
Contributor

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.

'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
Copy Markdown
Contributor

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.

@ashovlin
Copy link
Copy Markdown
Member

Hey @mjfxjas, we recently added support for new algorithms: SHA512, XXHASH3, XXHASH64, XXHASH128. MD5 is only supported for pre-calculated values, not for automatic calculation via --checksum-algorithm.

Are you still interested in updating this to address Adrian's comments and the four new algorithms? No worries if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This is a problem with documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

aws s3 cp --checksum-mode and --checksum-algorithm enum values are not documented

4 participants