From a36ca30fef5a085cb0d9a1f319974b33abfa02c8 Mon Sep 17 00:00:00 2001 From: siddsriv Date: Tue, 3 Oct 2023 19:19:30 +0000 Subject: [PATCH] chore(middleware-sdk-s3): doc update --- packages/middleware-sdk-s3/src/s3Configuration.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/packages/middleware-sdk-s3/src/s3Configuration.ts b/packages/middleware-sdk-s3/src/s3Configuration.ts index 6aee45ceffd9a..33993c23aafa0 100644 --- a/packages/middleware-sdk-s3/src/s3Configuration.ts +++ b/packages/middleware-sdk-s3/src/s3Configuration.ts @@ -18,8 +18,10 @@ export interface S3InputConfig { */ disableMultiregionAccessPoints?: boolean; /** - * If you receive a permanent redirect with status 301, - * the client will retry your request with the corrected region. + * This feature was previously called the S3 Global Client. + * This can result in additional latency as failed requests are retried + * with a corrected region when receiving a permanent redirect error with status 301. + * This feature should only be used as a last resort if you do not know the region of your bucket(s) ahead of time. */ followRegionRedirects?: boolean; }