You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,13 +39,17 @@ Example Usage:
39
39
> };
40
40
> ```
41
41
42
-
> [!NOTE]
43
-
> * **Priority**: The configuration value takes precedence over the environment variable. If `memory_limit_in_bytes` is set to a non-zero value in the config, the environment variable is ignored.
44
-
> * **Default Behavior**: If neither is set (config is 0 and environment variable is not set), the client sets a default memory limit based on the target throughput.
45
-
> * The limit applies per client. If multiple clients created, limit will apply to each separately.
46
-
> * The environment variable value must be a valid positive integer representing gigabytes (GiB).
47
-
> * The value is converted from GiB to bytes internally (1 GiB = 1024³ bytes).
48
-
> * Invalid values or overflow conditions will cause client creation to fail with `AWS_ERROR_INVALID_ARGUMENT`.
42
+
###### Priority
43
+
The configuration value takes precedence over the environment variable. If `memory_limit_in_bytes` is set to a non-zero value in the config, the environment variable is ignored.
44
+
45
+
###### Default Behavior
46
+
If neither is set (config is 0 and environment variable is not set), the client sets a default memory limit based on the target throughput.
47
+
48
+
###### Notes
49
+
* The limit applies per client. If multiple clients created, limit will apply to each separately.
50
+
* The environment variable value must be a valid positive integer representing gigabytes (GiB).
51
+
* The value is converted from GiB to bytes internally (1 GiB = 1024³ bytes).
52
+
* Invalid values or overflow conditions will cause client creation to fail with `AWS_ERROR_INVALID_ARGUMENT`.
49
53
50
54
##### Maximum Parts Pending Read - `AWS_CRT_S3_MAX_PARTS_PENDING_READ`
51
55
@@ -57,12 +61,12 @@ Example Usage:
57
61
export AWS_CRT_S3_MAX_PARTS_PENDING_READ=20
58
62
```
59
63
60
-
> [!NOTE]
61
-
> * Only affects multipart uploads. Small files that fit in a single part are not affected.
62
-
> * Setting this too low may introduce delays between reads, as the meta-request waits for the client to schedule more work.
63
-
> * Setting this too high may cause a single upload to hog work tokens, starving other concurrent uploads.
64
-
> * The value must be a positive integer (1–4294967295). Invalid or zero values are ignored with a warning, and the default is used.
65
-
> * The value is read once on first use and cached for the lifetime of the process.
64
+
###### Notes
65
+
* Only affects multipart uploads. Small files that fit in a single part are not affected.
66
+
* Setting this too low may introduce delays between reads, as the meta-request waits for the client to schedule more work.
67
+
* Setting this too high may cause a single upload to hog work tokens, starving other concurrent uploads.
68
+
* The value must be a positive integer (1–4294967295). Invalid or zero values are ignored with a warning, and the default is used.
69
+
* The value is read once on first use and cached for the lifetime of the process.
0 commit comments