@aws-sdk/client-s3 3.701.0 → 3.703.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-cjs/index.js +4 -2
  3. package/dist-es/endpoint/ruleset.js +3 -3
  4. package/dist-es/models/models_0.js +2 -0
  5. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +4 -3
  6. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +4 -3
  7. package/dist-types/commands/CopyObjectCommand.d.ts +4 -3
  8. package/dist-types/commands/CreateBucketCommand.d.ts +6 -5
  9. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +4 -3
  10. package/dist-types/commands/CreateSessionCommand.d.ts +3 -2
  11. package/dist-types/commands/DeleteBucketCommand.d.ts +4 -3
  12. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +1 -1
  13. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +3 -2
  14. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +4 -3
  15. package/dist-types/commands/DeleteObjectCommand.d.ts +63 -53
  16. package/dist-types/commands/DeleteObjectsCommand.d.ts +4 -3
  17. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +1 -1
  18. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +3 -2
  19. package/dist-types/commands/GetBucketPolicyCommand.d.ts +4 -3
  20. package/dist-types/commands/GetObjectAttributesCommand.d.ts +4 -3
  21. package/dist-types/commands/GetObjectCommand.d.ts +23 -22
  22. package/dist-types/commands/GetObjectTaggingCommand.d.ts +19 -19
  23. package/dist-types/commands/HeadBucketCommand.d.ts +4 -3
  24. package/dist-types/commands/HeadObjectCommand.d.ts +4 -3
  25. package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +3 -2
  26. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +4 -3
  27. package/dist-types/commands/ListObjectsV2Command.d.ts +4 -3
  28. package/dist-types/commands/ListPartsCommand.d.ts +4 -3
  29. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -3
  30. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +7 -2
  31. package/dist-types/commands/PutBucketPolicyCommand.d.ts +4 -3
  32. package/dist-types/commands/PutObjectCommand.d.ts +36 -35
  33. package/dist-types/commands/UploadPartCommand.d.ts +4 -3
  34. package/dist-types/commands/UploadPartCopyCommand.d.ts +4 -3
  35. package/dist-types/models/models_0.d.ts +69 -62
  36. package/dist-types/models/models_1.d.ts +42 -17
  37. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  38. package/package.json +1 -1
@@ -27,78 +27,88 @@ declare const DeleteObjectCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes an object from a bucket. The behavior depends on the bucket's versioning state.
31
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjects.html#DeletingObjects-best-practices">Best
32
- * practices to consider before deleting an object</a>.</p>
33
- * <p>To remove a specific version, you must use the <code>versionId</code> query parameter.
34
- * Using this query parameter permanently deletes the version. If the object deleted is a
35
- * delete marker, Amazon S3 sets the response header <code>x-amz-delete-marker</code> to true. If
36
- * the object you want to delete is in a bucket where the bucket versioning configuration is
37
- * MFA delete enabled, you must include the <code>x-amz-mfa</code> request header in the
38
- * DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> must
39
- * use HTTPS. For more information about MFA delete and to see example requests, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA
40
- * delete</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample
41
- * request</a> in the <i>Amazon S3 User Guide</i>.</p>
30
+ * <p>Removes an object from a bucket. The behavior depends on the bucket's versioning state: </p>
31
+ * <ul>
32
+ * <li>
33
+ * <p>If bucket versioning is not enabled, the operation permanently deletes the object.</p>
34
+ * </li>
35
+ * <li>
36
+ * <p>If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s <code>versionId</code> in the request. For more information about versioning-enabled buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html">Deleting object versions from a versioning-enabled bucket</a>.</p>
37
+ * </li>
38
+ * <li>
39
+ * <p>If bucket versioning is suspended, the operation removes the object that has a null <code>versionId</code>, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null <code>versionId</code>, and all versions of the object have a <code>versionId</code>, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a <code>versionId</code>, you must include the object’s <code>versionId</code> in the request. For more information about versioning-suspended buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html">Deleting objects from versioning-suspended buckets</a>.</p>
40
+ * </li>
41
+ * </ul>
42
42
  * <note>
43
43
  * <ul>
44
44
  * <li>
45
- * <p>S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the
46
- * <code>versionId</code> query parameter in the request.</p>
45
+ * <p>
46
+ * <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code>
47
+ * to the <code>versionId</code> query parameter in the request.</p>
47
48
  * </li>
48
49
  * <li>
49
- * <p>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>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
50
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
50
+ * <p>
51
+ * <b>Directory buckets</b> - 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>
52
+ * </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
53
+ * <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
51
54
  * <i>Amazon S3 User Guide</i>.</p>
52
55
  * </li>
53
- * <li>
54
- * <p>MFA delete is not supported by directory buckets.</p>
55
- * </li>
56
56
  * </ul>
57
57
  * </note>
58
+ * <p>To remove a specific version, you must use the <code>versionId</code> query parameter. Using this
59
+ * query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3
60
+ * sets the response header <code>x-amz-delete-marker</code> to true. </p>
61
+ * <p>If the object you want to delete is in a bucket where the bucket versioning
62
+ * configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request
63
+ * header in the DELETE <code>versionId</code> request. Requests that include
64
+ * <code>x-amz-mfa</code> must use HTTPS. For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a> in the <i>Amazon S3
65
+ * User Guide</i>. To see sample
66
+ * requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample
67
+ * Request</a>. </p>
68
+ * <note>
69
+ * <p>
70
+ * <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p>
71
+ * </note>
72
+ * <p>You can delete objects by explicitly calling DELETE Object or calling
73
+ * (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) to enable Amazon S3 to remove them for you. If you want to block
74
+ * users or accounts from removing or deleting objects from your bucket, you must deny them
75
+ * the <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and
76
+ * <code>s3:PutLifeCycleConfiguration</code> actions. </p>
77
+ * <note>
78
+ * <p>
79
+ * <b>Directory buckets</b> - S3 Lifecycle is not supported by directory buckets.</p>
80
+ * </note>
58
81
  * <dl>
59
82
  * <dt>Permissions</dt>
60
83
  * <dd>
61
84
  * <ul>
62
85
  * <li>
63
86
  * <p>
64
- * <b>General purpose bucket permissions</b> - The
65
- * following permissions are required in your policies when your
66
- * <code>DeleteObjects</code> request includes specific headers.</p>
87
+ * <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your
88
+ * <code>DeleteObjects</code> request includes specific headers.</p>
67
89
  * <ul>
68
90
  * <li>
69
91
  * <p>
70
92
  * <b>
71
93
  * <code>s3:DeleteObject</code>
72
- * </b>
73
- * - To delete an object from a bucket, you must always have the
74
- * <code>s3:DeleteObject</code> permission.</p>
75
- * <note>
76
- * <p>You can also use <a>PutBucketLifecycle</a> to delete
77
- * objects in Amazon S3.</p>
78
- * </note>
94
+ * </b> - To delete an object from a bucket, you must always have the <code>s3:DeleteObject</code> permission.</p>
79
95
  * </li>
80
96
  * <li>
81
97
  * <p>
82
98
  * <b>
83
99
  * <code>s3:DeleteObjectVersion</code>
84
- * </b> - To delete a specific version of an object from a
85
- * versioning-enabled bucket, you must have the
86
- * <code>s3:DeleteObjectVersion</code> permission.</p>
87
- * </li>
88
- * <li>
89
- * <p>If you want to block users or accounts from removing or deleting
90
- * objects from your bucket, you must deny them the
91
- * <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>,
92
- * and <code>s3:PutLifeCycleConfiguration</code> permissions.</p>
100
+ * </b> - To delete a specific version of an object from a versioning-enabled bucket, you must have the <code>s3:DeleteObjectVersion</code> permission.</p>
93
101
  * </li>
94
102
  * </ul>
95
103
  * </li>
96
104
  * <li>
97
105
  * <p>
98
- * <b>Directory buckets permissions</b> -
99
- * To grant access to this API operation on a directory bucket, we recommend
100
- * that you use the <a>CreateSession</a> API operation for
101
- * session-based authorization.</p>
106
+ * <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
107
+ * <code>CreateSession</code>
108
+ * </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use.
109
+ * Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html">
110
+ * <code>CreateSession</code>
111
+ * </a>.</p>
102
112
  * </li>
103
113
  * </ul>
104
114
  * </dd>
@@ -106,7 +116,7 @@ declare const DeleteObjectCommand_base: {
106
116
  * <dd>
107
117
  * <p>
108
118
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
109
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
119
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
110
120
  * </dd>
111
121
  * </dl>
112
122
  * <p>The following action is related to <code>DeleteObject</code>:</p>
@@ -155,28 +165,28 @@ declare const DeleteObjectCommand_base: {
155
165
  * <p>Base exception class for all service exceptions from S3 service.</p>
156
166
  *
157
167
  * @public
158
- * @example To delete an object
168
+ * @example To delete an object (from a non-versioned bucket)
159
169
  * ```javascript
160
- * // The following example deletes an object from an S3 bucket.
170
+ * // The following example deletes an object from a non-versioned bucket.
161
171
  * const input = {
162
- * "Bucket": "examplebucket",
163
- * "Key": "objectkey.jpg"
172
+ * "Bucket": "ExampleBucket",
173
+ * "Key": "HappyFace.jpg"
164
174
  * };
165
175
  * const command = new DeleteObjectCommand(input);
166
176
  * await client.send(command);
167
- * // example id: to-delete-an-object-1472850136595
177
+ * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
168
178
  * ```
169
179
  *
170
- * @example To delete an object (from a non-versioned bucket)
180
+ * @example To delete an object
171
181
  * ```javascript
172
- * // The following example deletes an object from a non-versioned bucket.
182
+ * // The following example deletes an object from an S3 bucket.
173
183
  * const input = {
174
- * "Bucket": "ExampleBucket",
175
- * "Key": "HappyFace.jpg"
184
+ * "Bucket": "examplebucket",
185
+ * "Key": "objectkey.jpg"
176
186
  * };
177
187
  * const command = new DeleteObjectCommand(input);
178
188
  * await client.send(command);
179
- * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
189
+ * // example id: to-delete-an-object-1472850136595
180
190
  * ```
181
191
  *
182
192
  */
@@ -47,8 +47,9 @@ declare const DeleteObjectsCommand_base: {
47
47
  * <li>
48
48
  * <p>
49
49
  * <b>Directory buckets</b> -
50
- * 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>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
51
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
50
+ * 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>
51
+ * </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
52
+ * <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
52
53
  * <i>Amazon S3 User Guide</i>.</p>
53
54
  * </li>
54
55
  * </ul>
@@ -133,7 +134,7 @@ declare const DeleteObjectsCommand_base: {
133
134
  * <dd>
134
135
  * <p>
135
136
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
136
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
137
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
137
138
  * </dd>
138
139
  * </dl>
139
140
  * <p>The following operations are related to <code>DeleteObjects</code>:</p>
@@ -73,7 +73,7 @@ declare const GetBucketEncryptionCommand_base: {
73
73
  * <dt>HTTP Host header syntax</dt>
74
74
  * <dd>
75
75
  * <p>
76
- * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
76
+ * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
77
77
  * </dd>
78
78
  * </dl>
79
79
  * <p>The following operations are related to <code>GetBucketEncryption</code>:</p>
@@ -74,9 +74,10 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
74
74
  * <i>Amazon S3 User Guide</i>.</p>
75
75
  * <note>
76
76
  * <p>
77
- * <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>
77
+ * <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>
78
78
  * </code>. Virtual-hosted-style requests aren't supported.
79
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
79
+ * 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
80
+ * <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
80
81
  * <i>Amazon S3 User Guide</i>.</p>
81
82
  * </note>
82
83
  * </li>
@@ -30,9 +30,10 @@ declare const GetBucketPolicyCommand_base: {
30
30
  * <p>Returns the policy of a specified bucket.</p>
31
31
  * <note>
32
32
  * <p>
33
- * <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>
33
+ * <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>
34
34
  * </code>. Virtual-hosted-style requests aren't supported.
35
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
35
+ * 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
36
+ * <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
36
37
  * <i>Amazon S3 User Guide</i>.</p>
37
38
  * </note>
38
39
  * <dl>
@@ -87,7 +88,7 @@ declare const GetBucketPolicyCommand_base: {
87
88
  * <dt>HTTP Host header syntax</dt>
88
89
  * <dd>
89
90
  * <p>
90
- * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
91
+ * <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
91
92
  * </dd>
92
93
  * </dl>
93
94
  * <p>The following action is related to <code>GetBucketPolicy</code>:</p>
@@ -36,8 +36,9 @@ declare const GetObjectAttributesCommand_base: {
36
36
  * <note>
37
37
  * <p>
38
38
  * <b>Directory buckets</b> -
39
- * 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>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
40
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
39
+ * 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>
40
+ * </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
41
+ * <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
41
42
  * <i>Amazon S3 User Guide</i>.</p>
42
43
  * </note>
43
44
  * <dl>
@@ -192,7 +193,7 @@ declare const GetObjectAttributesCommand_base: {
192
193
  * <dd>
193
194
  * <p>
194
195
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
195
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
196
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
196
197
  * </dd>
197
198
  * </dl>
198
199
  * <p>The following actions are related to <code>GetObjectAttributes</code>:</p>
@@ -42,8 +42,9 @@ declare const GetObjectCommand_base: {
42
42
  * Header Bucket Specification</a> in the <i>Amazon S3 User Guide</i>.</p>
43
43
  * <p>
44
44
  * <b>Directory buckets</b> -
45
- * Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket--use1-az5--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
46
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
45
+ * Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket--use1-az5--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent 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>
46
+ * </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
47
+ * <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
47
48
  * <i>Amazon S3 User Guide</i>.</p>
48
49
  * <dl>
49
50
  * <dt>Permissions</dt>
@@ -187,7 +188,7 @@ declare const GetObjectCommand_base: {
187
188
  * <dd>
188
189
  * <p>
189
190
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
190
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
191
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
191
192
  * </dd>
192
193
  * </dl>
193
194
  * <p>The following operations are related to <code>GetObject</code>:</p>
@@ -301,53 +302,53 @@ declare const GetObjectCommand_base: {
301
302
  * <p>Base exception class for all service exceptions from S3 service.</p>
302
303
  *
303
304
  * @public
304
- * @example To retrieve a byte range of an object
305
+ * @example To retrieve an object
305
306
  * ```javascript
306
- * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
307
+ * // The following example retrieves an object for an S3 bucket.
307
308
  * const input = {
308
309
  * "Bucket": "examplebucket",
309
- * "Key": "SampleFile.txt",
310
- * "Range": "bytes=0-9"
310
+ * "Key": "HappyFace.jpg"
311
311
  * };
312
312
  * const command = new GetObjectCommand(input);
313
313
  * const response = await client.send(command);
314
314
  * /* response ==
315
315
  * {
316
316
  * "AcceptRanges": "bytes",
317
- * "ContentLength": "10",
318
- * "ContentRange": "bytes 0-9/43",
319
- * "ContentType": "text/plain",
320
- * "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
321
- * "LastModified": "2014-10-09T22:57:28.000Z",
317
+ * "ContentLength": "3191",
318
+ * "ContentType": "image/jpeg",
319
+ * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
320
+ * "LastModified": "2016-12-15T01:19:41.000Z",
322
321
  * "Metadata": {},
322
+ * "TagCount": 2,
323
323
  * "VersionId": "null"
324
324
  * }
325
325
  * *\/
326
- * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
326
+ * // example id: to-retrieve-an-object-1481827837012
327
327
  * ```
328
328
  *
329
- * @example To retrieve an object
329
+ * @example To retrieve a byte range of an object
330
330
  * ```javascript
331
- * // The following example retrieves an object for an S3 bucket.
331
+ * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
332
332
  * const input = {
333
333
  * "Bucket": "examplebucket",
334
- * "Key": "HappyFace.jpg"
334
+ * "Key": "SampleFile.txt",
335
+ * "Range": "bytes=0-9"
335
336
  * };
336
337
  * const command = new GetObjectCommand(input);
337
338
  * const response = await client.send(command);
338
339
  * /* response ==
339
340
  * {
340
341
  * "AcceptRanges": "bytes",
341
- * "ContentLength": "3191",
342
- * "ContentType": "image/jpeg",
343
- * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
344
- * "LastModified": "2016-12-15T01:19:41.000Z",
342
+ * "ContentLength": "10",
343
+ * "ContentRange": "bytes 0-9/43",
344
+ * "ContentType": "text/plain",
345
+ * "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
346
+ * "LastModified": "2014-10-09T22:57:28.000Z",
345
347
  * "Metadata": {},
346
- * "TagCount": 2,
347
348
  * "VersionId": "null"
348
349
  * }
349
350
  * *\/
350
- * // example id: to-retrieve-an-object-1481827837012
351
+ * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
351
352
  * ```
352
353
  *
353
354
  */
@@ -96,12 +96,13 @@ declare const GetObjectTaggingCommand_base: {
96
96
  * <p>Base exception class for all service exceptions from S3 service.</p>
97
97
  *
98
98
  * @public
99
- * @example To retrieve tag set of an object
99
+ * @example To retrieve tag set of a specific object version
100
100
  * ```javascript
101
- * // The following example retrieves tag set of an object.
101
+ * // The following example retrieves tag set of an object. The request specifies object version.
102
102
  * const input = {
103
103
  * "Bucket": "examplebucket",
104
- * "Key": "HappyFace.jpg"
104
+ * "Key": "exampleobject",
105
+ * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
105
106
  * };
106
107
  * const command = new GetObjectTaggingCommand(input);
107
108
  * const response = await client.send(command);
@@ -109,27 +110,22 @@ declare const GetObjectTaggingCommand_base: {
109
110
  * {
110
111
  * "TagSet": [
111
112
  * {
112
- * "Key": "Key4",
113
- * "Value": "Value4"
114
- * },
115
- * {
116
- * "Key": "Key3",
117
- * "Value": "Value3"
113
+ * "Key": "Key1",
114
+ * "Value": "Value1"
118
115
  * }
119
116
  * ],
120
- * "VersionId": "null"
117
+ * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
121
118
  * }
122
119
  * *\/
123
- * // example id: to-retrieve-tag-set-of-an-object-1481833847896
120
+ * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
124
121
  * ```
125
122
  *
126
- * @example To retrieve tag set of a specific object version
123
+ * @example To retrieve tag set of an object
127
124
  * ```javascript
128
- * // The following example retrieves tag set of an object. The request specifies object version.
125
+ * // The following example retrieves tag set of an object.
129
126
  * const input = {
130
127
  * "Bucket": "examplebucket",
131
- * "Key": "exampleobject",
132
- * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
128
+ * "Key": "HappyFace.jpg"
133
129
  * };
134
130
  * const command = new GetObjectTaggingCommand(input);
135
131
  * const response = await client.send(command);
@@ -137,14 +133,18 @@ declare const GetObjectTaggingCommand_base: {
137
133
  * {
138
134
  * "TagSet": [
139
135
  * {
140
- * "Key": "Key1",
141
- * "Value": "Value1"
136
+ * "Key": "Key4",
137
+ * "Value": "Value4"
138
+ * },
139
+ * {
140
+ * "Key": "Key3",
141
+ * "Value": "Value3"
142
142
  * }
143
143
  * ],
144
- * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
144
+ * "VersionId": "null"
145
145
  * }
146
146
  * *\/
147
- * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
147
+ * // example id: to-retrieve-tag-set-of-an-object-1481833847896
148
148
  * ```
149
149
  *
150
150
  */
@@ -88,9 +88,10 @@ declare const HeadBucketCommand_base: {
88
88
  * <dd>
89
89
  * <p>
90
90
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
91
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
91
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
92
92
  * <note>
93
- * <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>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
93
+ * <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
94
+ * <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
94
95
  * <i>Amazon S3 User Guide</i>.</p>
95
96
  * </note>
96
97
  * </dd>
@@ -108,7 +109,7 @@ declare const HeadBucketCommand_base: {
108
109
  * const command = new HeadBucketCommand(input);
109
110
  * const response = await client.send(command);
110
111
  * // { // HeadBucketOutput
111
- * // BucketLocationType: "AvailabilityZone",
112
+ * // BucketLocationType: "AvailabilityZone" || "LocalZone",
112
113
  * // BucketLocationName: "STRING_VALUE",
113
114
  * // BucketRegion: "STRING_VALUE",
114
115
  * // AccessPointAlias: true || false,
@@ -168,10 +168,11 @@ declare const HeadObjectCommand_base: {
168
168
  * <dd>
169
169
  * <p>
170
170
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
171
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
171
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
172
172
  * <note>
173
- * <p>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>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
174
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
173
+ * <p>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>
174
+ * </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
175
+ * <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
175
176
  * <i>Amazon S3 User Guide</i>.</p>
176
177
  * </note>
177
178
  * </dd>
@@ -31,9 +31,10 @@ declare const ListDirectoryBucketsCommand_base: {
31
31
  * request. For more information about directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
32
32
  * <note>
33
33
  * <p>
34
- * <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>
34
+ * <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>
35
35
  * </code>. Virtual-hosted-style requests aren't supported.
36
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
36
+ * 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
37
+ * <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
37
38
  * <i>Amazon S3 User Guide</i>.</p>
38
39
  * </note>
39
40
  * <dl>
@@ -67,8 +67,9 @@ declare const ListMultipartUploadsCommand_base: {
67
67
  * <note>
68
68
  * <p>
69
69
  * <b>Directory buckets</b> -
70
- * 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>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
71
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
70
+ * 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>
71
+ * </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
72
+ * <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
72
73
  * <i>Amazon S3 User Guide</i>.</p>
73
74
  * </note>
74
75
  * <dl>
@@ -129,7 +130,7 @@ declare const ListMultipartUploadsCommand_base: {
129
130
  * <dd>
130
131
  * <p>
131
132
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
132
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
133
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
133
134
  * </dd>
134
135
  * </dl>
135
136
  * <p>The following operations are related to <code>ListMultipartUploads</code>:</p>
@@ -51,8 +51,9 @@ declare const ListObjectsV2Command_base: {
51
51
  * <li>
52
52
  * <p>
53
53
  * <b>Directory buckets</b> -
54
- * 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>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
55
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
54
+ * 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>
55
+ * </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
56
+ * <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
57
  * <i>Amazon S3 User Guide</i>.</p>
57
58
  * </li>
58
59
  * </ul>
@@ -103,7 +104,7 @@ declare const ListObjectsV2Command_base: {
103
104
  * <dd>
104
105
  * <p>
105
106
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
106
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
107
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
107
108
  * </dd>
108
109
  * </dl>
109
110
  * <important>
@@ -43,8 +43,9 @@ declare const ListPartsCommand_base: {
43
43
  * <note>
44
44
  * <p>
45
45
  * <b>Directory buckets</b> -
46
- * 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>az_id</i>.<i>region</i>.amazonaws.com/<i>key-name</i>
47
- * </code>. Path-style requests are not supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html">Regional and Zonal endpoints</a> in the
46
+ * 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>
47
+ * </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
48
+ * <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
48
49
  * <i>Amazon S3 User Guide</i>.</p>
49
50
  * </note>
50
51
  * <dl>
@@ -78,7 +79,7 @@ declare const ListPartsCommand_base: {
78
79
  * <dd>
79
80
  * <p>
80
81
  * <b>Directory buckets </b> - The HTTP Host header syntax is <code>
81
- * <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>.</p>
82
+ * <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p>
82
83
  * </dd>
83
84
  * </dl>
84
85
  * <p>The following operations are related to <code>ListParts</code>:</p>