Skip to content

Commit 5fbc78b

Browse files
authored
docs: followRegionRedirect for S3 (#6082)
1 parent 1eda2f1 commit 5fbc78b

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

supplemental-docs/CLIENTS.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,15 @@ See also https://aws.amazon.com/blogs/developer/middleware-stack-modular-aws-sdk
606606
607607
### S3
608608
609-
TODO e.g. `followRegionRedirects`
609+
`followRegionRedirects`:
610+
This feature was previously called the S3 Global Client. Setting this option to true enables failed requests to be retried with a corrected region when receiving a permanent redirect error with status 301. Note that this can result in additional latency owing to the retried request. This feature should only be used as a last resort if you do not know the region of your bucket(s) ahead of time.
611+
612+
```ts
613+
// Example: setting followRegionRedirect
614+
new S3Client({
615+
followRegionRedirect: true,
616+
});
617+
```
610618
611619
### SQS
612620

0 commit comments

Comments
 (0)