@aws-sdk/client-s3 3.413.0 → 3.417.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 (39) hide show
  1. package/dist-cjs/runtimeExtensions.js +3 -0
  2. package/dist-es/runtimeExtensions.js +3 -0
  3. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +6 -6
  4. package/dist-types/commands/CopyObjectCommand.d.ts +90 -76
  5. package/dist-types/commands/CreateBucketCommand.d.ts +63 -37
  6. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +14 -12
  7. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +3 -3
  8. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +3 -2
  9. package/dist-types/commands/DeleteObjectsCommand.d.ts +2 -1
  10. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +2 -1
  11. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +2 -1
  12. package/dist-types/commands/GetBucketPolicyCommand.d.ts +5 -4
  13. package/dist-types/commands/GetObjectAttributesCommand.d.ts +15 -12
  14. package/dist-types/commands/GetObjectCommand.d.ts +44 -37
  15. package/dist-types/commands/HeadBucketCommand.d.ts +3 -3
  16. package/dist-types/commands/HeadObjectCommand.d.ts +11 -11
  17. package/dist-types/commands/PutBucketAclCommand.d.ts +41 -35
  18. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +2 -1
  19. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -8
  20. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +5 -4
  21. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +18 -18
  22. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +29 -25
  23. package/dist-types/commands/PutBucketLoggingCommand.d.ts +12 -10
  24. package/dist-types/commands/PutBucketPolicyCommand.d.ts +5 -4
  25. package/dist-types/commands/PutBucketReplicationCommand.d.ts +23 -17
  26. package/dist-types/commands/PutBucketTaggingCommand.d.ts +18 -35
  27. package/dist-types/commands/PutBucketVersioningCommand.d.ts +6 -6
  28. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -0
  29. package/dist-types/commands/PutObjectAclCommand.d.ts +39 -36
  30. package/dist-types/commands/PutObjectTaggingCommand.d.ts +21 -58
  31. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
  32. package/dist-types/commands/RestoreObjectCommand.d.ts +93 -91
  33. package/dist-types/commands/SelectObjectContentCommand.d.ts +46 -40
  34. package/dist-types/commands/UploadPartCopyCommand.d.ts +16 -14
  35. package/dist-types/extensionConfiguration.d.ts +2 -1
  36. package/dist-types/models/models_0.d.ts +173 -110
  37. package/dist-types/models/models_1.d.ts +25 -13
  38. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  39. package/package.json +5 -4
@@ -1,17 +1,20 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.resolveRuntimeExtensions = void 0;
4
+ const region_config_resolver_1 = require("@aws-sdk/region-config-resolver");
4
5
  const protocol_http_1 = require("@smithy/protocol-http");
5
6
  const smithy_client_1 = require("@smithy/smithy-client");
6
7
  const asPartial = (t) => t;
7
8
  const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
8
9
  const extensionConfiguration = {
10
+ ...asPartial((0, region_config_resolver_1.getAwsRegionExtensionConfiguration)(runtimeConfig)),
9
11
  ...asPartial((0, smithy_client_1.getDefaultExtensionConfiguration)(runtimeConfig)),
10
12
  ...asPartial((0, protocol_http_1.getHttpHandlerExtensionConfiguration)(runtimeConfig)),
11
13
  };
12
14
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
13
15
  return {
14
16
  ...runtimeConfig,
17
+ ...(0, region_config_resolver_1.resolveAwsRegionExtensionConfiguration)(extensionConfiguration),
15
18
  ...(0, smithy_client_1.resolveDefaultRuntimeConfig)(extensionConfiguration),
16
19
  ...(0, protocol_http_1.resolveHttpHandlerRuntimeConfig)(extensionConfiguration),
17
20
  };
@@ -1,14 +1,17 @@
1
+ import { getAwsRegionExtensionConfiguration, resolveAwsRegionExtensionConfiguration, } from "@aws-sdk/region-config-resolver";
1
2
  import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig } from "@smithy/protocol-http";
2
3
  import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
3
4
  const asPartial = (t) => t;
4
5
  export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
5
6
  const extensionConfiguration = {
7
+ ...asPartial(getAwsRegionExtensionConfiguration(runtimeConfig)),
6
8
  ...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
7
9
  ...asPartial(getHttpHandlerExtensionConfiguration(runtimeConfig)),
8
10
  };
9
11
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
10
12
  return {
11
13
  ...runtimeConfig,
14
+ ...resolveAwsRegionExtensionConfiguration(extensionConfiguration),
12
15
  ...resolveDefaultRuntimeConfig(extensionConfiguration),
13
16
  ...resolveHttpHandlerRuntimeConfig(extensionConfiguration),
14
17
  };
@@ -26,12 +26,12 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
26
26
  * <p>Completes a multipart upload by assembling previously uploaded parts.</p>
27
27
  * <p>You first initiate the multipart upload and then upload all parts using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
28
28
  * operation. After successfully uploading all relevant parts of an upload, you call this
29
- * action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the
30
- * parts in ascending order by part number to create a new object. In the Complete Multipart
31
- * Upload request, you must provide the parts list. You must ensure that the parts list is
32
- * complete. This action concatenates the parts that you provide in the list. For each part in
33
- * the list, you must provide the part number and the <code>ETag</code> value, returned after
34
- * that part was uploaded.</p>
29
+ * action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts
30
+ * in ascending order by part number to create a new object. In the Complete Multipart Upload
31
+ * request, you must provide the parts list. You must ensure that the parts list is complete.
32
+ * This action concatenates the parts that you provide in the list. For each part in the list,
33
+ * you must provide the part number and the <code>ETag</code> value, returned after that part
34
+ * was uploaded.</p>
35
35
  * <p>Processing of a Complete Multipart Upload request could take several minutes to
36
36
  * complete. After Amazon S3 begins processing the request, it sends an HTTP response header that
37
37
  * specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white
@@ -67,29 +67,31 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
67
67
  * <dl>
68
68
  * <dt>Metadata</dt>
69
69
  * <dd>
70
- * <p>When copying an object, you can preserve all metadata (the default) or specify new metadata.
71
- * However, the access control list (ACL) is not preserved and is set to private for the user making the request. To
72
- * override the default ACL setting, specify a new ACL when generating a copy request. For
73
- * more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. </p>
74
- * <p>To specify whether you want the object metadata copied from the source object or
75
- * replaced with metadata provided in the request, you can optionally add the
76
- * <code>x-amz-metadata-directive</code> header. When you grant permissions, you can use
77
- * the <code>s3:x-amz-metadata-directive</code> condition key to enforce certain metadata
78
- * behavior when objects are uploaded. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying Conditions in a
79
- * Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list of
80
- * Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, Resources, and Condition Keys for
81
- * Amazon S3</a>.</p>
70
+ * <p>When copying an object, you can preserve all metadata (the default) or specify
71
+ * new metadata. However, the access control list (ACL) is not preserved and is set
72
+ * to private for the user making the request. To override the default ACL setting,
73
+ * specify a new ACL when generating a copy request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using
74
+ * ACLs</a>. </p>
75
+ * <p>To specify whether you want the object metadata copied from the source object
76
+ * or replaced with metadata provided in the request, you can optionally add the
77
+ * <code>x-amz-metadata-directive</code> header. When you grant permissions, you
78
+ * can use the <code>s3:x-amz-metadata-directive</code> condition key to enforce
79
+ * certain metadata behavior when objects are uploaded. For more information, see
80
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying Conditions in a
81
+ * Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list
82
+ * of Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, Resources, and Condition
83
+ * Keys for Amazon S3</a>.</p>
82
84
  * <note>
83
85
  * <p>
84
- * <code>x-amz-website-redirect-location</code> is unique to each object and must be
85
- * specified in the request headers to copy the value.</p>
86
+ * <code>x-amz-website-redirect-location</code> is unique to each object and
87
+ * must be specified in the request headers to copy the value.</p>
86
88
  * </note>
87
89
  * </dd>
88
90
  * <dt>x-amz-copy-source-if Headers</dt>
89
91
  * <dd>
90
- * <p>To only copy an object under certain conditions, such as whether the <code>Etag</code>
91
- * matches or whether the object was modified before or after a specified date, use the
92
- * following request parameters:</p>
92
+ * <p>To only copy an object under certain conditions, such as whether the
93
+ * <code>Etag</code> matches or whether the object was modified before or after a
94
+ * specified date, use the following request parameters:</p>
93
95
  * <ul>
94
96
  * <li>
95
97
  * <p>
@@ -113,12 +115,14 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
113
115
  * </li>
114
116
  * </ul>
115
117
  * <p> If both the <code>x-amz-copy-source-if-match</code> and
116
- * <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request
117
- * and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the data:</p>
118
+ * <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the
119
+ * request and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the
120
+ * data:</p>
118
121
  * <ul>
119
122
  * <li>
120
123
  * <p>
121
- * <code>x-amz-copy-source-if-match</code> condition evaluates to true</p>
124
+ * <code>x-amz-copy-source-if-match</code> condition evaluates to
125
+ * true</p>
122
126
  * </li>
123
127
  * <li>
124
128
  * <p>
@@ -127,13 +131,14 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
127
131
  * </li>
128
132
  * </ul>
129
133
  * <p>If both the <code>x-amz-copy-source-if-none-match</code> and
130
- * <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and
131
- * evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response
132
- * code:</p>
134
+ * <code>x-amz-copy-source-if-modified-since</code> headers are present in the
135
+ * request and evaluate as follows, Amazon S3 returns the <code>412 Precondition
136
+ * Failed</code> response code:</p>
133
137
  * <ul>
134
138
  * <li>
135
139
  * <p>
136
- * <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p>
140
+ * <code>x-amz-copy-source-if-none-match</code> condition evaluates to
141
+ * false</p>
137
142
  * </li>
138
143
  * <li>
139
144
  * <p>
@@ -143,13 +148,13 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
143
148
  * </ul>
144
149
  * <note>
145
150
  * <p>All headers with the <code>x-amz-</code> prefix, including
146
- * <code>x-amz-copy-source</code>, must be signed.</p>
151
+ * <code>x-amz-copy-source</code>, must be signed.</p>
147
152
  * </note>
148
153
  * </dd>
149
154
  * <dt>Server-side encryption</dt>
150
155
  * <dd>
151
- * <p>Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When
152
- * copying an object, if you don't specify encryption information in your copy
156
+ * <p>Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket.
157
+ * When copying an object, if you don't specify encryption information in your copy
153
158
  * request, the encryption setting of the target object is set to the default
154
159
  * encryption configuration of the destination bucket. By default, all buckets have a
155
160
  * base level of encryption configuration that uses server-side encryption with Amazon S3
@@ -159,71 +164,80 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
159
164
  * server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses
160
165
  * the corresponding KMS key, or a customer-provided key to encrypt the target
161
166
  * object copy.</p>
162
- * <p>When you perform a <code>CopyObject</code> operation, if you want to use a different type
163
- * of encryption setting for the target object, you can use other appropriate
164
- * encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed
165
- * key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it
166
- * writes your data to disks in its data centers and decrypts the data when you access it. If the
167
- * encryption setting in your request is different from the default encryption configuration
168
- * of the destination bucket, the encryption setting in your request takes precedence. If the
169
- * source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
170
- * encryption information in your request so that Amazon S3 can decrypt the object for copying. For
171
- * more information about server-side encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using Server-Side
172
- * Encryption</a>.</p>
167
+ * <p>When you perform a <code>CopyObject</code> operation, if you want to use a
168
+ * different type of encryption setting for the target object, you can use other
169
+ * appropriate encryption-related headers to encrypt the target object with a
170
+ * KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side
171
+ * encryption, Amazon S3 encrypts your data as it writes your data to disks in its data
172
+ * centers and decrypts the data when you access it. If the encryption setting in
173
+ * your request is different from the default encryption configuration of the
174
+ * destination bucket, the encryption setting in your request takes precedence. If
175
+ * the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the
176
+ * necessary encryption information in your request so that Amazon S3 can decrypt the
177
+ * object for copying. For more information about server-side encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using
178
+ * Server-Side Encryption</a>.</p>
173
179
  * <p>If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the
174
180
  * object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
175
181
  * <i>Amazon S3 User Guide</i>.</p>
176
182
  * </dd>
177
- * <dt>Access Control List (ACL)-Specific Request
178
- * Headers</dt>
183
+ * <dt>Access Control List (ACL)-Specific Request Headers</dt>
179
184
  * <dd>
180
- * <p>When copying an object, you can optionally use headers to grant ACL-based permissions.
181
- * By default, all objects are private. Only the owner has full access control. When adding a
182
- * new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups
183
- * that are defined by Amazon S3. These permissions are then added to the ACL on the object. For more
184
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST
185
- * API</a>. </p>
186
- * <p>If the bucket that you're copying objects to uses the bucket owner enforced setting for
187
- * S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use
188
- * this setting only accept <code>PUT</code> requests that don't specify an ACL or <code>PUT</code> requests that
189
- * specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
190
- * canned ACL or an equivalent form of this ACL expressed in the XML format.</p>
191
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of
192
- * objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
185
+ * <p>When copying an object, you can optionally use headers to grant ACL-based
186
+ * permissions. By default, all objects are private. Only the owner has full access
187
+ * control. When adding a new object, you can grant permissions to individual
188
+ * Amazon Web Services accounts or to predefined groups that are defined by Amazon S3. These permissions
189
+ * are then added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
190
+ * List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST
191
+ * API</a>. </p>
192
+ * <p>If the bucket that you're copying objects to uses the bucket owner enforced
193
+ * setting for S3 Object Ownership, ACLs are disabled and no longer affect
194
+ * permissions. Buckets that use this setting only accept <code>PUT</code> requests
195
+ * that don't specify an ACL or <code>PUT</code> requests that specify bucket owner
196
+ * full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL
197
+ * or an equivalent form of this ACL expressed in the XML format.</p>
198
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling
199
+ * ownership of objects and disabling ACLs</a> in the
200
+ * <i>Amazon S3 User Guide</i>.</p>
193
201
  * <note>
194
- * <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all
195
- * objects written to the bucket by any account will be owned by the bucket owner.</p>
202
+ * <p>If your bucket uses the bucket owner enforced setting for Object Ownership,
203
+ * all objects written to the bucket by any account will be owned by the bucket
204
+ * owner.</p>
196
205
  * </note>
197
206
  * </dd>
198
207
  * <dt>Checksums</dt>
199
208
  * <dd>
200
- * <p>When copying an object, if it has a checksum, that checksum will be copied to the new
201
- * object by default. When you copy the object over, you can optionally specify a different
202
- * checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> header.</p>
209
+ * <p>When copying an object, if it has a checksum, that checksum will be copied to
210
+ * the new object by default. When you copy the object over, you can optionally
211
+ * specify a different checksum algorithm to use with the
212
+ * <code>x-amz-checksum-algorithm</code> header.</p>
203
213
  * </dd>
204
214
  * <dt>Storage Class Options</dt>
205
215
  * <dd>
206
- * <p>You can use the <code>CopyObject</code> action to change the storage class of an object
207
- * that is already stored in Amazon S3 by using the <code>StorageClass</code> parameter. For more
208
- * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the
209
- * <i>Amazon S3 User Guide</i>.</p>
210
- * <p>If the source object's storage class is GLACIER, you must restore a copy of
211
- * this object before you can use it as a source object for the copy operation. For
212
- * more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. For
213
- * more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying
214
- * Objects</a>.</p>
216
+ * <p>You can use the <code>CopyObject</code> action to change the storage class of
217
+ * an object that is already stored in Amazon S3 by using the <code>StorageClass</code>
218
+ * parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in
219
+ * the <i>Amazon S3 User Guide</i>.</p>
220
+ * <p>If the source object's storage class is GLACIER or
221
+ * DEEP_ARCHIVE, or the object's storage class is
222
+ * INTELLIGENT_TIERING and it's <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition"> S3 Intelligent-Tiering access tier</a> is
223
+ * Archive Access or Deep Archive Access, you must restore a copy of this object
224
+ * before you can use it as a source object for the copy operation. For more
225
+ * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. For
226
+ * more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying
227
+ * Objects</a>.</p>
215
228
  * </dd>
216
229
  * <dt>Versioning</dt>
217
230
  * <dd>
218
- * <p>By default, <code>x-amz-copy-source</code> header identifies the current version of an object
219
- * to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was
220
- * deleted. To copy a different version, use the <code>versionId</code> subresource.</p>
221
- * <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for
222
- * the object being copied. This version ID is different from the version ID of the source
223
- * object. Amazon S3 returns the version ID of the copied object in the
224
- * <code>x-amz-version-id</code> response header in the response.</p>
225
- * <p>If you do not enable versioning or suspend it on the target bucket, the version ID that
226
- * Amazon S3 generates is always null.</p>
231
+ * <p>By default, <code>x-amz-copy-source</code> header identifies the current
232
+ * version of an object to copy. If the current version is a delete marker, Amazon S3
233
+ * behaves as if the object was deleted. To copy a different version, use the
234
+ * <code>versionId</code> subresource.</p>
235
+ * <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version
236
+ * ID for the object being copied. This version ID is different from the version ID
237
+ * of the source object. Amazon S3 returns the version ID of the copied object in the
238
+ * <code>x-amz-version-id</code> response header in the response.</p>
239
+ * <p>If you do not enable versioning or suspend it on the target bucket, the version
240
+ * ID that Amazon S3 generates is always null.</p>
227
241
  * </dd>
228
242
  * </dl>
229
243
  * <p>The following operations are related to <code>CopyObject</code>:</p>
@@ -31,69 +31,95 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
31
31
  * rules</a>.</p>
32
32
  * <p>If you want to create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">Create Bucket</a>. </p>
33
33
  * <p>By default, the bucket is created in the US East (N. Virginia) Region. You can
34
- * optionally specify a Region in the request body. You might choose a Region to optimize
35
- * latency, minimize costs, or address regulatory requirements. For example, if you reside in
36
- * Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)
37
- * Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a
34
+ * optionally specify a Region in the request body. To constrain the bucket creation to a
35
+ * specific Region, you can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketConfiguration.html">
36
+ * <code>LocationConstraint</code>
37
+ * </a> condition key. You might choose a Region to
38
+ * optimize latency, minimize costs, or address regulatory requirements. For example, if you
39
+ * reside in Europe, you will probably find it advantageous to create buckets in the Europe
40
+ * (Ireland) Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a
38
41
  * bucket</a>.</p>
39
42
  * <note>
40
43
  * <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint,
41
- * the request goes to the <code>us-east-1</code> Region. Accordingly, the signature calculations in
42
- * Signature Version 4 must use <code>us-east-1</code> as the Region, even if the location constraint in
43
- * the request specifies another Region where the bucket is to be created. If you create a
44
- * bucket in a Region other than US East (N. Virginia), your application must be able to
45
- * handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
46
- * buckets</a>.</p>
44
+ * the request goes to the <code>us-east-1</code> Region. Accordingly, the signature
45
+ * calculations in Signature Version 4 must use <code>us-east-1</code> as the Region, even
46
+ * if the location constraint in the request specifies another Region where the bucket is
47
+ * to be created. If you create a bucket in a Region other than US East (N. Virginia), your
48
+ * application must be able to handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
49
+ * buckets</a>.</p>
47
50
  * </note>
48
51
  * <dl>
49
52
  * <dt>Permissions</dt>
50
53
  * <dd>
51
- * <p>In addition to <code>s3:CreateBucket</code>, the following permissions are required when
52
- * your <code>CreateBucket</code> request includes specific headers:</p>
54
+ * <p>In addition to <code>s3:CreateBucket</code>, the following permissions are
55
+ * required when your <code>CreateBucket</code> request includes specific
56
+ * headers:</p>
53
57
  * <ul>
54
58
  * <li>
55
59
  * <p>
56
- * <b>Access control lists (ACLs)</b> - If your <code>CreateBucket</code> request
57
- * specifies access control list (ACL) permissions and the ACL is public-read, public-read-write,
58
- * authenticated-read, or if you specify access permissions explicitly through any other
59
- * ACL, both <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions
60
- * are needed. If the ACL for the <code>CreateBucket</code> request is private or if the request doesn't
61
- * specify any ACLs, only <code>s3:CreateBucket</code> permission is needed. </p>
60
+ * <b>Access control lists (ACLs)</b> - If your
61
+ * <code>CreateBucket</code> request specifies access control list (ACL)
62
+ * permissions and the ACL is public-read, public-read-write,
63
+ * authenticated-read, or if you specify access permissions explicitly through
64
+ * any other ACL, both <code>s3:CreateBucket</code> and
65
+ * <code>s3:PutBucketAcl</code> permissions are needed. If the ACL for the
66
+ * <code>CreateBucket</code> request is private or if the request doesn't
67
+ * specify any ACLs, only <code>s3:CreateBucket</code> permission is needed.
68
+ * </p>
62
69
  * </li>
63
70
  * <li>
64
71
  * <p>
65
- * <b>Object Lock</b> - If <code>ObjectLockEnabledForBucket</code> is set to true in your
66
- * <code>CreateBucket</code> request,
67
- * <code>s3:PutBucketObjectLockConfiguration</code> and
68
- * <code>s3:PutBucketVersioning</code> permissions are required.</p>
72
+ * <b>Object Lock</b> - If
73
+ * <code>ObjectLockEnabledForBucket</code> is set to true in your
74
+ * <code>CreateBucket</code> request,
75
+ * <code>s3:PutBucketObjectLockConfiguration</code> and
76
+ * <code>s3:PutBucketVersioning</code> permissions are required.</p>
69
77
  * </li>
70
78
  * <li>
71
79
  * <p>
72
- * <b>S3 Object Ownership</b> - If your <code>CreateBucket</code> request includes the <code>x-amz-object-ownership</code> header, then the
73
- * <code>s3:PutBucketOwnershipControls</code> permission is required. By default, <code>ObjectOwnership</code> is set to <code>BucketOWnerEnforced</code> and ACLs are disabled. We recommend keeping
74
- * ACLs disabled, except in uncommon use cases where you must control access for each object individually. If you want to change the <code>ObjectOwnership</code> setting, you can use the
75
- * <code>x-amz-object-ownership</code> header in your <code>CreateBucket</code> request to set the <code>ObjectOwnership</code> setting of your choice.
76
- * For more information about S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object
77
- * ownership </a> in the <i>Amazon S3 User Guide</i>.</p>
80
+ * <b>S3 Object Ownership</b> - If your
81
+ * <code>CreateBucket</code> request includes the
82
+ * <code>x-amz-object-ownership</code> header, then the
83
+ * <code>s3:PutBucketOwnershipControls</code> permission is required. By
84
+ * default, <code>ObjectOwnership</code> is set to
85
+ * <code>BucketOWnerEnforced</code> and ACLs are disabled. We recommend
86
+ * keeping ACLs disabled, except in uncommon use cases where you must control
87
+ * access for each object individually. If you want to change the
88
+ * <code>ObjectOwnership</code> setting, you can use the
89
+ * <code>x-amz-object-ownership</code> header in your
90
+ * <code>CreateBucket</code> request to set the <code>ObjectOwnership</code>
91
+ * setting of your choice. For more information about S3 Object Ownership, see
92
+ * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling
93
+ * object ownership </a> in the
94
+ * <i>Amazon S3 User Guide</i>.</p>
78
95
  * </li>
79
96
  * <li>
80
97
  * <p>
81
- * <b>S3 Block Public Access</b> - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then separately call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">
98
+ * <b>S3 Block Public Access</b> - If your
99
+ * specific use case requires granting public access to your S3 resources, you
100
+ * can disable Block Public Access. You can create a new bucket with Block
101
+ * Public Access enabled, then separately call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">
82
102
  * <code>DeletePublicAccessBlock</code>
83
103
  * </a> API. To use this operation, you must have the
84
- * <code>s3:PutBucketPublicAccessBlock</code> permission. By default, all Block
85
- * Public Access settings are enabled for new buckets. To avoid inadvertent exposure of
86
- * your resources, we recommend keeping the S3 Block Public Access settings enabled. For more information about S3 Block Public Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Blocking public
87
- * access to your Amazon S3 storage </a> in the <i>Amazon S3 User Guide</i>. </p>
104
+ * <code>s3:PutBucketPublicAccessBlock</code> permission. By default, all
105
+ * Block Public Access settings are enabled for new buckets. To avoid
106
+ * inadvertent exposure of your resources, we recommend keeping the S3 Block
107
+ * Public Access settings enabled. For more information about S3 Block Public
108
+ * Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Blocking
109
+ * public access to your Amazon S3 storage </a> in the
110
+ * <i>Amazon S3 User Guide</i>. </p>
88
111
  * </li>
89
112
  * </ul>
90
113
  * </dd>
91
114
  * </dl>
92
115
  * <important>
93
- * <p> If your <code>CreateBucket</code> request sets <code>BucketOwnerEnforced</code> for Amazon S3 Object Ownership
94
- * and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a <code>400</code> error and returns the <code>InvalidBucketAcLWithObjectOwnership</code> error code. For more information,
95
- * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html">Setting Object
96
- * Ownership on an existing bucket </a> in the <i>Amazon S3 User Guide</i>. </p>
116
+ * <p> If your <code>CreateBucket</code> request sets <code>BucketOwnerEnforced</code> for
117
+ * Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external
118
+ * Amazon Web Services account, your request fails with a <code>400</code> error and returns the
119
+ * <code>InvalidBucketAcLWithObjectOwnership</code> error code. For more information,
120
+ * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html">Setting Object
121
+ * Ownership on an existing bucket </a> in the <i>Amazon S3 User Guide</i>.
122
+ * </p>
97
123
  * </important>
98
124
  * <p>The following operations are related to <code>CreateBucket</code>:</p>
99
125
  * <ul>
@@ -32,7 +32,8 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
32
32
  * <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the
33
33
  * upload must complete within the number of days specified in the bucket lifecycle
34
34
  * configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort
35
- * action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p>
35
+ * action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
36
+ * Configuration</a>.</p>
36
37
  * <p>For information about the permissions required to use the multipart upload API, see
37
38
  * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
38
39
  * Upload and Permissions</a>.</p>
@@ -107,19 +108,19 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
107
108
  * </dd>
108
109
  * <dt>Server-Side- Encryption-Specific Request Headers</dt>
109
110
  * <dd>
110
- * <p>Amazon S3 encrypts data
111
- * by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts
112
- * your data as it writes it to disks in its data centers and decrypts it when you
113
- * access it. You can request that Amazon S3 encrypts
114
- * data at rest by using server-side encryption with other key options. The option you use depends on
111
+ * <p>Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed key
112
+ * (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3
113
+ * encrypts your data as it writes it to disks in its data centers and decrypts it
114
+ * when you access it. You can request that Amazon S3 encrypts data at rest by using
115
+ * server-side encryption with other key options. The option you use depends on
115
116
  * whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys
116
117
  * (SSE-C).</p>
117
118
  * <ul>
118
119
  * <li>
119
120
  * <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key
120
- * (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service (KMS) – If you
121
- * want Amazon Web Services to manage the keys used to encrypt data, specify the following
122
- * headers in the request.</p>
121
+ * (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service (KMS) –
122
+ * If you want Amazon Web Services to manage the keys used to encrypt data, specify the
123
+ * following headers in the request.</p>
123
124
  * <ul>
124
125
  * <li>
125
126
  * <p>
@@ -144,9 +145,10 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
144
145
  * protect the data.</p>
145
146
  * </note>
146
147
  * <important>
147
- * <p>All <code>GET</code> and <code>PUT</code> requests for an object protected
148
- * by KMS fail if you don't make them by using Secure Sockets Layer (SSL),
149
- * Transport Layer Security (TLS), or Signature Version 4.</p>
148
+ * <p>All <code>GET</code> and <code>PUT</code> requests for an object
149
+ * protected by KMS fail if you don't make them by using Secure Sockets
150
+ * Layer (SSL), Transport Layer Security (TLS), or Signature Version
151
+ * 4.</p>
150
152
  * </important>
151
153
  * <p>For more information about server-side encryption with KMS keys
152
154
  * (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting Data
@@ -23,9 +23,9 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>This implementation of the DELETE action resets the default encryption for the
27
- * bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the
28
- * bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
26
+ * <p>This implementation of the DELETE action resets the default encryption for the bucket as
27
+ * server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket
28
+ * default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
29
29
  * in the <i>Amazon S3 User Guide</i>.</p>
30
30
  * <p>To use this operation, you must have permissions to perform the
31
31
  * <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission
@@ -37,8 +37,9 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
37
37
  * buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
38
38
  * <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
39
39
  * <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
40
- * denies the root principal's access. Bucket owner root principals can only be blocked from performing
41
- * these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
40
+ * denies the root principal's access. Bucket owner root principals can only be blocked
41
+ * from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
42
+ * policies.</p>
42
43
  * </important>
43
44
  * <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and
44
45
  * UserPolicies</a>. </p>
@@ -44,7 +44,8 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
44
44
  * provide an invalid token, whether there are versioned keys in the request or not, the
45
45
  * entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA
46
46
  * Delete</a>.</p>
47
- * <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in
47
+ * <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3
48
+ * uses the header value to ensure that your request body has not been altered in
48
49
  * transit.</p>
49
50
  * <p>The following operations are related to <code>DeleteObjects</code>:</p>
50
51
  * <ul>
@@ -40,7 +40,8 @@ export interface GetBucketAccelerateConfigurationCommandOutput extends GetBucket
40
40
  * has never been set on the bucket. </p>
41
41
  * <p>For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a> in
42
42
  * the Amazon S3 User Guide.</p>
43
- * <p>The following operations are related to <code>GetBucketAccelerateConfiguration</code>:</p>
43
+ * <p>The following operations are related to
44
+ * <code>GetBucketAccelerateConfiguration</code>:</p>
44
45
  * <ul>
45
46
  * <li>
46
47
  * <p>
@@ -33,7 +33,8 @@ export interface GetBucketAnalyticsConfigurationCommandOutput extends GetBucketA
33
33
  * <i>Amazon S3 User Guide</i>. </p>
34
34
  * <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
35
35
  * Analysis</a> in the <i>Amazon S3 User Guide</i>.</p>
36
- * <p>The following operations are related to <code>GetBucketAnalyticsConfiguration</code>:</p>
36
+ * <p>The following operations are related to
37
+ * <code>GetBucketAnalyticsConfiguration</code>:</p>
37
38
  * <ul>
38
39
  * <li>
39
40
  * <p>
@@ -34,10 +34,11 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
34
34
  * <important>
35
35
  * <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
36
36
  * buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
37
- * <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
38
- * <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
39
- * denies the root principal's access. Bucket owner root principals can only be blocked from performing
40
- * these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
37
+ * <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
38
+ * <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
39
+ * denies the root principal's access. Bucket owner root principals can only be blocked
40
+ * from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
41
+ * policies.</p>
41
42
  * </important>
42
43
  * <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
43
44
  * <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.