Skip to content

Commit 794f4b5

Browse files
author
awstools
committed
feat(client-s3): Updated list of the valid AWS Region values for the LocationConstraint parameter for general purpose buckets.
1 parent 57c1525 commit 794f4b5

30 files changed

+327
-274
lines changed

clients/client-s3/src/commands/AbortMultipartUploadCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO
5353
* <li>
5454
* <p>
5555
* <b>Directory buckets</b> -
56-
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
57-
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
58-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
56+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
57+
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
58+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
5959
* <i>Amazon S3 User Guide</i>.</p>
6060
* </li>
6161
* </ul>

clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
7474
* <note>
7575
* <p>
7676
* <b>Directory buckets</b> -
77-
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
78-
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
79-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
77+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
78+
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
79+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
8080
* <i>Amazon S3 User Guide</i>.</p>
8181
* </note>
8282
* <dl>

clients/client-s3/src/commands/CopyObjectCommand.ts

+16-6
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
5454
* <li>
5555
* <p>
5656
* <b>Directory buckets </b> -
57-
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
58-
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
59-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
57+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
58+
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
59+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
6060
* <i>Amazon S3 User Guide</i>.</p>
6161
* </li>
6262
* <li>
@@ -211,9 +211,19 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
211211
* </dd>
212212
* <dt>HTTP Host header syntax</dt>
213213
* <dd>
214-
* <p>
215-
* <b>Directory buckets </b> - The HTTP Host header syntax is <code>
216-
* <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
214+
* <ul>
215+
* <li>
216+
* <p>
217+
* <b>Directory buckets </b> - The HTTP Host header syntax is <code>
218+
* <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
219+
* </li>
220+
* <li>
221+
* <p>
222+
* <b>Amazon S3 on Outposts</b> - When you use this action with S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the
223+
* form <code>
224+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.</p>
225+
* </li>
226+
* </ul>
217227
* </dd>
218228
* </dl>
219229
* <p>The following operations are related to <code>CopyObject</code>:</p>

clients/client-s3/src/commands/CreateBucketCommand.ts

+16-16
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
5959
* <p>
6060
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
6161
* </code>. Virtual-hosted-style requests aren't supported.
62-
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
63-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
62+
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
63+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
6464
* <i>Amazon S3 User Guide</i>.</p>
6565
* </li>
6666
* </ul>
@@ -189,7 +189,7 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
189189
* ACL: "private" || "public-read" || "public-read-write" || "authenticated-read",
190190
* Bucket: "STRING_VALUE", // required
191191
* CreateBucketConfiguration: { // CreateBucketConfiguration
192-
* LocationConstraint: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ca-central-1" || "cn-north-1" || "cn-northwest-1" || "EU" || "eu-central-1" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "me-south-1" || "sa-east-1" || "us-east-2" || "us-gov-east-1" || "us-gov-west-1" || "us-west-1" || "us-west-2",
192+
* LocationConstraint: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-southeast-4" || "ap-southeast-5" || "ca-central-1" || "cn-north-1" || "cn-northwest-1" || "EU" || "eu-central-1" || "eu-central-2" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "il-central-1" || "me-central-1" || "me-south-1" || "sa-east-1" || "us-east-2" || "us-gov-east-1" || "us-gov-west-1" || "us-west-1" || "us-west-2",
193193
* Location: { // LocationInfo
194194
* Type: "AvailabilityZone" || "LocalZone",
195195
* Name: "STRING_VALUE",
@@ -235,39 +235,39 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
235235
* <p>Base exception class for all service exceptions from S3 service.</p>
236236
*
237237
* @public
238-
* @example To create a bucket in a specific region
238+
* @example To create a bucket
239239
* ```javascript
240-
* // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
240+
* // The following example creates a bucket.
241241
* const input = {
242-
* "Bucket": "examplebucket",
243-
* "CreateBucketConfiguration": {
244-
* "LocationConstraint": "eu-west-1"
245-
* }
242+
* "Bucket": "examplebucket"
246243
* };
247244
* const command = new CreateBucketCommand(input);
248245
* const response = await client.send(command);
249246
* /* response ==
250247
* {
251-
* "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
248+
* "Location": "/examplebucket"
252249
* }
253250
* *\/
254-
* // example id: to-create-a-bucket-in-a-specific-region-1483399072992
251+
* // example id: to-create-a-bucket--1472851826060
255252
* ```
256253
*
257-
* @example To create a bucket
254+
* @example To create a bucket in a specific region
258255
* ```javascript
259-
* // The following example creates a bucket.
256+
* // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
260257
* const input = {
261-
* "Bucket": "examplebucket"
258+
* "Bucket": "examplebucket",
259+
* "CreateBucketConfiguration": {
260+
* "LocationConstraint": "eu-west-1"
261+
* }
262262
* };
263263
* const command = new CreateBucketCommand(input);
264264
* const response = await client.send(command);
265265
* /* response ==
266266
* {
267-
* "Location": "/examplebucket"
267+
* "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
268268
* }
269269
* *\/
270-
* // example id: to-create-a-bucket--1472851826060
270+
* // example id: to-create-a-bucket-in-a-specific-region-1483399072992
271271
* ```
272272
*
273273
*/

clients/client-s3/src/commands/CreateMultipartUploadCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
6262
* <li>
6363
* <p>
6464
* <b>Directory buckets </b> -
65-
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
66-
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
67-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
65+
* For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i>
66+
* </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
67+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
6868
* <i>Amazon S3 User Guide</i>.</p>
6969
* </li>
7070
* </ul>

clients/client-s3/src/commands/CreateSessionCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ export interface CreateSessionCommandOutput extends CreateSessionOutput, __Metad
6161
* <note>
6262
* <ul>
6363
* <li>
64-
* <p>You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
65-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
64+
* <p>You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
65+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
6666
* <i>Amazon S3 User Guide</i>.</p>
6767
* </li>
6868
* <li>

clients/client-s3/src/commands/DeleteBucketCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {}
4242
* <p>
4343
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
4444
* </code>. Virtual-hosted-style requests aren't supported.
45-
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
46-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
45+
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
46+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
4747
* <i>Amazon S3 User Guide</i>.</p>
4848
* </li>
4949
* </ul>

clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {}
6767
* <p>
6868
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
6969
* </code>. Virtual-hosted-style requests aren't supported.
70-
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
71-
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Available Local Zone for directory buckets</a> in the
70+
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
71+
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
7272
* <i>Amazon S3 User Guide</i>.</p>
7373
* </note>
7474
* </li>

0 commit comments

Comments
 (0)