max_bandwidth - AWS SDKs and Tools

max_bandwidth

This setting applies only to AWS CLI commands in the s3 namespace.

Specifies the maximum bandwidth that can be consumed for uploading data to and downloading data from Amazon S3.

Details

This setting limits the maximum bandwidth that the SDK or tool can use to transfer data to and from Amazon S3. This value applies to only uploads and downloads; it doesn't apply to copies or deletes.

Default value: The default value is no limit.

Valid values: The value is expressed as bytes per second. The value can be specified as:

  • An integer. For example, 1048576 sets the maximum bandwidth usage to 1 megabyte per second.

  • An integer followed by a rate suffix. You can specify rate suffixes using: KB/s, MB/s, or GB/s; for example, 300KB/s or 10MB/s.

In general, we recommend that you first try to lower bandwidth consumption by lowering max_concurrent_requests. If that doesn't adequately limit bandwidth consumption to the desired rate, you can use the max_bandwidth setting to further limit bandwidth consumption. This is because max_concurrent_requests controls how many threads are currently running. If you instead first lower max_bandwidth but leave a high max_concurrent_requests setting, it can result in threads having to wait unnecessarily. This can lead to excess resource consumption and connection timeouts.

Ways to set this value

Location Supported Example
config file Yes
s3 = max_bandwidth = 5MB/s
credentials file -
Environment variable -
AWS CLI parameter -

Compatibility with AWS SDKS and tools