Skip to content
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

Jump to bottom

S3 Config Documentation Update #8579

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

S3 Config Documentation Update #8579

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f743703
Update s3-config.rst
goabv Mar 14, 2024
c106a8c
Update s3-config.rst
goabv Mar 14, 2024
977e3fa
Update s3-config.rst to encourage using crt s3 client
goabv Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions awscli/topics/s3-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link

Choose a reason for hiding this comment

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

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?

* ``multipart_threshold`` - The size threshold the CLI uses for multipart
Expand Down Expand Up @@ -58,6 +59,7 @@ configuration::
aws_access_key_id=foo
aws_secret_access_key=bar
s3 =
preferred_transfer_client = crt
max_concurrent_requests = 20
max_queue_size = 10000
multipart_threshold = 64MB
Expand All @@ -74,6 +76,7 @@ You can also set these values programmatically using the ``aws configure set``
command. For example, to set the above values for the default profile, you
could instead run these commands::

$ aws configure set default.s3.preferred_transfer_client crt
$ aws configure set default.s3.max_concurrent_requests 20
$ aws configure set default.s3.max_queue_size 10000
$ aws configure set default.s3.multipart_threshold 64MB
Expand Down