S3 Config Documentation Update #8579
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #8579 +/- ##
=======================================
Coverage 0.08% 0.08%
=======================================
Files 208 208
Lines 16716 16716
=======================================
Hits 14 14
Misses 16702 16702 ☔ View full report in Codecov by Sentry. |
| @@ -22,6 +22,7 @@ Configuration Values | |||
| These are the configuration values you can set specifically for the ``aws s3`` | |||
| command set: | |||
|
|
|||
| * ``preferred_transfer_client`` - This determines the underlying Amazon S3 transfer client to use for transferring files to and from S3. For most workloads, choosing ``crt`` will enable faster uploads and downloads. | |||
| * ``max_concurrent_requests`` - The maximum number of concurrent requests. | |||
| * ``max_queue_size`` - The maximum number of tasks in the task queue. | |||
There was a problem hiding this comment.
Some of these config options only apply to classic, and some only apply to crt. If we're going to suggest crt we probably shouldn't show a bunch of settings that don't affect it.
This is currently detailed further down in the doc: https://awscli.amazonaws.com/v2/documentation/api/latest/topic/s3-config.html#preferred-transfer-client
Should we do a better job in this doc of breaking up which options affect both, which affect crt-only, and which are classic-only?
|
Thanks for the PR, @goabv. Most of this information is already in the CLI v2 docs here. We won't want to add this to the CLI v1 docs, as this PR does, because the CRT isn't available by default. Was there something specifically insufficient with the current docs? Any changes should be made here on the |
Issue #, if available:
Description of changes: Updating S3 configuration doc to encourage using CRT S3 client
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.