@aws-sdk/client-s3 3.301.0 → 3.304.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.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +296 -317
- package/dist-cjs/models/models_1.js +29 -36
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +294 -315
- package/dist-es/models/models_1.js +29 -36
- package/dist-types/S3.d.ts +751 -662
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +2 -2
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +22 -14
- package/dist-types/commands/CopyObjectCommand.d.ts +53 -30
- package/dist-types/commands/CreateBucketCommand.d.ts +22 -14
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +74 -48
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +7 -5
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +1 -2
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -3
- package/dist-types/commands/DeleteObjectCommand.d.ts +11 -11
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +2 -4
- package/dist-types/commands/DeleteObjectsCommand.d.ts +13 -14
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +5 -4
- package/dist-types/commands/GetBucketAclCommand.d.ts +9 -7
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +5 -4
- package/dist-types/commands/GetBucketCorsCommand.d.ts +1 -0
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +7 -7
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/GetBucketLocationCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +5 -6
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +3 -2
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +1 -0
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +2 -1
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectAclCommand.d.ts +5 -4
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +23 -28
- package/dist-types/commands/GetObjectCommand.d.ts +20 -18
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +2 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +5 -5
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +15 -9
- package/dist-types/commands/HeadObjectCommand.d.ts +20 -19
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +4 -4
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -2
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +5 -5
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +6 -7
- package/dist-types/commands/ListBucketsCommand.d.ts +3 -1
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +2 -2
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +3 -6
- package/dist-types/commands/ListObjectsV2Command.d.ts +11 -12
- package/dist-types/commands/ListPartsCommand.d.ts +3 -4
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -3
- package/dist-types/commands/PutBucketAclCommand.d.ts +15 -12
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketCorsCommand.d.ts +2 -2
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +16 -14
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +20 -8
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +8 -8
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +11 -7
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +12 -12
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -2
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +2 -1
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +12 -11
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +12 -12
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +4 -4
- package/dist-types/commands/PutObjectAclCommand.d.ts +17 -13
- package/dist-types/commands/PutObjectCommand.d.ts +44 -53
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +7 -8
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +3 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +4 -3
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +49 -68
- package/dist-types/commands/SelectObjectContentCommand.d.ts +13 -17
- package/dist-types/commands/UploadPartCommand.d.ts +23 -16
- package/dist-types/commands/UploadPartCopyCommand.d.ts +7 -5
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +32 -21
- package/dist-types/models/models_0.d.ts +975 -627
- package/dist-types/models/models_1.d.ts +145 -105
- package/dist-types/ts3.4/models/models_0.d.ts +383 -293
- package/dist-types/ts3.4/models/models_1.d.ts +40 -29
- package/package.json +51 -51
package/dist-types/S3.d.ts
CHANGED
|
@@ -109,8 +109,8 @@ export declare class S3 extends S3Client {
|
|
|
109
109
|
* <p>To verify that all parts have been removed, so you don't get charged for the part
|
|
110
110
|
* storage, you should call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> action and ensure that
|
|
111
111
|
* the parts list is empty.</p>
|
|
112
|
-
* <p>For information about permissions required to use the multipart upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
113
|
-
*
|
|
112
|
+
* <p>For information about permissions required to use the multipart upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
113
|
+
* and Permissions</a>.</p>
|
|
114
114
|
* <p>The following operations are related to <code>AbortMultipartUpload</code>:</p>
|
|
115
115
|
* <ul>
|
|
116
116
|
* <li>
|
|
@@ -148,28 +148,36 @@ export declare class S3 extends S3Client {
|
|
|
148
148
|
* <p>Completes a multipart upload by assembling previously uploaded parts.</p>
|
|
149
149
|
* <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>
|
|
150
150
|
* operation. After successfully uploading all relevant parts of an upload, you call this
|
|
151
|
-
* action to complete the upload. Upon receiving this request, Amazon S3 concatenates all
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
151
|
+
* action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the
|
|
152
|
+
* parts in ascending order by part number to create a new object. In the Complete Multipart
|
|
153
|
+
* Upload request, you must provide the parts list. You must ensure that the parts list is
|
|
154
|
+
* complete. This action concatenates the parts that you provide in the list. For each part in
|
|
155
|
+
* the list, you must provide the part number and the <code>ETag</code> value, returned after
|
|
156
|
+
* that part was uploaded.</p>
|
|
157
157
|
* <p>Processing of a Complete Multipart Upload request could take several minutes to
|
|
158
158
|
* complete. After Amazon S3 begins processing the request, it sends an HTTP response header that
|
|
159
159
|
* specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white
|
|
160
|
-
* space characters to keep the connection from timing out.
|
|
161
|
-
*
|
|
162
|
-
*
|
|
160
|
+
* space characters to keep the connection from timing out. A request could fail after the
|
|
161
|
+
* initial 200 OK response has been sent. This means that a <code>200 OK</code> response can
|
|
162
|
+
* contain either a success or an error. If you call the S3 API directly, make sure to design
|
|
163
|
+
* your application to parse the contents of the response and handle it appropriately. If you
|
|
164
|
+
* use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply
|
|
165
|
+
* error handling per your configuration settings (including automatically retrying the
|
|
166
|
+
* request as appropriate). If the condition persists, the SDKs throws an exception (or, for
|
|
167
|
+
* the SDKs that don't use exceptions, they return the error). </p>
|
|
163
168
|
* <p>Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared
|
|
164
|
-
* to retry the failed requests. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html">Amazon S3 Error Best
|
|
169
|
+
* to retry the failed requests. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html">Amazon S3 Error Best
|
|
170
|
+
* Practices</a>.</p>
|
|
165
171
|
* <important>
|
|
166
|
-
* <p>You cannot use <code>Content-Type: application/x-www-form-urlencoded</code> with
|
|
167
|
-
* Multipart Upload requests. Also, if you do not provide a
|
|
172
|
+
* <p>You cannot use <code>Content-Type: application/x-www-form-urlencoded</code> with
|
|
173
|
+
* Complete Multipart Upload requests. Also, if you do not provide a
|
|
174
|
+
* <code>Content-Type</code> header, <code>CompleteMultipartUpload</code> returns a 200
|
|
175
|
+
* OK response.</p>
|
|
168
176
|
* </important>
|
|
169
177
|
* <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
170
178
|
* Upload</a>.</p>
|
|
171
|
-
* <p>For information about permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
172
|
-
*
|
|
179
|
+
* <p>For information about permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
180
|
+
* and Permissions</a>.</p>
|
|
173
181
|
* <p>
|
|
174
182
|
* <code>CompleteMultipartUpload</code> has the following special errors:</p>
|
|
175
183
|
* <ul>
|
|
@@ -272,15 +280,20 @@ export declare class S3 extends S3Client {
|
|
|
272
280
|
* </note>
|
|
273
281
|
* <p>All copy requests must be authenticated. Additionally, you must have
|
|
274
282
|
* <i>read</i> access to the source object and <i>write</i>
|
|
275
|
-
* access to the destination bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>. Both the
|
|
276
|
-
* that you want to copy the object from and the Region that you want to copy the
|
|
277
|
-
* must be enabled for your account.</p>
|
|
283
|
+
* access to the destination bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>. Both the
|
|
284
|
+
* Region that you want to copy the object from and the Region that you want to copy the
|
|
285
|
+
* object to must be enabled for your account.</p>
|
|
278
286
|
* <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3
|
|
279
287
|
* is copying the files. If the error occurs before the copy action starts, you receive a
|
|
280
288
|
* standard Amazon S3 error. If the error occurs during the copy operation, the error response is
|
|
281
289
|
* embedded in the <code>200 OK</code> response. This means that a <code>200 OK</code>
|
|
282
|
-
* response can contain either a success or an error.
|
|
283
|
-
* contents of the response and handle it
|
|
290
|
+
* response can contain either a success or an error. If you call the S3 API directly, make
|
|
291
|
+
* sure to design your application to parse the contents of the response and handle it
|
|
292
|
+
* appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the
|
|
293
|
+
* embedded error and apply error handling per your configuration settings (including
|
|
294
|
+
* automatically retrying the request as appropriate). If the condition persists, the SDKs
|
|
295
|
+
* throws an exception (or, for the SDKs that don't use exceptions, they return the
|
|
296
|
+
* error).</p>
|
|
284
297
|
* <p>If the copy is successful, you receive a response with information about the copied
|
|
285
298
|
* object.</p>
|
|
286
299
|
* <note>
|
|
@@ -293,7 +306,8 @@ export declare class S3 extends S3Client {
|
|
|
293
306
|
* <important>
|
|
294
307
|
* <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a
|
|
295
308
|
* cross-Region copy using a transfer acceleration endpoint, you get a 400 <code>Bad
|
|
296
|
-
* Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
|
|
309
|
+
* Request</code> error. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
|
|
310
|
+
* Acceleration</a>.</p>
|
|
297
311
|
* </important>
|
|
298
312
|
* <p>
|
|
299
313
|
* <b>Metadata</b>
|
|
@@ -310,6 +324,11 @@ export declare class S3 extends S3Client {
|
|
|
310
324
|
* Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list of
|
|
311
325
|
* 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
|
|
312
326
|
* Amazon S3</a>.</p>
|
|
327
|
+
* <note>
|
|
328
|
+
* <p>
|
|
329
|
+
* <code>x-amz-website-redirect-location</code> is unique to each object and must be
|
|
330
|
+
* specified in the request headers to copy the value.</p>
|
|
331
|
+
* </note>
|
|
313
332
|
* <p>
|
|
314
333
|
* <b>x-amz-copy-source-if Headers</b>
|
|
315
334
|
* </p>
|
|
@@ -374,14 +393,27 @@ export declare class S3 extends S3Client {
|
|
|
374
393
|
* <p>
|
|
375
394
|
* <b>Server-side encryption</b>
|
|
376
395
|
* </p>
|
|
377
|
-
* <p>
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
*
|
|
396
|
+
* <p>Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When
|
|
397
|
+
* copying an object, if you don't specify encryption information in your copy request, the
|
|
398
|
+
* encryption setting of the target object is set to the default encryption configuration of
|
|
399
|
+
* the destination bucket. By default, all buckets have a base level of encryption
|
|
400
|
+
* configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
|
|
401
|
+
* destination bucket has a default encryption configuration that uses server-side encryption
|
|
402
|
+
* with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),
|
|
403
|
+
* Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target
|
|
404
|
+
* object copy. When you perform a CopyObject operation, if you want to use a different type
|
|
405
|
+
* of encryption setting for the target object, you can use other appropriate
|
|
406
|
+
* encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed
|
|
407
|
+
* key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it
|
|
408
|
+
* writes it to disks in its data centers and decrypts the data when you access it. If the
|
|
409
|
+
* encryption setting in your request is different from the default encryption configuration
|
|
410
|
+
* of the destination bucket, the encryption setting in your request takes precedence. If the
|
|
411
|
+
* source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
|
|
412
|
+
* encryption information in your request so that Amazon S3 can decrypt the object for copying. For
|
|
413
|
+
* more information about server-side encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using Server-Side
|
|
414
|
+
* Encryption</a>.</p>
|
|
415
|
+
* <p>If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For
|
|
416
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
385
417
|
* <p>
|
|
386
418
|
* <b>Access Control List (ACL)-Specific Request
|
|
387
419
|
* Headers</b>
|
|
@@ -393,29 +425,29 @@ export declare class S3 extends S3Client {
|
|
|
393
425
|
* 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
|
|
394
426
|
* API</a>. </p>
|
|
395
427
|
* <p>If the bucket that you're copying objects to uses the bucket owner enforced setting for
|
|
396
|
-
* S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that
|
|
397
|
-
*
|
|
398
|
-
* specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
|
|
399
|
-
* ACL or an equivalent form of this ACL expressed in the XML format.</p>
|
|
428
|
+
* S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use
|
|
429
|
+
* this setting only accept PUT requests that don't specify an ACL or PUT requests that
|
|
430
|
+
* specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
|
|
431
|
+
* canned ACL or an equivalent form of this ACL expressed in the XML format.</p>
|
|
400
432
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of
|
|
401
|
-
*
|
|
433
|
+
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
402
434
|
* <note>
|
|
403
|
-
* <p>If your bucket uses the bucket owner enforced setting for Object Ownership,
|
|
404
|
-
*
|
|
435
|
+
* <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all
|
|
436
|
+
* objects written to the bucket by any account will be owned by the bucket owner.</p>
|
|
405
437
|
* </note>
|
|
406
438
|
* <p>
|
|
407
439
|
* <b>Checksums</b>
|
|
408
440
|
* </p>
|
|
409
|
-
* <p>When copying an object, if it has a checksum, that checksum will be copied to the new
|
|
410
|
-
*
|
|
411
|
-
*
|
|
441
|
+
* <p>When copying an object, if it has a checksum, that checksum will be copied to the new
|
|
442
|
+
* object by default. When you copy the object over, you may optionally specify a different
|
|
443
|
+
* checksum algorithm to use with the <code>x-amz-checksum-algorithm</code> header.</p>
|
|
412
444
|
* <p>
|
|
413
445
|
* <b>Storage Class Options</b>
|
|
414
446
|
* </p>
|
|
415
|
-
* <p>You can use the <code>CopyObject</code> action to change the storage class of an
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
447
|
+
* <p>You can use the <code>CopyObject</code> action to change the storage class of an object
|
|
448
|
+
* that is already stored in Amazon S3 using the <code>StorageClass</code> parameter. For more
|
|
449
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the
|
|
450
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
419
451
|
* <p>
|
|
420
452
|
* <b>Versioning</b>
|
|
421
453
|
* </p>
|
|
@@ -444,8 +476,7 @@ export declare class S3 extends S3Client {
|
|
|
444
476
|
* </p>
|
|
445
477
|
* </li>
|
|
446
478
|
* </ul>
|
|
447
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying
|
|
448
|
-
* Objects</a>.</p>
|
|
479
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying Objects</a>.</p>
|
|
449
480
|
*/
|
|
450
481
|
copyObject(args: CopyObjectCommandInput, options?: __HttpHandlerOptions): Promise<CopyObjectCommandOutput>;
|
|
451
482
|
copyObject(args: CopyObjectCommandInput, cb: (err: any, data?: CopyObjectCommandOutput) => void): void;
|
|
@@ -456,27 +487,30 @@ export declare class S3 extends S3Client {
|
|
|
456
487
|
* valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to
|
|
457
488
|
* create buckets. By creating the bucket, you become the bucket owner.</p>
|
|
458
489
|
* <p>Not every string is an acceptable bucket name. For information about bucket naming
|
|
459
|
-
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket naming
|
|
490
|
+
* restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket naming
|
|
491
|
+
* rules</a>.</p>
|
|
460
492
|
* <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>
|
|
461
493
|
* <p>By default, the bucket is created in the US East (N. Virginia) Region. You can
|
|
462
494
|
* optionally specify a Region in the request body. You might choose a Region to optimize
|
|
463
495
|
* latency, minimize costs, or address regulatory requirements. For example, if you reside in
|
|
464
496
|
* Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)
|
|
465
497
|
* Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a
|
|
466
|
-
*
|
|
498
|
+
* bucket</a>.</p>
|
|
467
499
|
* <note>
|
|
468
500
|
* <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint,
|
|
469
501
|
* the request goes to the us-east-1 Region. Accordingly, the signature calculations in
|
|
470
502
|
* Signature Version 4 must use us-east-1 as the Region, even if the location constraint in
|
|
471
503
|
* the request specifies another Region where the bucket is to be created. If you create a
|
|
472
504
|
* bucket in a Region other than US East (N. Virginia), your application must be able to
|
|
473
|
-
* handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
|
|
505
|
+
* handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
|
|
506
|
+
* buckets</a>.</p>
|
|
474
507
|
* </note>
|
|
475
508
|
* <p>
|
|
476
509
|
* <b>Access control lists (ACLs)</b>
|
|
477
510
|
* </p>
|
|
478
|
-
* <p>When creating a bucket using this operation, you can optionally configure the bucket ACL
|
|
479
|
-
* groups that should be granted specific permissions on the
|
|
511
|
+
* <p>When creating a bucket using this operation, you can optionally configure the bucket ACL
|
|
512
|
+
* to specify the accounts or groups that should be granted specific permissions on the
|
|
513
|
+
* bucket.</p>
|
|
480
514
|
* <important>
|
|
481
515
|
* <p>If your CreateBucket request sets bucket owner enforced for S3 Object Ownership and
|
|
482
516
|
* specifies a bucket ACL that provides access to an external Amazon Web Services account, your request
|
|
@@ -485,7 +519,8 @@ export declare class S3 extends S3Client {
|
|
|
485
519
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object
|
|
486
520
|
* ownership</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
487
521
|
* </important>
|
|
488
|
-
* <p>There are two ways to grant the appropriate permissions using the request
|
|
522
|
+
* <p>There are two ways to grant the appropriate permissions using the request
|
|
523
|
+
* headers.</p>
|
|
489
524
|
* <ul>
|
|
490
525
|
* <li>
|
|
491
526
|
* <p>Specify a canned ACL using the <code>x-amz-acl</code> request header. Amazon S3
|
|
@@ -498,14 +533,15 @@ export declare class S3 extends S3Client {
|
|
|
498
533
|
* <code>x-amz-grant-write</code>, <code>x-amz-grant-read-acp</code>,
|
|
499
534
|
* <code>x-amz-grant-write-acp</code>, and <code>x-amz-grant-full-control</code>
|
|
500
535
|
* headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For
|
|
501
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html">Access control list
|
|
502
|
-
*
|
|
536
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html">Access control list (ACL)
|
|
537
|
+
* overview</a>.</p>
|
|
503
538
|
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
504
539
|
* following:</p>
|
|
505
540
|
* <ul>
|
|
506
541
|
* <li>
|
|
507
542
|
* <p>
|
|
508
|
-
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
543
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
544
|
+
* Amazon Web Services account</p>
|
|
509
545
|
* </li>
|
|
510
546
|
* <li>
|
|
511
547
|
* <p>
|
|
@@ -561,14 +597,17 @@ export declare class S3 extends S3Client {
|
|
|
561
597
|
* <p>
|
|
562
598
|
* <b>Permissions</b>
|
|
563
599
|
* </p>
|
|
564
|
-
* <p>In addition to <code>s3:CreateBucket</code>, the following permissions are required when
|
|
600
|
+
* <p>In addition to <code>s3:CreateBucket</code>, the following permissions are required when
|
|
601
|
+
* your CreateBucket includes specific headers:</p>
|
|
565
602
|
* <ul>
|
|
566
603
|
* <li>
|
|
567
604
|
* <p>
|
|
568
|
-
* <b>ACLs</b> - If your <code>CreateBucket</code> request
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
* <code>CreateBucket</code>
|
|
605
|
+
* <b>ACLs</b> - If your <code>CreateBucket</code> request
|
|
606
|
+
* specifies ACL permissions and the ACL is public-read, public-read-write,
|
|
607
|
+
* authenticated-read, or if you specify access permissions explicitly through any other
|
|
608
|
+
* ACL, both <code>s3:CreateBucket</code> and <code>s3:PutBucketAcl</code> permissions
|
|
609
|
+
* are needed. If the ACL the <code>CreateBucket</code> request is private or doesn't
|
|
610
|
+
* specify any ACLs, only <code>s3:CreateBucket</code> permission is needed. </p>
|
|
572
611
|
* </li>
|
|
573
612
|
* <li>
|
|
574
613
|
* <p>
|
|
@@ -613,39 +652,56 @@ export declare class S3 extends S3Client {
|
|
|
613
652
|
* <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the
|
|
614
653
|
* upload must complete within the number of days specified in the bucket lifecycle
|
|
615
654
|
* configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort
|
|
616
|
-
* 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
|
|
617
|
-
* Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p>
|
|
655
|
+
* 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 Policy</a>.</p>
|
|
618
656
|
* <p>For information about the permissions required to use the multipart upload API, see
|
|
619
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
|
|
620
|
-
* Permissions</a>.</p>
|
|
657
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
|
|
658
|
+
* Upload and Permissions</a>.</p>
|
|
621
659
|
* <p>For request signing, multipart upload is just a series of regular requests. You initiate
|
|
622
660
|
* a multipart upload, send one or more requests to upload parts, and then complete the
|
|
623
661
|
* multipart upload process. You sign each request individually. There is nothing special
|
|
624
|
-
* about signing multipart upload requests. For more information about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating
|
|
625
|
-
* Requests (Amazon Web Services Signature Version 4)</a>.</p>
|
|
662
|
+
* about signing multipart upload requests. For more information about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a>.</p>
|
|
626
663
|
* <note>
|
|
627
|
-
* <p>
|
|
664
|
+
* <p>After you initiate a multipart upload and upload one or more parts, to stop being
|
|
628
665
|
* charged for storing the uploaded parts, you must either complete or abort the multipart
|
|
629
666
|
* upload. Amazon S3 frees up the space used to store the parts and stop charging you for
|
|
630
667
|
* storing them only after you either complete or abort a multipart upload. </p>
|
|
631
668
|
* </note>
|
|
632
|
-
* <p>
|
|
633
|
-
*
|
|
634
|
-
*
|
|
635
|
-
*
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
*
|
|
669
|
+
* <p>Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it
|
|
670
|
+
* writes it to disks in its data centers and decrypts it when you access it. Amazon S3
|
|
671
|
+
* automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a
|
|
672
|
+
* multipart upload, if you don't specify encryption information in your request, the
|
|
673
|
+
* encryption setting of the uploaded parts is set to the default encryption configuration of
|
|
674
|
+
* the destination bucket. By default, all buckets have a base level of encryption
|
|
675
|
+
* configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
|
|
676
|
+
* destination bucket has a default encryption configuration that uses server-side encryption
|
|
677
|
+
* with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),
|
|
678
|
+
* Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded
|
|
679
|
+
* parts. When you perform a CreateMultipartUpload operation, if you want to use a different
|
|
680
|
+
* type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the
|
|
681
|
+
* object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption
|
|
682
|
+
* setting in your request is different from the default encryption configuration of the
|
|
683
|
+
* destination bucket, the encryption setting in your request takes precedence. If you choose
|
|
684
|
+
* to provide your own encryption key, the request headers you provide in <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
|
|
685
|
+
* and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> requests must
|
|
686
|
+
* match the headers you used in the request to initiate the upload by using
|
|
687
|
+
* <code>CreateMultipartUpload</code>. you can request that Amazon S3
|
|
688
|
+
* save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key
|
|
689
|
+
* (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key
|
|
690
|
+
* (SSE-C). </p>
|
|
691
|
+
* <p>To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester
|
|
692
|
+
* must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code>
|
|
639
693
|
* actions on the key. These permissions are required because Amazon S3 must decrypt and read data
|
|
640
694
|
* from the encrypted file parts before it completes the multipart upload. For more
|
|
641
695
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API
|
|
642
|
-
* and permissions</a>
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
* user or role
|
|
646
|
-
* permissions on
|
|
647
|
-
*
|
|
648
|
-
*
|
|
696
|
+
* and permissions</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting data using
|
|
697
|
+
* server-side encryption with Amazon Web Services KMS</a> in the
|
|
698
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
699
|
+
* <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key,
|
|
700
|
+
* then you must have these permissions on the key policy. If your IAM user or role belongs
|
|
701
|
+
* to a different account than the key, then you must have the permissions on both the key
|
|
702
|
+
* policy and your IAM user or role.</p>
|
|
703
|
+
* <p> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using Server-Side
|
|
704
|
+
* Encryption</a>.</p>
|
|
649
705
|
* <dl>
|
|
650
706
|
* <dt>Access Permissions</dt>
|
|
651
707
|
* <dd>
|
|
@@ -655,7 +711,8 @@ export declare class S3 extends S3Client {
|
|
|
655
711
|
* <ul>
|
|
656
712
|
* <li>
|
|
657
713
|
* <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. For
|
|
658
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
714
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
715
|
+
* ACL</a>.</p>
|
|
659
716
|
* </li>
|
|
660
717
|
* <li>
|
|
661
718
|
* <p>Specify access permissions explicitly with the
|
|
@@ -663,8 +720,7 @@ export declare class S3 extends S3Client {
|
|
|
663
720
|
* <code>x-amz-grant-write-acp</code>, and
|
|
664
721
|
* <code>x-amz-grant-full-control</code> headers. These parameters map to
|
|
665
722
|
* the set of permissions that Amazon S3 supports in an ACL. For more information,
|
|
666
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
667
|
-
* Overview</a>.</p>
|
|
723
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>.</p>
|
|
668
724
|
* </li>
|
|
669
725
|
* </ul>
|
|
670
726
|
* <p>You can use either a canned ACL or specify access permissions explicitly. You
|
|
@@ -672,16 +728,19 @@ export declare class S3 extends S3Client {
|
|
|
672
728
|
* </dd>
|
|
673
729
|
* <dt>Server-Side- Encryption-Specific Request Headers</dt>
|
|
674
730
|
* <dd>
|
|
675
|
-
* <p>
|
|
676
|
-
* encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts
|
|
731
|
+
* <p>Amazon S3 encrypts data
|
|
732
|
+
* 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
|
|
677
733
|
* your data as it writes it to disks in its data centers and decrypts it when you
|
|
678
|
-
* access it.
|
|
679
|
-
*
|
|
734
|
+
* access it. You can request that Amazon S3 encrypts
|
|
735
|
+
* data at rest by using server-side encryption with other key options. The option you use depends on
|
|
736
|
+
* whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys
|
|
737
|
+
* (SSE-C).</p>
|
|
680
738
|
* <ul>
|
|
681
739
|
* <li>
|
|
682
|
-
* <p>Use
|
|
683
|
-
*
|
|
684
|
-
* used to encrypt data, specify the following
|
|
740
|
+
* <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key
|
|
741
|
+
* (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service (KMS) – If you
|
|
742
|
+
* want Amazon Web Services to manage the keys used to encrypt data, specify the following
|
|
743
|
+
* headers in the request.</p>
|
|
685
744
|
* <ul>
|
|
686
745
|
* <li>
|
|
687
746
|
* <p>
|
|
@@ -702,18 +761,22 @@ export declare class S3 extends S3Client {
|
|
|
702
761
|
* <note>
|
|
703
762
|
* <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but
|
|
704
763
|
* don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>,
|
|
705
|
-
* Amazon S3 uses the Amazon Web Services managed key
|
|
764
|
+
* Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code> key) in KMS to
|
|
765
|
+
* protect the data.</p>
|
|
706
766
|
* </note>
|
|
707
767
|
* <important>
|
|
708
|
-
* <p>All GET and PUT requests for an object protected
|
|
709
|
-
* you don't make them
|
|
768
|
+
* <p>All <code>GET</code> and <code>PUT</code> requests for an object protected
|
|
769
|
+
* by KMS fail if you don't make them by using Secure Sockets Layer (SSL),
|
|
770
|
+
* Transport Layer Security (TLS), or Signature Version 4.</p>
|
|
710
771
|
* </important>
|
|
711
|
-
* <p>For more information about server-side encryption with KMS
|
|
712
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/
|
|
772
|
+
* <p>For more information about server-side encryption with KMS keys
|
|
773
|
+
* (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting Data
|
|
774
|
+
* Using Server-Side Encryption with KMS keys</a>.</p>
|
|
713
775
|
* </li>
|
|
714
776
|
* <li>
|
|
715
|
-
* <p>Use customer-provided encryption keys – If you want to manage
|
|
716
|
-
* encryption keys, provide all the following headers in the
|
|
777
|
+
* <p>Use customer-provided encryption keys (SSE-C) – If you want to manage
|
|
778
|
+
* your own encryption keys, provide all the following headers in the
|
|
779
|
+
* request.</p>
|
|
717
780
|
* <ul>
|
|
718
781
|
* <li>
|
|
719
782
|
* <p>
|
|
@@ -731,8 +794,10 @@ export declare class S3 extends S3Client {
|
|
|
731
794
|
* </p>
|
|
732
795
|
* </li>
|
|
733
796
|
* </ul>
|
|
734
|
-
* <p>For more information about server-side encryption with
|
|
735
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/
|
|
797
|
+
* <p>For more information about server-side encryption with customer-provided
|
|
798
|
+
* encryption keys (SSE-C), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html">
|
|
799
|
+
* Protecting data using server-side encryption with customer-provided
|
|
800
|
+
* encryption keys (SSE-C)</a>.</p>
|
|
736
801
|
* </li>
|
|
737
802
|
* </ul>
|
|
738
803
|
* </dd>
|
|
@@ -740,10 +805,11 @@ export declare class S3 extends S3Client {
|
|
|
740
805
|
* <dd>
|
|
741
806
|
* <p>You also can use the following access control–related headers with this
|
|
742
807
|
* operation. By default, all objects are private. Only the owner has full access
|
|
743
|
-
* control. When adding a new object, you can grant permissions to individual
|
|
744
|
-
*
|
|
745
|
-
*
|
|
746
|
-
*
|
|
808
|
+
* control. When adding a new object, you can grant permissions to individual
|
|
809
|
+
* Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then
|
|
810
|
+
* added to the access control list (ACL) on the object. For more information, see
|
|
811
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. With this operation, you can grant access permissions
|
|
812
|
+
* using one of the following two methods:</p>
|
|
747
813
|
* <ul>
|
|
748
814
|
* <li>
|
|
749
815
|
* <p>Specify a canned ACL (<code>x-amz-acl</code>) — Amazon S3 supports a set of
|
|
@@ -756,10 +822,9 @@ export declare class S3 extends S3Client {
|
|
|
756
822
|
* <p>Specify access permissions explicitly — To explicitly grant access
|
|
757
823
|
* permissions to specific Amazon Web Services accounts or groups, use the following headers.
|
|
758
824
|
* Each header maps to specific permissions that Amazon S3 supports in an ACL. For
|
|
759
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access
|
|
760
|
-
*
|
|
761
|
-
*
|
|
762
|
-
* use:</p>
|
|
825
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
826
|
+
* Overview</a>. In the header, you specify a list of grantees who get
|
|
827
|
+
* the specific permission. To grant permissions explicitly, use:</p>
|
|
763
828
|
* <ul>
|
|
764
829
|
* <li>
|
|
765
830
|
* <p>
|
|
@@ -906,8 +971,8 @@ export declare class S3 extends S3Client {
|
|
|
906
971
|
* <p>To use this operation, you must have permissions to perform the
|
|
907
972
|
* <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
908
973
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
909
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
910
|
-
* Resources</a>.</p>
|
|
974
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
975
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
911
976
|
* <p>For information about the Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
912
977
|
* Analysis</a>. </p>
|
|
913
978
|
* <p>The following operations are related to
|
|
@@ -939,8 +1004,8 @@ export declare class S3 extends S3Client {
|
|
|
939
1004
|
* <p>To use this operation, you must have permission to perform the
|
|
940
1005
|
* <code>s3:PutBucketCORS</code> action. The bucket owner has this permission by default
|
|
941
1006
|
* and can grant this permission to others. </p>
|
|
942
|
-
* <p>For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
943
|
-
*
|
|
1007
|
+
* <p>For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in
|
|
1008
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
944
1009
|
* <p class="title">
|
|
945
1010
|
* <b>Related Resources:</b>
|
|
946
1011
|
* </p>
|
|
@@ -962,14 +1027,16 @@ export declare class S3 extends S3Client {
|
|
|
962
1027
|
deleteBucketCors(args: DeleteBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketCorsCommandOutput) => void): void;
|
|
963
1028
|
/**
|
|
964
1029
|
* @public
|
|
965
|
-
* <p>This implementation of the DELETE action
|
|
966
|
-
*
|
|
967
|
-
*
|
|
1030
|
+
* <p>This implementation of the DELETE action resets the default encryption for the
|
|
1031
|
+
* bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the
|
|
1032
|
+
* bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
|
|
1033
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
968
1034
|
* <p>To use this operation, you must have permissions to perform the
|
|
969
1035
|
* <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission
|
|
970
1036
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
971
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
972
|
-
*
|
|
1037
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1038
|
+
* Access Permissions to your Amazon S3 Resources</a> in the
|
|
1039
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
973
1040
|
* <p class="title">
|
|
974
1041
|
* <b>Related Resources</b>
|
|
975
1042
|
* </p>
|
|
@@ -995,8 +1062,7 @@ export declare class S3 extends S3Client {
|
|
|
995
1062
|
* <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
|
|
996
1063
|
* <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p>
|
|
997
1064
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
|
|
998
|
-
* <p>Operations related to
|
|
999
|
-
* <code>DeleteBucketIntelligentTieringConfiguration</code> include: </p>
|
|
1065
|
+
* <p>Operations related to <code>DeleteBucketIntelligentTieringConfiguration</code> include: </p>
|
|
1000
1066
|
* <ul>
|
|
1001
1067
|
* <li>
|
|
1002
1068
|
* <p>
|
|
@@ -1025,8 +1091,8 @@ export declare class S3 extends S3Client {
|
|
|
1025
1091
|
* <p>To use this operation, you must have permissions to perform the
|
|
1026
1092
|
* <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission
|
|
1027
1093
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
1028
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1029
|
-
* Resources</a>.</p>
|
|
1094
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1095
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
1030
1096
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p>
|
|
1031
1097
|
* <p>Operations related to <code>DeleteBucketInventoryConfiguration</code> include: </p>
|
|
1032
1098
|
* <ul>
|
|
@@ -1061,8 +1127,7 @@ export declare class S3 extends S3Client {
|
|
|
1061
1127
|
* permission and the bucket owner can grant this permission to others.</p>
|
|
1062
1128
|
* <p>There is usually some time lag before lifecycle configuration deletion is fully
|
|
1063
1129
|
* propagated to all the Amazon S3 systems.</p>
|
|
1064
|
-
* <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to
|
|
1065
|
-
* Describe Lifecycle Actions</a>.</p>
|
|
1130
|
+
* <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p>
|
|
1066
1131
|
* <p>Related actions include:</p>
|
|
1067
1132
|
* <ul>
|
|
1068
1133
|
* <li>
|
|
@@ -1088,9 +1153,10 @@ export declare class S3 extends S3Client {
|
|
|
1088
1153
|
* <p> To use this operation, you must have permissions to perform the
|
|
1089
1154
|
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
1090
1155
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
1091
|
-
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1092
|
-
* Resources</a>.</p>
|
|
1093
|
-
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with
|
|
1156
|
+
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1157
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
1158
|
+
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with
|
|
1159
|
+
* Amazon CloudWatch</a>. </p>
|
|
1094
1160
|
* <p>The following operations are related to
|
|
1095
1161
|
* <code>DeleteBucketMetricsConfiguration</code>:</p>
|
|
1096
1162
|
* <ul>
|
|
@@ -1111,8 +1177,7 @@ export declare class S3 extends S3Client {
|
|
|
1111
1177
|
* </li>
|
|
1112
1178
|
* <li>
|
|
1113
1179
|
* <p>
|
|
1114
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
1115
|
-
* CloudWatch</a>
|
|
1180
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>
|
|
1116
1181
|
* </p>
|
|
1117
1182
|
* </li>
|
|
1118
1183
|
* </ul>
|
|
@@ -1124,8 +1189,8 @@ export declare class S3 extends S3Client {
|
|
|
1124
1189
|
* @public
|
|
1125
1190
|
* <p>Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
|
|
1126
1191
|
* must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information
|
|
1127
|
-
* about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
|
|
1128
|
-
*
|
|
1192
|
+
* about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
1193
|
+
* Policy</a>.</p>
|
|
1129
1194
|
* <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html">Using Object Ownership</a>. </p>
|
|
1130
1195
|
* <p>The following operations are related to
|
|
1131
1196
|
* <code>DeleteBucketOwnershipControls</code>:</p>
|
|
@@ -1187,13 +1252,14 @@ export declare class S3 extends S3Client {
|
|
|
1187
1252
|
* <p>To use this operation, you must have permissions to perform the
|
|
1188
1253
|
* <code>s3:PutReplicationConfiguration</code> action. The bucket owner has these
|
|
1189
1254
|
* permissions by default and can grant it to others. For more information about permissions,
|
|
1190
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1191
|
-
* Resources</a>. </p>
|
|
1255
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1256
|
+
* Access Permissions to Your Amazon S3 Resources</a>. </p>
|
|
1192
1257
|
* <note>
|
|
1193
1258
|
* <p>It can take a while for the deletion of a replication configuration to fully
|
|
1194
1259
|
* propagate.</p>
|
|
1195
1260
|
* </note>
|
|
1196
|
-
* <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the
|
|
1261
|
+
* <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the
|
|
1262
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1197
1263
|
* <p>The following operations are related to <code>DeleteBucketReplication</code>:</p>
|
|
1198
1264
|
* <ul>
|
|
1199
1265
|
* <li>
|
|
@@ -1269,21 +1335,21 @@ export declare class S3 extends S3Client {
|
|
|
1269
1335
|
* <p>Removes the null version (if there is one) of an object and inserts a delete marker,
|
|
1270
1336
|
* which becomes the latest version of the object. If there isn't a null version, Amazon S3 does
|
|
1271
1337
|
* not remove any objects but will still respond that the command was successful.</p>
|
|
1272
|
-
* <p>To remove a specific version, you must
|
|
1273
|
-
*
|
|
1274
|
-
*
|
|
1275
|
-
* <code>x-amz-delete-marker</code>, to true. </p>
|
|
1338
|
+
* <p>To remove a specific version, you must use the version Id subresource. Using this
|
|
1339
|
+
* subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3
|
|
1340
|
+
* sets the response header, <code>x-amz-delete-marker</code>, to true. </p>
|
|
1276
1341
|
* <p>If the object you want to delete is in a bucket where the bucket versioning
|
|
1277
1342
|
* configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request
|
|
1278
1343
|
* header in the DELETE <code>versionId</code> request. Requests that include
|
|
1279
1344
|
* <code>x-amz-mfa</code> must use HTTPS. </p>
|
|
1280
|
-
* <p> For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a>. To see sample
|
|
1281
|
-
*
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1285
|
-
*
|
|
1286
|
-
*
|
|
1345
|
+
* <p> For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a>. To see sample
|
|
1346
|
+
* requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample
|
|
1347
|
+
* Request</a>. </p>
|
|
1348
|
+
* <p>You can delete objects by explicitly calling DELETE Object or configure its lifecycle
|
|
1349
|
+
* (<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
|
|
1350
|
+
* users or accounts from removing or deleting objects from your bucket, you must deny them
|
|
1351
|
+
* the <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and
|
|
1352
|
+
* <code>s3:PutLifeCycleConfiguration</code> actions. </p>
|
|
1287
1353
|
* <p>The following action is related to <code>DeleteObject</code>:</p>
|
|
1288
1354
|
* <ul>
|
|
1289
1355
|
* <li>
|
|
@@ -1299,28 +1365,27 @@ export declare class S3 extends S3Client {
|
|
|
1299
1365
|
/**
|
|
1300
1366
|
* @public
|
|
1301
1367
|
* <p>This action enables you to delete multiple objects from a bucket using a single HTTP
|
|
1302
|
-
* request. If you know the object keys that you want to delete, then this action provides
|
|
1303
|
-
*
|
|
1368
|
+
* request. If you know the object keys that you want to delete, then this action provides a
|
|
1369
|
+
* suitable alternative to sending individual delete requests, reducing per-request
|
|
1304
1370
|
* overhead.</p>
|
|
1305
1371
|
* <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you
|
|
1306
1372
|
* provide the object key names, and optionally, version IDs if you want to delete a specific
|
|
1307
1373
|
* version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
|
1308
|
-
* delete action and returns the result of that delete, success, or failure, in the
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1374
|
+
* delete action and returns the result of that delete, success, or failure, in the response.
|
|
1375
|
+
* Note that if the object specified in the request is not found, Amazon S3 returns the result as
|
|
1376
|
+
* deleted.</p>
|
|
1311
1377
|
* <p> The action supports two modes for the response: verbose and quiet. By default, the
|
|
1312
|
-
* action uses verbose mode in which the response includes the result of deletion of each
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
1316
|
-
* <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete
|
|
1317
|
-
*
|
|
1378
|
+
* action uses verbose mode in which the response includes the result of deletion of each key
|
|
1379
|
+
* in your request. In quiet mode the response includes only keys where the delete action
|
|
1380
|
+
* encountered an error. For a successful deletion, the action does not return any information
|
|
1381
|
+
* about the delete in the response body.</p>
|
|
1382
|
+
* <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any
|
|
1383
|
+
* versioned objects, you must include an MFA token. If you do not provide one, the entire
|
|
1318
1384
|
* request will fail, even if there are non-versioned objects you are trying to delete. If you
|
|
1319
1385
|
* provide an invalid token, whether there are versioned keys in the request or not, the
|
|
1320
1386
|
* 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
|
|
1321
|
-
*
|
|
1322
|
-
* <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon
|
|
1323
|
-
* S3 uses the header value to ensure that your request body has not been altered in
|
|
1387
|
+
* Delete</a>.</p>
|
|
1388
|
+
* <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
|
|
1324
1389
|
* transit.</p>
|
|
1325
1390
|
* <p>The following operations are related to <code>DeleteObjects</code>:</p>
|
|
1326
1391
|
* <ul>
|
|
@@ -1357,15 +1422,13 @@ export declare class S3 extends S3Client {
|
|
|
1357
1422
|
/**
|
|
1358
1423
|
* @public
|
|
1359
1424
|
* <p>Removes the entire tag set from the specified object. For more information about
|
|
1360
|
-
* managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object
|
|
1361
|
-
* Tagging</a>.</p>
|
|
1425
|
+
* managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object Tagging</a>.</p>
|
|
1362
1426
|
* <p>To use this operation, you must have permission to perform the
|
|
1363
1427
|
* <code>s3:DeleteObjectTagging</code> action.</p>
|
|
1364
1428
|
* <p>To delete tags of a specific object version, add the <code>versionId</code> query
|
|
1365
1429
|
* parameter in the request. You will need permission for the
|
|
1366
1430
|
* <code>s3:DeleteObjectVersionTagging</code> action.</p>
|
|
1367
|
-
* <p>The following operations are related to
|
|
1368
|
-
* <code>DeleteBucketMetricsConfiguration</code>:</p>
|
|
1431
|
+
* <p>The following operations are related to <code>DeleteObjectTagging</code>:</p>
|
|
1369
1432
|
* <ul>
|
|
1370
1433
|
* <li>
|
|
1371
1434
|
* <p>
|
|
@@ -1386,8 +1449,8 @@ export declare class S3 extends S3Client {
|
|
|
1386
1449
|
* @public
|
|
1387
1450
|
* <p>Removes the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use this
|
|
1388
1451
|
* operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For
|
|
1389
|
-
* more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1390
|
-
* Resources</a>.</p>
|
|
1452
|
+
* more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1453
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
1391
1454
|
* <p>The following operations are related to <code>DeletePublicAccessBlock</code>:</p>
|
|
1392
1455
|
* <ul>
|
|
1393
1456
|
* <li>
|
|
@@ -1425,15 +1488,16 @@ export declare class S3 extends S3Client {
|
|
|
1425
1488
|
* <p>To use this operation, you must have permission to perform the
|
|
1426
1489
|
* <code>s3:GetAccelerateConfiguration</code> action. The bucket owner has this permission
|
|
1427
1490
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
1428
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1429
|
-
*
|
|
1491
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1492
|
+
* Access Permissions to your Amazon S3 Resources</a> in the
|
|
1493
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1430
1494
|
* <p>You set the Transfer Acceleration state of an existing bucket to <code>Enabled</code> or
|
|
1431
1495
|
* <code>Suspended</code> by using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html">PutBucketAccelerateConfiguration</a> operation. </p>
|
|
1432
1496
|
* <p>A GET <code>accelerate</code> request does not return a state value for a bucket that
|
|
1433
1497
|
* has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state
|
|
1434
1498
|
* has never been set on the bucket. </p>
|
|
1435
|
-
* <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
|
|
1436
|
-
* Amazon S3 User Guide.</p>
|
|
1499
|
+
* <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
|
|
1500
|
+
* the Amazon S3 User Guide.</p>
|
|
1437
1501
|
* <p class="title">
|
|
1438
1502
|
* <b>Related Resources</b>
|
|
1439
1503
|
* </p>
|
|
@@ -1450,17 +1514,19 @@ export declare class S3 extends S3Client {
|
|
|
1450
1514
|
getBucketAccelerateConfiguration(args: GetBucketAccelerateConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAccelerateConfigurationCommandOutput) => void): void;
|
|
1451
1515
|
/**
|
|
1452
1516
|
* @public
|
|
1453
|
-
* <p>This implementation of the <code>GET</code> action uses the <code>acl</code>
|
|
1454
|
-
*
|
|
1455
|
-
*
|
|
1517
|
+
* <p>This implementation of the <code>GET</code> action uses the <code>acl</code> subresource
|
|
1518
|
+
* to return the access control list (ACL) of a bucket. To use <code>GET</code> to return the
|
|
1519
|
+
* ACL of the bucket, you must have <code>READ_ACP</code> access to the bucket. If
|
|
1456
1520
|
* <code>READ_ACP</code> permission is granted to the anonymous user, you can return the
|
|
1457
1521
|
* ACL of the bucket without using an authorization header.</p>
|
|
1522
|
+
* <p>To use this API against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
1458
1523
|
* <note>
|
|
1459
1524
|
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
|
|
1460
|
-
* requests to read ACLs are still supported and return the
|
|
1461
|
-
*
|
|
1462
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">
|
|
1463
|
-
*
|
|
1525
|
+
* requests to read ACLs are still supported and return the
|
|
1526
|
+
* <code>bucket-owner-full-control</code> ACL with the owner being the account that
|
|
1527
|
+
* created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object
|
|
1528
|
+
* ownership and disabling ACLs</a> in the
|
|
1529
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1464
1530
|
* </note>
|
|
1465
1531
|
* <p class="title">
|
|
1466
1532
|
* <b>Related Resources</b>
|
|
@@ -1478,13 +1544,14 @@ export declare class S3 extends S3Client {
|
|
|
1478
1544
|
getBucketAcl(args: GetBucketAclCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketAclCommandOutput) => void): void;
|
|
1479
1545
|
/**
|
|
1480
1546
|
* @public
|
|
1481
|
-
* <p>This implementation of the GET action returns an analytics configuration (identified
|
|
1482
|
-
*
|
|
1547
|
+
* <p>This implementation of the GET action returns an analytics configuration (identified by
|
|
1548
|
+
* the analytics configuration ID) from the bucket.</p>
|
|
1483
1549
|
* <p>To use this operation, you must have permissions to perform the
|
|
1484
1550
|
* <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
1485
1551
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
1486
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources"> Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1487
|
-
*
|
|
1552
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources"> Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1553
|
+
* Access Permissions to Your Amazon S3 Resources</a> in the
|
|
1554
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
1488
1555
|
* <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
|
|
1489
1556
|
* Analysis</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1490
1557
|
* <p class="title">
|
|
@@ -1518,6 +1585,7 @@ export declare class S3 extends S3Client {
|
|
|
1518
1585
|
* <p> To use this operation, you must have permission to perform the
|
|
1519
1586
|
* <code>s3:GetBucketCORS</code> action. By default, the bucket owner has this permission
|
|
1520
1587
|
* and can grant it to others.</p>
|
|
1588
|
+
* <p>To use this API against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
1521
1589
|
* <p> For more information about CORS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html"> Enabling Cross-Origin Resource
|
|
1522
1590
|
* Sharing</a>.</p>
|
|
1523
1591
|
* <p>The following operations are related to <code>GetBucketCors</code>:</p>
|
|
@@ -1539,15 +1607,15 @@ export declare class S3 extends S3Client {
|
|
|
1539
1607
|
getBucketCors(args: GetBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBucketCorsCommandOutput) => void): void;
|
|
1540
1608
|
/**
|
|
1541
1609
|
* @public
|
|
1542
|
-
* <p>Returns the default encryption configuration for an Amazon S3 bucket.
|
|
1543
|
-
*
|
|
1544
|
-
* <
|
|
1545
|
-
*
|
|
1546
|
-
* <p>
|
|
1610
|
+
* <p>Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that
|
|
1611
|
+
* uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information
|
|
1612
|
+
* about the bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket
|
|
1613
|
+
* Default Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1614
|
+
* <p>To use this operation, you must have permission to perform the
|
|
1547
1615
|
* <code>s3:GetEncryptionConfiguration</code> action. The bucket owner has this permission
|
|
1548
1616
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
1549
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1550
|
-
* Resources</a>.</p>
|
|
1617
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1618
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
1551
1619
|
* <p>The following operations are related to <code>GetBucketEncryption</code>:</p>
|
|
1552
1620
|
* <ul>
|
|
1553
1621
|
* <li>
|
|
@@ -1571,8 +1639,7 @@ export declare class S3 extends S3Client {
|
|
|
1571
1639
|
* <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
|
|
1572
1640
|
* <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p>
|
|
1573
1641
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
|
|
1574
|
-
* <p>Operations related to
|
|
1575
|
-
* <code>GetBucketIntelligentTieringConfiguration</code> include: </p>
|
|
1642
|
+
* <p>Operations related to <code>GetBucketIntelligentTieringConfiguration</code> include: </p>
|
|
1576
1643
|
* <ul>
|
|
1577
1644
|
* <li>
|
|
1578
1645
|
* <p>
|
|
@@ -1601,8 +1668,8 @@ export declare class S3 extends S3Client {
|
|
|
1601
1668
|
* <p>To use this operation, you must have permissions to perform the
|
|
1602
1669
|
* <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
|
|
1603
1670
|
* by default and can grant this permission to others. For more information about permissions,
|
|
1604
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1605
|
-
* Resources</a>.</p>
|
|
1671
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1672
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
1606
1673
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p>
|
|
1607
1674
|
* <p>The following operations are related to
|
|
1608
1675
|
* <code>GetBucketInventoryConfiguration</code>:</p>
|
|
@@ -1638,13 +1705,13 @@ export declare class S3 extends S3Client {
|
|
|
1638
1705
|
* works. For the earlier action, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html">GetBucketLifecycle</a>.</p>
|
|
1639
1706
|
* </note>
|
|
1640
1707
|
* <p>Returns the lifecycle configuration information set on the bucket. For information about
|
|
1641
|
-
* lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object
|
|
1642
|
-
*
|
|
1708
|
+
* lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle
|
|
1709
|
+
* Management</a>.</p>
|
|
1643
1710
|
* <p>To use this operation, you must have permission to perform the
|
|
1644
1711
|
* <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission,
|
|
1645
1712
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
1646
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1647
|
-
* Resources</a>.</p>
|
|
1713
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1714
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
1648
1715
|
* <p>
|
|
1649
1716
|
* <code>GetBucketLifecycleConfiguration</code> has the following special error:</p>
|
|
1650
1717
|
* <ul>
|
|
@@ -1694,6 +1761,10 @@ export declare class S3 extends S3Client {
|
|
|
1694
1761
|
* request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>.</p>
|
|
1695
1762
|
* <p>To use this implementation of the operation, you must be the bucket owner.</p>
|
|
1696
1763
|
* <p>To use this API against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
1764
|
+
* <note>
|
|
1765
|
+
* <p>For requests made using Amazon Web Services Signature Version 4 (SigV4), we recommend that you use
|
|
1766
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html">HeadBucket</a> to return the bucket Region instead of GetBucketLocation.</p>
|
|
1767
|
+
* </note>
|
|
1697
1768
|
* <p>The following operations are related to <code>GetBucketLocation</code>:</p>
|
|
1698
1769
|
* <ul>
|
|
1699
1770
|
* <li>
|
|
@@ -1714,7 +1785,7 @@ export declare class S3 extends S3Client {
|
|
|
1714
1785
|
/**
|
|
1715
1786
|
* @public
|
|
1716
1787
|
* <p>Returns the logging status of a bucket and the permissions users have to view and modify
|
|
1717
|
-
* that status
|
|
1788
|
+
* that status.</p>
|
|
1718
1789
|
* <p>The following operations are related to <code>GetBucketLogging</code>:</p>
|
|
1719
1790
|
* <ul>
|
|
1720
1791
|
* <li>
|
|
@@ -1739,10 +1810,10 @@ export declare class S3 extends S3Client {
|
|
|
1739
1810
|
* <p> To use this operation, you must have permissions to perform the
|
|
1740
1811
|
* <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
1741
1812
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
1742
|
-
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1743
|
-
* Resources</a>.</p>
|
|
1744
|
-
* <p> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring
|
|
1745
|
-
* CloudWatch</a>.</p>
|
|
1813
|
+
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
1814
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
1815
|
+
* <p> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring
|
|
1816
|
+
* Metrics with Amazon CloudWatch</a>.</p>
|
|
1746
1817
|
* <p>The following operations are related to
|
|
1747
1818
|
* <code>GetBucketMetricsConfiguration</code>:</p>
|
|
1748
1819
|
* <ul>
|
|
@@ -1763,8 +1834,7 @@ export declare class S3 extends S3Client {
|
|
|
1763
1834
|
* </li>
|
|
1764
1835
|
* <li>
|
|
1765
1836
|
* <p>
|
|
1766
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
1767
|
-
* CloudWatch</a>
|
|
1837
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>
|
|
1768
1838
|
* </p>
|
|
1769
1839
|
* </li>
|
|
1770
1840
|
* </ul>
|
|
@@ -1781,9 +1851,10 @@ export declare class S3 extends S3Client {
|
|
|
1781
1851
|
* bucket. However, the bucket owner can use a bucket policy to grant permission to other
|
|
1782
1852
|
* users to read this configuration with the <code>s3:GetBucketNotification</code>
|
|
1783
1853
|
* permission.</p>
|
|
1854
|
+
* <p>To use this API against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
1784
1855
|
* <p>For more information about setting and reading the notification configuration on a
|
|
1785
|
-
* bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of
|
|
1786
|
-
*
|
|
1856
|
+
* bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of Bucket Events</a>. For more information about bucket
|
|
1857
|
+
* policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p>
|
|
1787
1858
|
* <p>The following action is related to <code>GetBucketNotification</code>:</p>
|
|
1788
1859
|
* <ul>
|
|
1789
1860
|
* <li>
|
|
@@ -1800,9 +1871,10 @@ export declare class S3 extends S3Client {
|
|
|
1800
1871
|
* @public
|
|
1801
1872
|
* <p>Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
|
|
1802
1873
|
* must have the <code>s3:GetBucketOwnershipControls</code> permission. For more information
|
|
1803
|
-
* about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying
|
|
1804
|
-
*
|
|
1805
|
-
* <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using Object
|
|
1874
|
+
* about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying permissions in a
|
|
1875
|
+
* policy</a>. </p>
|
|
1876
|
+
* <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using Object
|
|
1877
|
+
* Ownership</a>. </p>
|
|
1806
1878
|
* <p>The following operations are related to <code>GetBucketOwnershipControls</code>:</p>
|
|
1807
1879
|
* <ul>
|
|
1808
1880
|
* <li>
|
|
@@ -1835,6 +1907,7 @@ export declare class S3 extends S3Client {
|
|
|
1835
1907
|
* always use this operation, even if the policy explicitly denies the root user the
|
|
1836
1908
|
* ability to perform this action.</p>
|
|
1837
1909
|
* </important>
|
|
1910
|
+
* <p>To use this API against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
1838
1911
|
* <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 User
|
|
1839
1912
|
* Policies</a>.</p>
|
|
1840
1913
|
* <p>The following action is related to <code>GetBucketPolicy</code>:</p>
|
|
@@ -1854,7 +1927,7 @@ export declare class S3 extends S3Client {
|
|
|
1854
1927
|
* <p>Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
|
|
1855
1928
|
* In order to use this operation, you must have the <code>s3:GetBucketPolicyStatus</code>
|
|
1856
1929
|
* permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
1857
|
-
*
|
|
1930
|
+
* Policy</a>.</p>
|
|
1858
1931
|
* <p> For more information about when Amazon S3 considers a bucket public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>. </p>
|
|
1859
1932
|
* <p>The following operations are related to <code>GetBucketPolicyStatus</code>:</p>
|
|
1860
1933
|
* <ul>
|
|
@@ -1923,7 +1996,8 @@ export declare class S3 extends S3Client {
|
|
|
1923
1996
|
/**
|
|
1924
1997
|
* @public
|
|
1925
1998
|
* <p>Returns the request payment configuration of a bucket. To use this version of the
|
|
1926
|
-
* operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
|
|
1999
|
+
* operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
|
|
2000
|
+
* Buckets</a>.</p>
|
|
1927
2001
|
* <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p>
|
|
1928
2002
|
* <ul>
|
|
1929
2003
|
* <li>
|
|
@@ -2005,8 +2079,7 @@ export declare class S3 extends S3Client {
|
|
|
2005
2079
|
* @public
|
|
2006
2080
|
* <p>Returns the website configuration for a bucket. To host website on Amazon S3, you can
|
|
2007
2081
|
* configure a bucket as website by adding a website configuration. For more information about
|
|
2008
|
-
* hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on
|
|
2009
|
-
* Amazon S3</a>. </p>
|
|
2082
|
+
* hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p>
|
|
2010
2083
|
* <p>This GET action requires the <code>S3:GetBucketWebsite</code> permission. By default,
|
|
2011
2084
|
* only the bucket owner can read the bucket website configuration. However, bucket owners can
|
|
2012
2085
|
* allow other users to read the website configuration by writing a bucket policy granting
|
|
@@ -2044,18 +2117,19 @@ export declare class S3 extends S3Client {
|
|
|
2044
2117
|
* have the object <code>photos/2006/February/sample.jpg</code> in the bucket named
|
|
2045
2118
|
* <code>examplebucket</code>, specify the resource as
|
|
2046
2119
|
* <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about
|
|
2047
|
-
* request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host
|
|
2120
|
+
* request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host
|
|
2121
|
+
* Header Bucket Specification</a>.</p>
|
|
2048
2122
|
* <p>For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>.</p>
|
|
2049
2123
|
* <p>If the object you are retrieving is stored in the S3 Glacier or
|
|
2050
2124
|
* S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or
|
|
2051
2125
|
* S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a
|
|
2052
2126
|
* copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this action returns an
|
|
2053
|
-
* <code>
|
|
2054
|
-
*
|
|
2055
|
-
* Objects</a>.</p>
|
|
2127
|
+
* <code>InvalidObjectState</code> error. For information about restoring archived objects,
|
|
2128
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
|
|
2129
|
+
* Archived Objects</a>.</p>
|
|
2056
2130
|
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not
|
|
2057
|
-
* be sent for GET requests if your object uses server-side encryption with KMS keys
|
|
2058
|
-
* or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your
|
|
2131
|
+
* be sent for GET requests if your object uses server-side encryption with KMS keys
|
|
2132
|
+
* (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your
|
|
2059
2133
|
* object does use these types of keys, you’ll get an HTTP 400 BadRequest error.</p>
|
|
2060
2134
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
2061
2135
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
|
|
@@ -2071,19 +2145,19 @@ export declare class S3 extends S3Client {
|
|
|
2071
2145
|
* <p>x-amz-server-side-encryption-customer-key-MD5</p>
|
|
2072
2146
|
* </li>
|
|
2073
2147
|
* </ul>
|
|
2074
|
-
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
2075
|
-
* Customer-Provided Encryption Keys)</a>.</p>
|
|
2076
|
-
* <p>Assuming you have the relevant permission to read object tags, the response also returns
|
|
2077
|
-
*
|
|
2148
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
2149
|
+
* (Using Customer-Provided Encryption Keys)</a>.</p>
|
|
2150
|
+
* <p>Assuming you have the relevant permission to read object tags, the response also returns
|
|
2151
|
+
* the <code>x-amz-tagging-count</code> header that provides the count of number of tags
|
|
2078
2152
|
* associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve
|
|
2079
2153
|
* the tag set associated with an object.</p>
|
|
2080
2154
|
* <p>
|
|
2081
2155
|
* <b>Permissions</b>
|
|
2082
2156
|
* </p>
|
|
2083
2157
|
* <p>You need the relevant read object (or version) permission for this operation. For more
|
|
2084
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions
|
|
2085
|
-
*
|
|
2086
|
-
*
|
|
2158
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
2159
|
+
* Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends
|
|
2160
|
+
* on whether you also have the <code>s3:ListBucket</code> permission.</p>
|
|
2087
2161
|
* <ul>
|
|
2088
2162
|
* <li>
|
|
2089
2163
|
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 will
|
|
@@ -2102,11 +2176,12 @@ export declare class S3 extends S3Client {
|
|
|
2102
2176
|
* <note>
|
|
2103
2177
|
* <ul>
|
|
2104
2178
|
* <li>
|
|
2105
|
-
* <p>
|
|
2106
|
-
*
|
|
2107
|
-
*
|
|
2108
|
-
*
|
|
2109
|
-
*
|
|
2179
|
+
* <p> If you supply a <code>versionId</code>, you need the
|
|
2180
|
+
* <code>s3:GetObjectVersion</code> permission to access a specific version of an
|
|
2181
|
+
* object. If you request a specific version, you do not need to have the
|
|
2182
|
+
* <code>s3:GetObject</code> permission. If you request the current version
|
|
2183
|
+
* without a specific version ID, only <code>s3:GetObject</code> permission is
|
|
2184
|
+
* required. <code>s3:GetObjectVersion</code> permission won't be required.</p>
|
|
2110
2185
|
* </li>
|
|
2111
2186
|
* <li>
|
|
2112
2187
|
* <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the
|
|
@@ -2211,10 +2286,11 @@ export declare class S3 extends S3Client {
|
|
|
2211
2286
|
* return ACL information about a different version, use the versionId subresource.</p>
|
|
2212
2287
|
* <note>
|
|
2213
2288
|
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
|
|
2214
|
-
* requests to read ACLs are still supported and return the
|
|
2215
|
-
*
|
|
2216
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">
|
|
2217
|
-
*
|
|
2289
|
+
* requests to read ACLs are still supported and return the
|
|
2290
|
+
* <code>bucket-owner-full-control</code> ACL with the owner being the account that
|
|
2291
|
+
* created the bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling object
|
|
2292
|
+
* ownership and disabling ACLs</a> in the
|
|
2293
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2218
2294
|
* </note>
|
|
2219
2295
|
* <p>The following operations are related to <code>GetObjectAcl</code>:</p>
|
|
2220
2296
|
* <ul>
|
|
@@ -2249,15 +2325,12 @@ export declare class S3 extends S3Client {
|
|
|
2249
2325
|
* action is useful if you're interested only in an object's metadata. To use
|
|
2250
2326
|
* <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
|
|
2251
2327
|
* <p>
|
|
2252
|
-
* <code>GetObjectAttributes</code> combines the functionality of
|
|
2253
|
-
*
|
|
2254
|
-
*
|
|
2255
|
-
* <code>GetObjectTagging</code>, <code>HeadObject</code>, and <code>ListParts</code>. All
|
|
2256
|
-
* of the data returned with each of those individual calls can be returned with a single call
|
|
2257
|
-
* to <code>GetObjectAttributes</code>.</p>
|
|
2328
|
+
* <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code>
|
|
2329
|
+
* and <code>ListParts</code>. All of the data returned with each of those individual calls
|
|
2330
|
+
* can be returned with a single call to <code>GetObjectAttributes</code>.</p>
|
|
2258
2331
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
2259
|
-
*
|
|
2260
|
-
*
|
|
2332
|
+
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
|
|
2333
|
+
* metadata from the object, you must use the following headers:</p>
|
|
2261
2334
|
* <ul>
|
|
2262
2335
|
* <li>
|
|
2263
2336
|
* <p>
|
|
@@ -2281,25 +2354,24 @@ export declare class S3 extends S3Client {
|
|
|
2281
2354
|
* <note>
|
|
2282
2355
|
* <ul>
|
|
2283
2356
|
* <li>
|
|
2284
|
-
* <p>Encryption request headers, such as
|
|
2285
|
-
*
|
|
2286
|
-
*
|
|
2287
|
-
*
|
|
2288
|
-
*
|
|
2289
|
-
* an HTTP <code>400 Bad Request</code> error.</p>
|
|
2357
|
+
* <p>Encryption request headers, such as <code>x-amz-server-side-encryption</code>,
|
|
2358
|
+
* should not be sent for GET requests if your object uses server-side encryption
|
|
2359
|
+
* with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or
|
|
2360
|
+
* server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use
|
|
2361
|
+
* these types of keys, you'll get an HTTP <code>400 Bad Request</code> error.</p>
|
|
2290
2362
|
* </li>
|
|
2291
2363
|
* <li>
|
|
2292
|
-
* <p>
|
|
2293
|
-
*
|
|
2364
|
+
* <p> The last modified property in this case is the creation date of the
|
|
2365
|
+
* object.</p>
|
|
2294
2366
|
* </li>
|
|
2295
2367
|
* </ul>
|
|
2296
2368
|
* </note>
|
|
2297
2369
|
* <p>Consider the following when using request headers:</p>
|
|
2298
2370
|
* <ul>
|
|
2299
2371
|
* <li>
|
|
2300
|
-
* <p> If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
|
|
2301
|
-
*
|
|
2302
|
-
*
|
|
2372
|
+
* <p> If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers
|
|
2373
|
+
* are present in the request as follows, then Amazon S3 returns the HTTP status code
|
|
2374
|
+
* <code>200 OK</code> and the data requested:</p>
|
|
2303
2375
|
* <ul>
|
|
2304
2376
|
* <li>
|
|
2305
2377
|
* <p>
|
|
@@ -2308,24 +2380,23 @@ export declare class S3 extends S3Client {
|
|
|
2308
2380
|
* <li>
|
|
2309
2381
|
* <p>
|
|
2310
2382
|
* <code>If-Unmodified-Since</code> condition evaluates to
|
|
2311
|
-
*
|
|
2383
|
+
* <code>false</code>.</p>
|
|
2312
2384
|
* </li>
|
|
2313
2385
|
* </ul>
|
|
2314
2386
|
* </li>
|
|
2315
2387
|
* <li>
|
|
2316
2388
|
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
|
|
2317
2389
|
* headers are present in the request as follows, then Amazon S3 returns the HTTP status code
|
|
2318
|
-
*
|
|
2390
|
+
* <code>304 Not Modified</code>:</p>
|
|
2319
2391
|
* <ul>
|
|
2320
2392
|
* <li>
|
|
2321
2393
|
* <p>
|
|
2322
|
-
* <code>If-None-Match</code> condition evaluates to
|
|
2323
|
-
* <code>false</code>.</p>
|
|
2394
|
+
* <code>If-None-Match</code> condition evaluates to <code>false</code>.</p>
|
|
2324
2395
|
* </li>
|
|
2325
2396
|
* <li>
|
|
2326
2397
|
* <p>
|
|
2327
2398
|
* <code>If-Modified-Since</code> condition evaluates to
|
|
2328
|
-
*
|
|
2399
|
+
* <code>true</code>.</p>
|
|
2329
2400
|
* </li>
|
|
2330
2401
|
* </ul>
|
|
2331
2402
|
* </li>
|
|
@@ -2344,12 +2415,12 @@ export declare class S3 extends S3Client {
|
|
|
2344
2415
|
* have the <code>s3:ListBucket</code> permission.</p>
|
|
2345
2416
|
* <ul>
|
|
2346
2417
|
* <li>
|
|
2347
|
-
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
|
|
2348
|
-
*
|
|
2418
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
|
|
2419
|
+
* an HTTP status code <code>404 Not Found</code> ("no such key") error.</p>
|
|
2349
2420
|
* </li>
|
|
2350
2421
|
* <li>
|
|
2351
|
-
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an
|
|
2352
|
-
*
|
|
2422
|
+
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP
|
|
2423
|
+
* status code <code>403 Forbidden</code> ("access denied") error.</p>
|
|
2353
2424
|
* </li>
|
|
2354
2425
|
* </ul>
|
|
2355
2426
|
* <p>The following actions are related to <code>GetObjectAttributes</code>:</p>
|
|
@@ -2420,8 +2491,7 @@ export declare class S3 extends S3Client {
|
|
|
2420
2491
|
* @public
|
|
2421
2492
|
* <p>Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock
|
|
2422
2493
|
* configuration will be applied by default to every new object placed in the specified
|
|
2423
|
-
* bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
2424
|
-
* Objects</a>.</p>
|
|
2494
|
+
* bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p>
|
|
2425
2495
|
* <p>The following action is related to <code>GetObjectLockConfiguration</code>:</p>
|
|
2426
2496
|
* <ul>
|
|
2427
2497
|
* <li>
|
|
@@ -2436,7 +2506,8 @@ export declare class S3 extends S3Client {
|
|
|
2436
2506
|
getObjectLockConfiguration(args: GetObjectLockConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetObjectLockConfigurationCommandOutput) => void): void;
|
|
2437
2507
|
/**
|
|
2438
2508
|
* @public
|
|
2439
|
-
* <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
2509
|
+
* <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
2510
|
+
* Objects</a>.</p>
|
|
2440
2511
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
2441
2512
|
* <p>The following action is related to <code>GetObjectRetention</code>:</p>
|
|
2442
2513
|
* <ul>
|
|
@@ -2455,11 +2526,11 @@ export declare class S3 extends S3Client {
|
|
|
2455
2526
|
* <p>Returns the tag-set of an object. You send the GET request against the tagging
|
|
2456
2527
|
* subresource associated with the object.</p>
|
|
2457
2528
|
* <p>To use this operation, you must have permission to perform the
|
|
2458
|
-
* <code>s3:GetObjectTagging</code> action. By default, the GET action returns
|
|
2459
|
-
*
|
|
2460
|
-
*
|
|
2461
|
-
*
|
|
2462
|
-
*
|
|
2529
|
+
* <code>s3:GetObjectTagging</code> action. By default, the GET action returns information
|
|
2530
|
+
* about current version of an object. For a versioned bucket, you can have multiple versions
|
|
2531
|
+
* of an object in your bucket. To retrieve tags of any other version, use the versionId query
|
|
2532
|
+
* parameter. You also need permission for the <code>s3:GetObjectVersionTagging</code>
|
|
2533
|
+
* action.</p>
|
|
2463
2534
|
* <p> By default, the bucket owner has this permission and can grant this permission to
|
|
2464
2535
|
* others.</p>
|
|
2465
2536
|
* <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
|
|
@@ -2488,7 +2559,7 @@ export declare class S3 extends S3Client {
|
|
|
2488
2559
|
/**
|
|
2489
2560
|
* @public
|
|
2490
2561
|
* <p>Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're
|
|
2491
|
-
* distributing large files
|
|
2562
|
+
* distributing large files.</p>
|
|
2492
2563
|
* <note>
|
|
2493
2564
|
* <p>You can get torrent only for objects that are less than 5 GB in size, and that are
|
|
2494
2565
|
* not encrypted using server-side encryption with a customer-provided encryption
|
|
@@ -2513,7 +2584,7 @@ export declare class S3 extends S3Client {
|
|
|
2513
2584
|
* <p>Retrieves the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket. To use
|
|
2514
2585
|
* this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
|
|
2515
2586
|
* For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
2516
|
-
*
|
|
2587
|
+
* Policy</a>.</p>
|
|
2517
2588
|
* <important>
|
|
2518
2589
|
* <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
|
|
2519
2590
|
* an object, it checks the <code>PublicAccessBlock</code> configuration for both the
|
|
@@ -2553,31 +2624,38 @@ export declare class S3 extends S3Client {
|
|
|
2553
2624
|
getPublicAccessBlock(args: GetPublicAccessBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicAccessBlockCommandOutput) => void): void;
|
|
2554
2625
|
/**
|
|
2555
2626
|
* @public
|
|
2556
|
-
* <p>This action is useful to determine if a bucket exists and you have permission to
|
|
2557
|
-
*
|
|
2558
|
-
*
|
|
2559
|
-
* <p>If the bucket does not exist or you do not have permission to access it, the
|
|
2560
|
-
*
|
|
2561
|
-
*
|
|
2627
|
+
* <p>This action is useful to determine if a bucket exists and you have permission to access
|
|
2628
|
+
* it. The action returns a <code>200 OK</code> if the bucket exists and you have permission
|
|
2629
|
+
* to access it.</p>
|
|
2630
|
+
* <p>If the bucket does not exist or you do not have permission to access it, the
|
|
2631
|
+
* <code>HEAD</code> request returns a generic <code>400 Bad Request</code>, <code>403
|
|
2632
|
+
* Forbidden</code> or <code>404 Not Found</code> code. A message body is not included, so
|
|
2633
|
+
* you cannot determine the exception beyond these error codes.</p>
|
|
2562
2634
|
* <p>To use this operation, you must have permissions to perform the
|
|
2563
2635
|
* <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
|
|
2564
|
-
* can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2565
|
-
* Resources</a>.</p>
|
|
2566
|
-
* <p>To use this API against an access point, you must provide the alias of the access point in place of the
|
|
2636
|
+
* can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2637
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
2638
|
+
* <p>To use this API against an access point, you must provide the alias of the access point in place of the
|
|
2639
|
+
* bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to
|
|
2640
|
+
* the access point hostname. The access point hostname takes the form
|
|
2641
|
+
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs,
|
|
2642
|
+
* you provide the ARN in place of the bucket name. For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using
|
|
2643
|
+
* access points</a>.</p>
|
|
2567
2644
|
*/
|
|
2568
2645
|
headBucket(args: HeadBucketCommandInput, options?: __HttpHandlerOptions): Promise<HeadBucketCommandOutput>;
|
|
2569
2646
|
headBucket(args: HeadBucketCommandInput, cb: (err: any, data?: HeadBucketCommandOutput) => void): void;
|
|
2570
2647
|
headBucket(args: HeadBucketCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: HeadBucketCommandOutput) => void): void;
|
|
2571
2648
|
/**
|
|
2572
2649
|
* @public
|
|
2573
|
-
* <p>The HEAD action retrieves metadata from an object without returning the object
|
|
2574
|
-
*
|
|
2575
|
-
*
|
|
2650
|
+
* <p>The HEAD action retrieves metadata from an object without returning the object itself.
|
|
2651
|
+
* This action is useful if you're only interested in an object's metadata. To use HEAD, you
|
|
2652
|
+
* must have READ access to the object.</p>
|
|
2576
2653
|
* <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an
|
|
2577
2654
|
* object. The response is identical to the <code>GET</code> response except that there is no
|
|
2578
2655
|
* response body. Because of this, if the <code>HEAD</code> request generates an error, it
|
|
2579
|
-
* returns a generic <code>
|
|
2580
|
-
*
|
|
2656
|
+
* returns a generic <code>400 Bad Request</code>, <code>403 Forbidden</code> or <code>404 Not
|
|
2657
|
+
* Found</code> code. It is not possible to retrieve the exact exception beyond these error
|
|
2658
|
+
* codes.</p>
|
|
2581
2659
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
2582
2660
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
|
|
2583
2661
|
* metadata from the object, you must use the following headers:</p>
|
|
@@ -2592,25 +2670,25 @@ export declare class S3 extends S3Client {
|
|
|
2592
2670
|
* <p>x-amz-server-side-encryption-customer-key-MD5</p>
|
|
2593
2671
|
* </li>
|
|
2594
2672
|
* </ul>
|
|
2595
|
-
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
2596
|
-
* Customer-Provided Encryption Keys)</a>.</p>
|
|
2673
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
2674
|
+
* (Using Customer-Provided Encryption Keys)</a>.</p>
|
|
2597
2675
|
* <note>
|
|
2598
2676
|
* <ul>
|
|
2599
2677
|
* <li>
|
|
2600
|
-
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
2601
|
-
*
|
|
2602
|
-
*
|
|
2603
|
-
*
|
|
2604
|
-
*
|
|
2678
|
+
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>,
|
|
2679
|
+
* should not be sent for GET requests if your object uses server-side encryption
|
|
2680
|
+
* with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption
|
|
2681
|
+
* keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
|
|
2682
|
+
* BadRequest error.</p>
|
|
2605
2683
|
* </li>
|
|
2606
2684
|
* <li>
|
|
2607
|
-
* <p>
|
|
2608
|
-
*
|
|
2685
|
+
* <p> The last modified property in this case is the creation date of the
|
|
2686
|
+
* object.</p>
|
|
2609
2687
|
* </li>
|
|
2610
2688
|
* </ul>
|
|
2611
2689
|
* </note>
|
|
2612
|
-
* <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common
|
|
2613
|
-
* Headers</a>.</p>
|
|
2690
|
+
* <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common
|
|
2691
|
+
* Request Headers</a>.</p>
|
|
2614
2692
|
* <p>Consider the following when using request headers:</p>
|
|
2615
2693
|
* <ul>
|
|
2616
2694
|
* <li>
|
|
@@ -2654,9 +2732,9 @@ export declare class S3 extends S3Client {
|
|
|
2654
2732
|
* <b>Permissions</b>
|
|
2655
2733
|
* </p>
|
|
2656
2734
|
* <p>You need the relevant read object (or version) permission for this operation. For more
|
|
2657
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions
|
|
2658
|
-
*
|
|
2659
|
-
*
|
|
2735
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
2736
|
+
* Policy</a>. If the object you request does not exist, the error Amazon S3 returns depends
|
|
2737
|
+
* on whether you also have the s3:ListBucket permission.</p>
|
|
2660
2738
|
* <ul>
|
|
2661
2739
|
* <li>
|
|
2662
2740
|
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns
|
|
@@ -2688,8 +2766,8 @@ export declare class S3 extends S3Client {
|
|
|
2688
2766
|
* @public
|
|
2689
2767
|
* <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
|
|
2690
2768
|
* configurations per bucket.</p>
|
|
2691
|
-
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
2692
|
-
*
|
|
2769
|
+
* <p>This action supports list pagination and does not return more than 100 configurations at
|
|
2770
|
+
* a time. You should always check the <code>IsTruncated</code> element in the response. If
|
|
2693
2771
|
* there are no more configurations to list, <code>IsTruncated</code> is set to false. If
|
|
2694
2772
|
* there are more configurations to list, <code>IsTruncated</code> is set to true, and there
|
|
2695
2773
|
* will be a value in <code>NextContinuationToken</code>. You use the
|
|
@@ -2699,8 +2777,8 @@ export declare class S3 extends S3Client {
|
|
|
2699
2777
|
* <p>To use this operation, you must have permissions to perform the
|
|
2700
2778
|
* <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
2701
2779
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
2702
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2703
|
-
* Resources</a>.</p>
|
|
2780
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2781
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
2704
2782
|
* <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
|
|
2705
2783
|
* Analysis</a>. </p>
|
|
2706
2784
|
* <p>The following operations are related to
|
|
@@ -2732,8 +2810,7 @@ export declare class S3 extends S3Client {
|
|
|
2732
2810
|
* <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
|
|
2733
2811
|
* <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p>
|
|
2734
2812
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
|
|
2735
|
-
* <p>Operations related to
|
|
2736
|
-
* <code>ListBucketIntelligentTieringConfigurations</code> include: </p>
|
|
2813
|
+
* <p>Operations related to <code>ListBucketIntelligentTieringConfigurations</code> include: </p>
|
|
2737
2814
|
* <ul>
|
|
2738
2815
|
* <li>
|
|
2739
2816
|
* <p>
|
|
@@ -2759,9 +2836,9 @@ export declare class S3 extends S3Client {
|
|
|
2759
2836
|
* @public
|
|
2760
2837
|
* <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000
|
|
2761
2838
|
* analytics configurations per bucket.</p>
|
|
2762
|
-
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
2763
|
-
*
|
|
2764
|
-
*
|
|
2839
|
+
* <p>This action supports list pagination and does not return more than 100 configurations at
|
|
2840
|
+
* a time. Always check the <code>IsTruncated</code> element in the response. If there are no
|
|
2841
|
+
* more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
2765
2842
|
* configurations to list, <code>IsTruncated</code> is set to true, and there is a value in
|
|
2766
2843
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
2767
2844
|
* to continue the pagination of the list by passing the value in continuation-token in the
|
|
@@ -2769,8 +2846,8 @@ export declare class S3 extends S3Client {
|
|
|
2769
2846
|
* <p> To use this operation, you must have permissions to perform the
|
|
2770
2847
|
* <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
|
|
2771
2848
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
2772
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2773
|
-
* Resources</a>.</p>
|
|
2849
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2850
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
2774
2851
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>
|
|
2775
2852
|
* </p>
|
|
2776
2853
|
* <p>The following operations are related to
|
|
@@ -2801,9 +2878,9 @@ export declare class S3 extends S3Client {
|
|
|
2801
2878
|
* <p>Lists the metrics configurations for the bucket. The metrics configurations are only for
|
|
2802
2879
|
* the request metrics of the bucket and do not provide information on daily storage metrics.
|
|
2803
2880
|
* You can have up to 1,000 configurations per bucket.</p>
|
|
2804
|
-
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
2805
|
-
*
|
|
2806
|
-
*
|
|
2881
|
+
* <p>This action supports list pagination and does not return more than 100 configurations at
|
|
2882
|
+
* a time. Always check the <code>IsTruncated</code> element in the response. If there are no
|
|
2883
|
+
* more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
2807
2884
|
* configurations to list, <code>IsTruncated</code> is set to true, and there is a value in
|
|
2808
2885
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
2809
2886
|
* to continue the pagination of the list by passing the value in
|
|
@@ -2811,11 +2888,10 @@ export declare class S3 extends S3Client {
|
|
|
2811
2888
|
* <p>To use this operation, you must have permissions to perform the
|
|
2812
2889
|
* <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
2813
2890
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
2814
|
-
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2815
|
-
* Resources</a>.</p>
|
|
2891
|
+
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
2892
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
2816
2893
|
* <p>For more information about metrics configurations and CloudWatch request metrics, see
|
|
2817
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
2818
|
-
* CloudWatch</a>.</p>
|
|
2894
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p>
|
|
2819
2895
|
* <p>The following operations are related to
|
|
2820
2896
|
* <code>ListBucketMetricsConfigurations</code>:</p>
|
|
2821
2897
|
* <ul>
|
|
@@ -2842,7 +2918,9 @@ export declare class S3 extends S3Client {
|
|
|
2842
2918
|
/**
|
|
2843
2919
|
* @public
|
|
2844
2920
|
* <p>Returns a list of all buckets owned by the authenticated sender of the request. To use
|
|
2845
|
-
*
|
|
2921
|
+
* this operation, you must have the <code>s3:ListAllMyBuckets</code> permission. </p>
|
|
2922
|
+
* <p>For information about Amazon S3 buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and
|
|
2923
|
+
* working with Amazon S3 buckets</a>.</p>
|
|
2846
2924
|
*/
|
|
2847
2925
|
listBuckets(args: ListBucketsCommandInput, options?: __HttpHandlerOptions): Promise<ListBucketsCommandOutput>;
|
|
2848
2926
|
listBuckets(args: ListBucketsCommandInput, cb: (err: any, data?: ListBucketsCommandOutput) => void): void;
|
|
@@ -2865,8 +2943,8 @@ export declare class S3 extends S3Client {
|
|
|
2865
2943
|
* upload initiation time.</p>
|
|
2866
2944
|
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
2867
2945
|
* Upload</a>.</p>
|
|
2868
|
-
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
2869
|
-
*
|
|
2946
|
+
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
2947
|
+
* and Permissions</a>.</p>
|
|
2870
2948
|
* <p>The following operations are related to <code>ListMultipartUploads</code>:</p>
|
|
2871
2949
|
* <ul>
|
|
2872
2950
|
* <li>
|
|
@@ -2943,24 +3021,23 @@ export declare class S3 extends S3Client {
|
|
|
2943
3021
|
listObjects(args: ListObjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectsCommandOutput) => void): void;
|
|
2944
3022
|
/**
|
|
2945
3023
|
* @public
|
|
2946
|
-
* <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can
|
|
2947
|
-
* the request parameters as selection criteria to return a subset of the objects in a
|
|
2948
|
-
* <code>200 OK</code> response can contain valid or invalid XML. Make sure to
|
|
2949
|
-
* application to parse the contents of the response and handle it appropriately.
|
|
3024
|
+
* <p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can
|
|
3025
|
+
* use the request parameters as selection criteria to return a subset of the objects in a
|
|
3026
|
+
* bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to
|
|
3027
|
+
* design your application to parse the contents of the response and handle it appropriately.
|
|
2950
3028
|
* Objects are returned sorted in an ascending order of the respective key names in the list.
|
|
2951
3029
|
* For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys
|
|
2952
3030
|
* programmatically</a>
|
|
2953
3031
|
* </p>
|
|
2954
3032
|
* <p>To use this operation, you must have READ access to the bucket.</p>
|
|
2955
|
-
* <p>To use this action in an Identity and Access Management (IAM) policy, you must
|
|
2956
|
-
*
|
|
2957
|
-
*
|
|
2958
|
-
*
|
|
2959
|
-
* Resources</a>.</p>
|
|
3033
|
+
* <p>To use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform
|
|
3034
|
+
* the <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
|
|
3035
|
+
* can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
3036
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
2960
3037
|
* <important>
|
|
2961
|
-
* <p>This section describes the latest revision of this action. We recommend that you use
|
|
2962
|
-
* revised API for application development. For backward compatibility, Amazon S3 continues
|
|
2963
|
-
* support the prior version of this API, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
|
|
3038
|
+
* <p>This section describes the latest revision of this action. We recommend that you use
|
|
3039
|
+
* this revised API for application development. For backward compatibility, Amazon S3 continues
|
|
3040
|
+
* to support the prior version of this API, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
|
|
2964
3041
|
* </important>
|
|
2965
3042
|
* <p>To get a list of your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p>
|
|
2966
3043
|
* <p>The following operations are related to <code>ListObjectsV2</code>:</p>
|
|
@@ -2991,10 +3068,8 @@ export declare class S3 extends S3Client {
|
|
|
2991
3068
|
* parameters as selection criteria to return metadata about a subset of all the object
|
|
2992
3069
|
* versions.</p>
|
|
2993
3070
|
* <important>
|
|
2994
|
-
* <p>
|
|
2995
|
-
*
|
|
2996
|
-
* <code>s3:ListBucketVersions</code> action. Be aware of the name difference.
|
|
2997
|
-
* </p>
|
|
3071
|
+
* <p> To use this operation, you must have permissions to perform the
|
|
3072
|
+
* <code>s3:ListBucketVersions</code> action. Be aware of the name difference. </p>
|
|
2998
3073
|
* </important>
|
|
2999
3074
|
* <note>
|
|
3000
3075
|
* <p> A 200 OK response can contain valid or invalid XML. Make sure to design your
|
|
@@ -3002,8 +3077,7 @@ export declare class S3 extends S3Client {
|
|
|
3002
3077
|
* </note>
|
|
3003
3078
|
* <p>To use this operation, you must have READ access to the bucket.</p>
|
|
3004
3079
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
3005
|
-
* <p>The following operations are related to
|
|
3006
|
-
* <code>ListObjectVersions</code>:</p>
|
|
3080
|
+
* <p>The following operations are related to <code>ListObjectVersions</code>:</p>
|
|
3007
3081
|
* <ul>
|
|
3008
3082
|
* <li>
|
|
3009
3083
|
* <p>
|
|
@@ -3043,12 +3117,11 @@ export declare class S3 extends S3Client {
|
|
|
3043
3117
|
* requests you can include the part-number-marker query string parameter and set its value to
|
|
3044
3118
|
* the <code>NextPartNumberMarker</code> field value from the previous response.</p>
|
|
3045
3119
|
* <p>If the upload was created using a checksum algorithm, you will need to have permission
|
|
3046
|
-
*
|
|
3047
|
-
* </p>
|
|
3120
|
+
* to the <code>kms:Decrypt</code> action for the request to succeed. </p>
|
|
3048
3121
|
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
3049
3122
|
* Upload</a>.</p>
|
|
3050
|
-
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
3051
|
-
*
|
|
3123
|
+
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
3124
|
+
* and Permissions</a>.</p>
|
|
3052
3125
|
* <p>The following operations are related to <code>ListParts</code>:</p>
|
|
3053
3126
|
* <ul>
|
|
3054
3127
|
* <li>
|
|
@@ -3105,13 +3178,14 @@ export declare class S3 extends S3Client {
|
|
|
3105
3178
|
* <p> Suspended – Disables accelerated data transfers to the bucket.</p>
|
|
3106
3179
|
* </li>
|
|
3107
3180
|
* </ul>
|
|
3108
|
-
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration
|
|
3109
|
-
*
|
|
3181
|
+
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration state
|
|
3182
|
+
* of a bucket.</p>
|
|
3110
3183
|
* <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up
|
|
3111
3184
|
* to thirty minutes before the data transfer rates to the bucket increase.</p>
|
|
3112
3185
|
* <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
|
|
3113
3186
|
* not contain periods (".").</p>
|
|
3114
|
-
* <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
|
|
3187
|
+
* <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer
|
|
3188
|
+
* Acceleration</a>.</p>
|
|
3115
3189
|
* <p>The following operations are related to
|
|
3116
3190
|
* <code>PutBucketAccelerateConfiguration</code>:</p>
|
|
3117
3191
|
* <ul>
|
|
@@ -3133,8 +3207,8 @@ export declare class S3 extends S3Client {
|
|
|
3133
3207
|
/**
|
|
3134
3208
|
* @public
|
|
3135
3209
|
* <p>Sets the permissions on an existing bucket using access control lists (ACL). For more
|
|
3136
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set
|
|
3137
|
-
*
|
|
3210
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set the ACL of a
|
|
3211
|
+
* bucket, you must have <code>WRITE_ACP</code> permission.</p>
|
|
3138
3212
|
* <p>You can use one of the following two ways to set a bucket's permissions:</p>
|
|
3139
3213
|
* <ul>
|
|
3140
3214
|
* <li>
|
|
@@ -3153,11 +3227,12 @@ export declare class S3 extends S3Client {
|
|
|
3153
3227
|
* that updates a bucket ACL using the request body, then you can continue to use that
|
|
3154
3228
|
* approach.</p>
|
|
3155
3229
|
* <important>
|
|
3156
|
-
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
|
|
3157
|
-
*
|
|
3158
|
-
*
|
|
3159
|
-
*
|
|
3160
|
-
*
|
|
3230
|
+
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
|
|
3231
|
+
* are disabled and no longer affect permissions. You must use policies to grant access to
|
|
3232
|
+
* your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return
|
|
3233
|
+
* the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are
|
|
3234
|
+
* still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object
|
|
3235
|
+
* ownership</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3161
3236
|
* </important>
|
|
3162
3237
|
* <p>
|
|
3163
3238
|
* <b>Access Permissions</b>
|
|
@@ -3169,7 +3244,8 @@ export declare class S3 extends S3Client {
|
|
|
3169
3244
|
* a set of predefined ACLs, known as <i>canned ACLs</i>. Each canned ACL
|
|
3170
3245
|
* has a predefined set of grantees and permissions. Specify the canned ACL name as the
|
|
3171
3246
|
* value of <code>x-amz-acl</code>. If you use this header, you cannot use other access
|
|
3172
|
-
* control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
3247
|
+
* control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
3248
|
+
* ACL</a>.</p>
|
|
3173
3249
|
* </li>
|
|
3174
3250
|
* <li>
|
|
3175
3251
|
* <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
|
|
@@ -3178,14 +3254,15 @@ export declare class S3 extends S3Client {
|
|
|
3178
3254
|
* specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who
|
|
3179
3255
|
* will receive the permission. If you use these ACL-specific headers, you cannot use
|
|
3180
3256
|
* the <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the
|
|
3181
|
-
* set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
|
|
3182
|
-
*
|
|
3257
|
+
* set of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
|
|
3258
|
+
* List (ACL) Overview</a>.</p>
|
|
3183
3259
|
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
3184
3260
|
* following:</p>
|
|
3185
3261
|
* <ul>
|
|
3186
3262
|
* <li>
|
|
3187
3263
|
* <p>
|
|
3188
|
-
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
3264
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
3265
|
+
* Amazon Web Services account</p>
|
|
3189
3266
|
* </li>
|
|
3190
3267
|
* <li>
|
|
3191
3268
|
* <p>
|
|
@@ -3265,7 +3342,7 @@ export declare class S3 extends S3Client {
|
|
|
3265
3342
|
* <p>By Email address:</p>
|
|
3266
3343
|
* <p>
|
|
3267
3344
|
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
3268
|
-
* xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress
|
|
3345
|
+
* xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code>
|
|
3269
3346
|
* </p>
|
|
3270
3347
|
* <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object
|
|
3271
3348
|
* acl request, appears as the CanonicalUser. </p>
|
|
@@ -3335,8 +3412,8 @@ export declare class S3 extends S3Client {
|
|
|
3335
3412
|
* selecting data export, you specify a destination bucket and an optional destination prefix
|
|
3336
3413
|
* where the file is written. You can export the data to a destination bucket in a different
|
|
3337
3414
|
* account. However, the destination bucket must be in the same Region as the bucket that you
|
|
3338
|
-
* are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3
|
|
3339
|
-
* Analysis</a>. </p>
|
|
3415
|
+
* are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3
|
|
3416
|
+
* Analytics – Storage Class Analysis</a>. </p>
|
|
3340
3417
|
* <important>
|
|
3341
3418
|
* <p>You must create a bucket policy on the destination bucket where the exported file is
|
|
3342
3419
|
* written to grant permissions to Amazon S3 to write objects to the bucket. For an example
|
|
@@ -3345,8 +3422,8 @@ export declare class S3 extends S3Client {
|
|
|
3345
3422
|
* <p>To use this operation, you must have permissions to perform the
|
|
3346
3423
|
* <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
3347
3424
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
3348
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
3349
|
-
* Resources</a>.</p>
|
|
3425
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
3426
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
3350
3427
|
* <p class="title">
|
|
3351
3428
|
* <b>Special Errors</b>
|
|
3352
3429
|
* </p>
|
|
@@ -3472,8 +3549,8 @@ export declare class S3 extends S3Client {
|
|
|
3472
3549
|
* </p>
|
|
3473
3550
|
* </li>
|
|
3474
3551
|
* </ul>
|
|
3475
|
-
* <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
3476
|
-
*
|
|
3552
|
+
* <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in
|
|
3553
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3477
3554
|
* <p class="title">
|
|
3478
3555
|
* <b>Related Resources</b>
|
|
3479
3556
|
* </p>
|
|
@@ -3500,25 +3577,27 @@ export declare class S3 extends S3Client {
|
|
|
3500
3577
|
putBucketCors(args: PutBucketCorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketCorsCommandOutput) => void): void;
|
|
3501
3578
|
/**
|
|
3502
3579
|
* @public
|
|
3503
|
-
* <p>This action uses the <code>encryption</code> subresource to configure default
|
|
3504
|
-
*
|
|
3505
|
-
* <p>
|
|
3506
|
-
*
|
|
3507
|
-
*
|
|
3508
|
-
*
|
|
3509
|
-
*
|
|
3510
|
-
*
|
|
3511
|
-
*
|
|
3512
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
3580
|
+
* <p>This action uses the <code>encryption</code> subresource to configure default encryption
|
|
3581
|
+
* and Amazon S3 Bucket Keys for an existing bucket.</p>
|
|
3582
|
+
* <p>By default, all buckets have a default encryption configuration that
|
|
3583
|
+
* uses server-side encryption with Amazon S3 managed keys (SSE-S3).
|
|
3584
|
+
* You can optionally configure default encryption for a bucket by using server-side
|
|
3585
|
+
* encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). If you specify default encryption by using
|
|
3586
|
+
* SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default encryption,
|
|
3587
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3
|
|
3588
|
+
* bucket default encryption</a> in the <i>Amazon S3 User Guide</i>. For more
|
|
3589
|
+
* information about S3 Bucket Keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
3590
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
3513
3591
|
* <important>
|
|
3514
|
-
* <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">
|
|
3515
|
-
* Version 4)</a>. </p>
|
|
3592
|
+
* <p>This action requires Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">
|
|
3593
|
+
* Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p>
|
|
3516
3594
|
* </important>
|
|
3517
3595
|
* <p>To use this operation, you must have permissions to perform the
|
|
3518
3596
|
* <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission
|
|
3519
3597
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
3520
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
3521
|
-
*
|
|
3598
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
3599
|
+
* Access Permissions to Your Amazon S3 Resources</a> in the
|
|
3600
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
3522
3601
|
* <p class="title">
|
|
3523
3602
|
* <b>Related Resources</b>
|
|
3524
3603
|
* </p>
|
|
@@ -3540,13 +3619,12 @@ export declare class S3 extends S3Client {
|
|
|
3540
3619
|
putBucketEncryption(args: PutBucketEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBucketEncryptionCommandOutput) => void): void;
|
|
3541
3620
|
/**
|
|
3542
3621
|
* @public
|
|
3543
|
-
* <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket.
|
|
3544
|
-
*
|
|
3622
|
+
* <p>Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to
|
|
3623
|
+
* 1,000 S3 Intelligent-Tiering configurations per bucket.</p>
|
|
3545
3624
|
* <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
|
|
3546
3625
|
* <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p>
|
|
3547
3626
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
|
|
3548
|
-
* <p>Operations related to
|
|
3549
|
-
* <code>PutBucketIntelligentTieringConfiguration</code> include: </p>
|
|
3627
|
+
* <p>Operations related to <code>PutBucketIntelligentTieringConfiguration</code> include: </p>
|
|
3550
3628
|
* <ul>
|
|
3551
3629
|
* <li>
|
|
3552
3630
|
* <p>
|
|
@@ -3566,8 +3644,8 @@ export declare class S3 extends S3Client {
|
|
|
3566
3644
|
* </ul>
|
|
3567
3645
|
* <note>
|
|
3568
3646
|
* <p>You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically
|
|
3569
|
-
* move objects stored in the S3 Intelligent-Tiering storage class to the
|
|
3570
|
-
*
|
|
3647
|
+
* move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access
|
|
3648
|
+
* or Deep Archive Access tier.</p>
|
|
3571
3649
|
* </note>
|
|
3572
3650
|
* <p class="title">
|
|
3573
3651
|
* <b>Special Errors</b>
|
|
@@ -3616,8 +3694,8 @@ export declare class S3 extends S3Client {
|
|
|
3616
3694
|
* <li>
|
|
3617
3695
|
* <p>
|
|
3618
3696
|
* <i>Cause:</i> You are not the owner of the specified bucket,
|
|
3619
|
-
* or you do not have the <code>s3:PutIntelligentTieringConfiguration</code>
|
|
3620
|
-
* permission to set the configuration on the bucket. </p>
|
|
3697
|
+
* or you do not have the <code>s3:PutIntelligentTieringConfiguration</code>
|
|
3698
|
+
* bucket permission to set the configuration on the bucket. </p>
|
|
3621
3699
|
* </li>
|
|
3622
3700
|
* </ul>
|
|
3623
3701
|
* </li>
|
|
@@ -3641,19 +3719,31 @@ export declare class S3 extends S3Client {
|
|
|
3641
3719
|
* the <i>destination</i> bucket where you want the inventory to be stored, and
|
|
3642
3720
|
* whether to generate the inventory daily or weekly. You can also configure what object
|
|
3643
3721
|
* metadata to include and whether to inventory all object versions or only current versions.
|
|
3644
|
-
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3
|
|
3645
|
-
*
|
|
3722
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a> in the
|
|
3723
|
+
* Amazon S3 User Guide.</p>
|
|
3646
3724
|
* <important>
|
|
3647
3725
|
* <p>You must create a bucket policy on the <i>destination</i> bucket to
|
|
3648
3726
|
* grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an
|
|
3649
|
-
* example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">
|
|
3650
|
-
* Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p>
|
|
3727
|
+
* example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9"> Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p>
|
|
3651
3728
|
* </important>
|
|
3652
|
-
* <p>
|
|
3729
|
+
* <p>
|
|
3730
|
+
* <b>Permissions</b>
|
|
3731
|
+
* </p>
|
|
3732
|
+
* <p>To use this operation, you must have permission to perform the
|
|
3653
3733
|
* <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission
|
|
3654
|
-
* by default and can grant this permission to others.
|
|
3655
|
-
*
|
|
3656
|
-
*
|
|
3734
|
+
* by default and can grant this permission to others. </p>
|
|
3735
|
+
* <p>The <code>s3:PutInventoryConfiguration</code> permission allows a user to create an
|
|
3736
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html">S3
|
|
3737
|
+
* Inventory</a> report that includes all object metadata fields available and to
|
|
3738
|
+
* specify the destination bucket to store the inventory. A user with read access to objects
|
|
3739
|
+
* in the destination bucket can also access all object metadata fields that are available in
|
|
3740
|
+
* the inventory report. </p>
|
|
3741
|
+
* <p>To restrict access to an inventory report, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html#example-bucket-policies-use-case-10">Restricting access to an Amazon S3 Inventory report</a> in the
|
|
3742
|
+
* <i>Amazon S3 User Guide</i>. For more information about the metadata fields
|
|
3743
|
+
* available in S3 Inventory, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-inventory.html#storage-inventory-contents">Amazon S3
|
|
3744
|
+
* Inventory lists</a> in the <i>Amazon S3 User Guide</i>. For more
|
|
3745
|
+
* information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions related to bucket subresource operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Identity and
|
|
3746
|
+
* access management in Amazon S3</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3657
3747
|
* <p class="title">
|
|
3658
3748
|
* <b>Special Errors</b>
|
|
3659
3749
|
* </p>
|
|
@@ -3734,10 +3824,10 @@ export declare class S3 extends S3Client {
|
|
|
3734
3824
|
/**
|
|
3735
3825
|
* @public
|
|
3736
3826
|
* <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
|
|
3737
|
-
* configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
|
|
3738
|
-
* you want to retain any configuration details, they must be included in the new
|
|
3739
|
-
* configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing
|
|
3740
|
-
* lifecycle</a>.</p>
|
|
3827
|
+
* configuration. Keep in mind that this will overwrite an existing lifecycle configuration,
|
|
3828
|
+
* so if you want to retain any configuration details, they must be included in the new
|
|
3829
|
+
* lifecycle configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing
|
|
3830
|
+
* your storage lifecycle</a>.</p>
|
|
3741
3831
|
* <note>
|
|
3742
3832
|
* <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an
|
|
3743
3833
|
* object key name prefix, one or more object tags, or a combination of both. Accordingly,
|
|
@@ -3769,8 +3859,8 @@ export declare class S3 extends S3Client {
|
|
|
3769
3859
|
* versions.</p>
|
|
3770
3860
|
* </li>
|
|
3771
3861
|
* </ul>
|
|
3772
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object
|
|
3773
|
-
*
|
|
3862
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>
|
|
3863
|
+
* and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>.</p>
|
|
3774
3864
|
* <p>
|
|
3775
3865
|
* <b>Permissions</b>
|
|
3776
3866
|
* </p>
|
|
@@ -3800,8 +3890,8 @@ export declare class S3 extends S3Client {
|
|
|
3800
3890
|
* </p>
|
|
3801
3891
|
* </li>
|
|
3802
3892
|
* </ul>
|
|
3803
|
-
* <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
|
|
3804
|
-
* Resources</a>.</p>
|
|
3893
|
+
* <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
|
|
3894
|
+
* Your Amazon S3 Resources</a>.</p>
|
|
3805
3895
|
* <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p>
|
|
3806
3896
|
* <ul>
|
|
3807
3897
|
* <li>
|
|
@@ -3828,15 +3918,18 @@ export declare class S3 extends S3Client {
|
|
|
3828
3918
|
/**
|
|
3829
3919
|
* @public
|
|
3830
3920
|
* <p>Set the logging parameters for a bucket and to specify permissions for who can view and
|
|
3831
|
-
* modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as
|
|
3832
|
-
* source bucket. To set the logging status of a bucket, you must be the bucket
|
|
3833
|
-
*
|
|
3921
|
+
* modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as
|
|
3922
|
+
* the source bucket. To set the logging status of a bucket, you must be the bucket
|
|
3923
|
+
* owner.</p>
|
|
3924
|
+
* <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the
|
|
3925
|
+
* <code>Grantee</code> request element to grant access to other people. The
|
|
3834
3926
|
* <code>Permissions</code> request element specifies the kind of access the grantee has to
|
|
3835
3927
|
* the logs.</p>
|
|
3836
3928
|
* <important>
|
|
3837
|
-
* <p>If the target bucket for log delivery uses the bucket owner enforced
|
|
3838
|
-
*
|
|
3839
|
-
* to
|
|
3929
|
+
* <p>If the target bucket for log delivery uses the bucket owner enforced setting for S3
|
|
3930
|
+
* Object Ownership, you can't use the <code>Grantee</code> request element to grant access
|
|
3931
|
+
* to others. Permissions can only be granted using policies. For more information, see
|
|
3932
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the
|
|
3840
3933
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
3841
3934
|
* </important>
|
|
3842
3935
|
* <p>
|
|
@@ -3877,7 +3970,8 @@ export declare class S3 extends S3Client {
|
|
|
3877
3970
|
* <code><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01"
|
|
3878
3971
|
* /></code>
|
|
3879
3972
|
* </p>
|
|
3880
|
-
* <p>For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the
|
|
3973
|
+
* <p>For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the
|
|
3974
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
3881
3975
|
* <p>For more information about creating a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. For more
|
|
3882
3976
|
* information about returning the logging status of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a>.</p>
|
|
3883
3977
|
* <p>The following operations are related to <code>PutBucketLogging</code>:</p>
|
|
@@ -3916,10 +4010,10 @@ export declare class S3 extends S3Client {
|
|
|
3916
4010
|
* <p>To use this operation, you must have permissions to perform the
|
|
3917
4011
|
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
3918
4012
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
3919
|
-
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
3920
|
-
* Resources</a>.</p>
|
|
3921
|
-
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring
|
|
3922
|
-
* CloudWatch</a>.</p>
|
|
4013
|
+
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
4014
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
4015
|
+
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring
|
|
4016
|
+
* Metrics with Amazon CloudWatch</a>.</p>
|
|
3923
4017
|
* <p>The following operations are related to
|
|
3924
4018
|
* <code>PutBucketMetricsConfiguration</code>:</p>
|
|
3925
4019
|
* <ul>
|
|
@@ -3964,7 +4058,7 @@ export declare class S3 extends S3Client {
|
|
|
3964
4058
|
* @public
|
|
3965
4059
|
* <p>Enables notifications of specified events for a bucket. For more information about event
|
|
3966
4060
|
* notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event
|
|
3967
|
-
*
|
|
4061
|
+
* Notifications</a>.</p>
|
|
3968
4062
|
* <p>Using this API, you can replace an existing notification configuration. The
|
|
3969
4063
|
* configuration is an XML file that defines the event types that you want Amazon S3 to publish and
|
|
3970
4064
|
* the destination where you want Amazon S3 to publish an event notification when it detects an
|
|
@@ -3977,19 +4071,19 @@ export declare class S3 extends S3Client {
|
|
|
3977
4071
|
* <p>
|
|
3978
4072
|
* <code></NotificationConfiguration></code>
|
|
3979
4073
|
* </p>
|
|
3980
|
-
* <p>This action replaces the existing notification configuration with the configuration
|
|
3981
|
-
*
|
|
4074
|
+
* <p>This action replaces the existing notification configuration with the configuration you
|
|
4075
|
+
* include in the request body.</p>
|
|
3982
4076
|
* <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification
|
|
3983
4077
|
* Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and
|
|
3984
4078
|
* that the bucket owner has permission to publish to it by sending a test notification. In
|
|
3985
4079
|
* the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions
|
|
3986
4080
|
* grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,
|
|
3987
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3
|
|
3988
|
-
* Events</a>.</p>
|
|
4081
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3 Events</a>.</p>
|
|
3989
4082
|
* <p>You can disable notifications by adding the empty NotificationConfiguration
|
|
3990
4083
|
* element.</p>
|
|
3991
|
-
* <p>For more information about the number of event notification configurations that you can
|
|
3992
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services
|
|
4084
|
+
* <p>For more information about the number of event notification configurations that you can
|
|
4085
|
+
* create per bucket, see <a href="https://docs.aws.amazon.com/general/latest/gr/s3.html#limits_s3">Amazon S3 service quotas</a> in <i>Amazon Web Services
|
|
4086
|
+
* General Reference</i>.</p>
|
|
3993
4087
|
* <p>By default, only the bucket owner can configure notifications on a bucket. However,
|
|
3994
4088
|
* bucket owners can use a bucket policy to grant permission to other users to set this
|
|
3995
4089
|
* configuration with <code>s3:PutBucketNotification</code> permission.</p>
|
|
@@ -3997,8 +4091,8 @@ export declare class S3 extends S3Client {
|
|
|
3997
4091
|
* <p>The PUT notification is an atomic operation. For example, suppose your notification
|
|
3998
4092
|
* configuration includes SNS topic, SQS queue, and Lambda function configurations. When
|
|
3999
4093
|
* you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS
|
|
4000
|
-
* topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add
|
|
4001
|
-
*
|
|
4094
|
+
* topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the
|
|
4095
|
+
* configuration to your bucket.</p>
|
|
4002
4096
|
* </note>
|
|
4003
4097
|
* <p>
|
|
4004
4098
|
* <b>Responses</b>
|
|
@@ -4025,8 +4119,10 @@ export declare class S3 extends S3Client {
|
|
|
4025
4119
|
* @public
|
|
4026
4120
|
* <p>Creates or modifies <code>OwnershipControls</code> for an Amazon S3 bucket. To use this
|
|
4027
4121
|
* operation, you must have the <code>s3:PutBucketOwnershipControls</code> permission. For
|
|
4028
|
-
* more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a
|
|
4029
|
-
*
|
|
4122
|
+
* more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-with-s3-actions.html">Specifying permissions in a
|
|
4123
|
+
* policy</a>. </p>
|
|
4124
|
+
* <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/user-guide/about-object-ownership.html">Using object
|
|
4125
|
+
* ownership</a>. </p>
|
|
4030
4126
|
* <p>The following operations are related to <code>PutBucketOwnershipControls</code>:</p>
|
|
4031
4127
|
* <ul>
|
|
4032
4128
|
* <li>
|
|
@@ -4059,7 +4155,8 @@ export declare class S3 extends S3Client {
|
|
|
4059
4155
|
* always use this operation, even if the policy explicitly denies the root user the
|
|
4060
4156
|
* ability to perform this action. </p>
|
|
4061
4157
|
* </important>
|
|
4062
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
|
|
4158
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy
|
|
4159
|
+
* examples</a>.</p>
|
|
4063
4160
|
* <p>The following operations are related to <code>PutBucketPolicy</code>:</p>
|
|
4064
4161
|
* <ul>
|
|
4065
4162
|
* <li>
|
|
@@ -4104,26 +4201,27 @@ export declare class S3 extends S3Client {
|
|
|
4104
4201
|
* <b>Handling Replication of Encrypted Objects</b>
|
|
4105
4202
|
* </p>
|
|
4106
4203
|
* <p>By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side
|
|
4107
|
-
* encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the
|
|
4108
|
-
*
|
|
4204
|
+
* encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:
|
|
4205
|
+
* <code>SourceSelectionCriteria</code>, <code>SseKmsEncryptedObjects</code>,
|
|
4109
4206
|
* <code>Status</code>, <code>EncryptionConfiguration</code>, and
|
|
4110
4207
|
* <code>ReplicaKmsKeyID</code>. For information about replication configuration, see
|
|
4111
4208
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects
|
|
4112
|
-
*
|
|
4209
|
+
* Created with SSE Using KMS keys</a>.</p>
|
|
4113
4210
|
* <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
|
|
4114
4211
|
* replication-related error codes</a>
|
|
4115
4212
|
* </p>
|
|
4116
4213
|
* <p>
|
|
4117
4214
|
* <b>Permissions</b>
|
|
4118
4215
|
* </p>
|
|
4119
|
-
* <p>To create a <code>PutBucketReplication</code> request, you must have
|
|
4120
|
-
*
|
|
4121
|
-
*
|
|
4122
|
-
*
|
|
4123
|
-
*
|
|
4124
|
-
* operation.
|
|
4125
|
-
*
|
|
4126
|
-
*
|
|
4216
|
+
* <p>To create a <code>PutBucketReplication</code> request, you must have
|
|
4217
|
+
* <code>s3:PutReplicationConfiguration</code> permissions for the bucket.
|
|
4218
|
+
*
|
|
4219
|
+
* </p>
|
|
4220
|
+
* <p>By default, a resource owner, in this case the Amazon Web Services account that created the bucket,
|
|
4221
|
+
* can perform this operation. The resource owner can also grant others permissions to perform
|
|
4222
|
+
* the operation. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
4223
|
+
* Policy</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
|
|
4224
|
+
* Your Amazon S3 Resources</a>.</p>
|
|
4127
4225
|
* <note>
|
|
4128
4226
|
* <p>To perform this operation, the user or role performing the action must have the
|
|
4129
4227
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p>
|
|
@@ -4151,7 +4249,7 @@ export declare class S3 extends S3Client {
|
|
|
4151
4249
|
* for downloads from the bucket. This configuration parameter enables the bucket owner (only)
|
|
4152
4250
|
* to specify that the person requesting the download will be charged for the download. For
|
|
4153
4251
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
|
|
4154
|
-
*
|
|
4252
|
+
* Buckets</a>.</p>
|
|
4155
4253
|
* <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p>
|
|
4156
4254
|
* <ul>
|
|
4157
4255
|
* <li>
|
|
@@ -4172,23 +4270,23 @@ export declare class S3 extends S3Client {
|
|
|
4172
4270
|
/**
|
|
4173
4271
|
* @public
|
|
4174
4272
|
* <p>Sets the tags for a bucket.</p>
|
|
4175
|
-
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
|
|
4176
|
-
* up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost
|
|
4177
|
-
* combined resources, organize your billing information according to resources with the
|
|
4178
|
-
* tag key values. For example, you can tag several resources with a specific application
|
|
4273
|
+
* <p>Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
|
|
4274
|
+
* sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost
|
|
4275
|
+
* of combined resources, organize your billing information according to resources with the
|
|
4276
|
+
* same tag key values. For example, you can tag several resources with a specific application
|
|
4179
4277
|
* name, and then organize your billing information to see the total cost of that application
|
|
4180
|
-
* across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation
|
|
4181
|
-
*
|
|
4182
|
-
*
|
|
4278
|
+
* across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation and
|
|
4279
|
+
* Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket
|
|
4280
|
+
* Tags</a>.</p>
|
|
4183
4281
|
* <note>
|
|
4184
|
-
* <p>
|
|
4185
|
-
*
|
|
4186
|
-
*
|
|
4282
|
+
* <p> When this operation sets the tags for a bucket, it will overwrite any current tags
|
|
4283
|
+
* the bucket already has. You cannot use this operation to add tags to an existing list of
|
|
4284
|
+
* tags.</p>
|
|
4187
4285
|
* </note>
|
|
4188
4286
|
* <p>To use this operation, you must have permissions to perform the
|
|
4189
4287
|
* <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default
|
|
4190
|
-
* and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
4191
|
-
* Resources</a>.</p>
|
|
4288
|
+
* and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
4289
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
4192
4290
|
* <p>
|
|
4193
4291
|
* <code>PutBucketTagging</code> has the following special errors:</p>
|
|
4194
4292
|
* <ul>
|
|
@@ -4263,10 +4361,10 @@ export declare class S3 extends S3Client {
|
|
|
4263
4361
|
* <p>If the versioning state has never been set on a bucket, it has no versioning state; a
|
|
4264
4362
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value.</p>
|
|
4265
4363
|
* <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner
|
|
4266
|
-
* and want to enable MFA Delete in the bucket versioning configuration, you must
|
|
4267
|
-
*
|
|
4268
|
-
* <code>
|
|
4269
|
-
*
|
|
4364
|
+
* and want to enable MFA Delete in the bucket versioning configuration, you must include the
|
|
4365
|
+
* <code>x-amz-mfa request</code> header and the <code>Status</code> and the
|
|
4366
|
+
* <code>MfaDelete</code> request elements in a request to set the versioning state of the
|
|
4367
|
+
* bucket.</p>
|
|
4270
4368
|
* <important>
|
|
4271
4369
|
* <p>If you have an object expiration lifecycle policy in your non-versioned bucket and
|
|
4272
4370
|
* you want to maintain the same permanent delete behavior when you enable versioning, you
|
|
@@ -4431,12 +4529,16 @@ export declare class S3 extends S3Client {
|
|
|
4431
4529
|
* @public
|
|
4432
4530
|
* <p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object
|
|
4433
4531
|
* to it.</p>
|
|
4434
|
-
* <
|
|
4435
|
-
*
|
|
4532
|
+
* <note>
|
|
4533
|
+
* <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the
|
|
4534
|
+
* entire object to the bucket. You cannot use <code>PutObject</code> to only update a
|
|
4535
|
+
* single piece of metadata for an existing object. You must put the entire object with
|
|
4536
|
+
* updated metadata if you want to update some values.</p>
|
|
4537
|
+
* </note>
|
|
4436
4538
|
* <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object
|
|
4437
|
-
* simultaneously, it overwrites all but the last object written.
|
|
4438
|
-
*
|
|
4439
|
-
*
|
|
4539
|
+
* simultaneously, it overwrites all but the last object written. To prevent objects from
|
|
4540
|
+
* being deleted or overwritten, you can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html">Amazon S3 Object
|
|
4541
|
+
* Lock</a>.</p>
|
|
4440
4542
|
* <p>To ensure that data is not corrupted traversing the network, use the
|
|
4441
4543
|
* <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object
|
|
4442
4544
|
* against the provided MD5 value and, if they do not match, returns an error. Additionally,
|
|
@@ -4446,76 +4548,63 @@ export declare class S3 extends S3Client {
|
|
|
4446
4548
|
* <ul>
|
|
4447
4549
|
* <li>
|
|
4448
4550
|
* <p>To successfully complete the <code>PutObject</code> request, you must have the
|
|
4449
|
-
*
|
|
4551
|
+
* <code>s3:PutObject</code> in your IAM permissions.</p>
|
|
4450
4552
|
* </li>
|
|
4451
4553
|
* <li>
|
|
4452
4554
|
* <p>To successfully change the objects acl of your <code>PutObject</code> request,
|
|
4453
|
-
*
|
|
4555
|
+
* you must have the <code>s3:PutObjectAcl</code> in your IAM permissions.</p>
|
|
4556
|
+
* </li>
|
|
4557
|
+
* <li>
|
|
4558
|
+
* <p>To successfully set the tag-set with your <code>PutObject</code> request, you
|
|
4559
|
+
* must have the <code>s3:PutObjectTagging</code> in your IAM permissions.</p>
|
|
4454
4560
|
* </li>
|
|
4455
4561
|
* <li>
|
|
4456
|
-
* <p> The <code>Content-MD5</code> header is required for any request to upload an
|
|
4457
|
-
* with a retention period configured using Amazon S3 Object Lock. For more
|
|
4458
|
-
* Amazon S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html">Amazon S3 Object Lock
|
|
4459
|
-
*
|
|
4562
|
+
* <p> The <code>Content-MD5</code> header is required for any request to upload an
|
|
4563
|
+
* object with a retention period configured using Amazon S3 Object Lock. For more
|
|
4564
|
+
* information about Amazon S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html">Amazon S3 Object Lock
|
|
4565
|
+
* Overview</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
4460
4566
|
* </li>
|
|
4461
4567
|
* </ul>
|
|
4462
4568
|
* </note>
|
|
4463
|
-
* <p>
|
|
4464
|
-
*
|
|
4465
|
-
*
|
|
4466
|
-
*
|
|
4467
|
-
*
|
|
4468
|
-
*
|
|
4469
|
-
*
|
|
4470
|
-
*
|
|
4471
|
-
*
|
|
4472
|
-
*
|
|
4473
|
-
* <
|
|
4474
|
-
* <
|
|
4475
|
-
*
|
|
4476
|
-
* Headers</b>
|
|
4477
|
-
* </p>
|
|
4478
|
-
* <p>You can use headers to grant ACL- based permissions. By default, all objects are
|
|
4479
|
-
* private. Only the owner has full access control. When adding a new object, you can grant
|
|
4480
|
-
* permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These
|
|
4481
|
-
* permissions 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 List
|
|
4482
|
-
* (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST
|
|
4483
|
-
* API</a>. </p>
|
|
4569
|
+
* <p>You have three mutually exclusive options to protect data using server-side encryption
|
|
4570
|
+
* in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the
|
|
4571
|
+
* encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and
|
|
4572
|
+
* customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using
|
|
4573
|
+
* Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at by
|
|
4574
|
+
* rest using server-side encryption with other key options. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using
|
|
4575
|
+
* Server-Side Encryption</a>.</p>
|
|
4576
|
+
* <p>When adding a new object, you can use headers to grant ACL-based permissions to
|
|
4577
|
+
* individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are
|
|
4578
|
+
* then added to the ACL on the object. By default, all objects are private. Only the owner
|
|
4579
|
+
* has full access control. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
|
|
4580
|
+
* and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing
|
|
4581
|
+
* ACLs Using the REST API</a>. </p>
|
|
4484
4582
|
* <p>If the bucket that you're uploading objects to uses the bucket owner enforced setting
|
|
4485
4583
|
* for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that
|
|
4486
4584
|
* use this setting only accept PUT requests that don't specify an ACL or PUT requests that
|
|
4487
|
-
* specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
|
|
4488
|
-
* ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that
|
|
4489
|
-
* ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a
|
|
4490
|
-
* <code>400</code> error with the error code
|
|
4491
|
-
* <
|
|
4492
|
-
*
|
|
4493
|
-
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4585
|
+
* specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
|
|
4586
|
+
* canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that
|
|
4587
|
+
* contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a
|
|
4588
|
+
* <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.
|
|
4589
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of
|
|
4590
|
+
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4494
4591
|
* <note>
|
|
4495
|
-
* <p>If your bucket uses the bucket owner enforced setting for Object Ownership,
|
|
4496
|
-
*
|
|
4592
|
+
* <p>If your bucket uses the bucket owner enforced setting for Object Ownership, all
|
|
4593
|
+
* objects written to the bucket by any account will be owned by the bucket owner.</p>
|
|
4497
4594
|
* </note>
|
|
4498
|
-
* <p>
|
|
4499
|
-
* <b>Storage Class Options</b>
|
|
4500
|
-
* </p>
|
|
4501
4595
|
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The
|
|
4502
4596
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
4503
4597
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
4504
4598
|
* the OUTPOSTS Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the
|
|
4505
|
-
*
|
|
4506
|
-
* <p>
|
|
4507
|
-
* <b>Versioning</b>
|
|
4508
|
-
* </p>
|
|
4599
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
4509
4600
|
* <p>If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID
|
|
4510
4601
|
* for the object being stored. Amazon S3 returns this ID in the response. When you enable
|
|
4511
4602
|
* versioning for a bucket, if Amazon S3 receives multiple write requests for the same object
|
|
4512
|
-
* simultaneously, it stores all of the objects
|
|
4513
|
-
*
|
|
4603
|
+
* simultaneously, it stores all of the objects. For more information about versioning, see
|
|
4604
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to
|
|
4514
4605
|
* Versioning Enabled Buckets</a>. For information about returning the versioning state
|
|
4515
4606
|
* of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
4516
|
-
* <p
|
|
4517
|
-
* <b>Related Resources</b>
|
|
4518
|
-
* </p>
|
|
4607
|
+
* <p>For more information about related Amazon S3 APIs, see the following:</p>
|
|
4519
4608
|
* <ul>
|
|
4520
4609
|
* <li>
|
|
4521
4610
|
* <p>
|
|
@@ -4539,16 +4628,18 @@ export declare class S3 extends S3Client {
|
|
|
4539
4628
|
* permission to set the ACL of an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions">What
|
|
4540
4629
|
* permissions can I grant?</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4541
4630
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
4542
|
-
* <p>Depending on your application needs, you can choose to set
|
|
4543
|
-
*
|
|
4544
|
-
*
|
|
4545
|
-
*
|
|
4631
|
+
* <p>Depending on your application needs, you can choose to set the ACL on an object using
|
|
4632
|
+
* either the request body or the headers. For example, if you have an existing application
|
|
4633
|
+
* that updates a bucket ACL using the request body, you can continue to use that approach.
|
|
4634
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
|
|
4635
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
4546
4636
|
* <important>
|
|
4547
|
-
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
|
|
4548
|
-
*
|
|
4549
|
-
*
|
|
4550
|
-
*
|
|
4551
|
-
*
|
|
4637
|
+
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs
|
|
4638
|
+
* are disabled and no longer affect permissions. You must use policies to grant access to
|
|
4639
|
+
* your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return
|
|
4640
|
+
* the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are
|
|
4641
|
+
* still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object
|
|
4642
|
+
* ownership</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4552
4643
|
* </important>
|
|
4553
4644
|
* <p>
|
|
4554
4645
|
* <b>Access Permissions</b>
|
|
@@ -4560,7 +4651,8 @@ export declare class S3 extends S3Client {
|
|
|
4560
4651
|
* a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set
|
|
4561
4652
|
* of grantees and permissions. Specify the canned ACL name as the value of
|
|
4562
4653
|
* <code>x-amz-ac</code>l. If you use this header, you cannot use other access
|
|
4563
|
-
* control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
4654
|
+
* control-specific headers in your request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
4655
|
+
* ACL</a>.</p>
|
|
4564
4656
|
* </li>
|
|
4565
4657
|
* <li>
|
|
4566
4658
|
* <p>Specify access permissions explicitly with the <code>x-amz-grant-read</code>,
|
|
@@ -4569,14 +4661,15 @@ export declare class S3 extends S3Client {
|
|
|
4569
4661
|
* specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who
|
|
4570
4662
|
* will receive the permission. If you use these ACL-specific headers, you cannot use
|
|
4571
4663
|
* <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set
|
|
4572
|
-
* of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
|
|
4573
|
-
*
|
|
4664
|
+
* of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
|
|
4665
|
+
* List (ACL) Overview</a>.</p>
|
|
4574
4666
|
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
4575
4667
|
* following:</p>
|
|
4576
4668
|
* <ul>
|
|
4577
4669
|
* <li>
|
|
4578
4670
|
* <p>
|
|
4579
|
-
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
4671
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
4672
|
+
* Amazon Web Services account</p>
|
|
4580
4673
|
* </li>
|
|
4581
4674
|
* <li>
|
|
4582
4675
|
* <p>
|
|
@@ -4731,22 +4824,21 @@ export declare class S3 extends S3Client {
|
|
|
4731
4824
|
* @public
|
|
4732
4825
|
* <p>Places an Object Lock configuration on the specified bucket. The rule specified in the
|
|
4733
4826
|
* Object Lock configuration will be applied by default to every new object placed in the
|
|
4734
|
-
* specified bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.
|
|
4735
|
-
* </p>
|
|
4827
|
+
* specified bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. </p>
|
|
4736
4828
|
* <note>
|
|
4737
4829
|
* <ul>
|
|
4738
4830
|
* <li>
|
|
4739
4831
|
* <p>The <code>DefaultRetention</code> settings require both a mode and a
|
|
4740
|
-
*
|
|
4832
|
+
* period.</p>
|
|
4741
4833
|
* </li>
|
|
4742
4834
|
* <li>
|
|
4743
|
-
* <p>The <code>DefaultRetention</code> period can be either <code>Days</code>
|
|
4744
|
-
*
|
|
4745
|
-
*
|
|
4835
|
+
* <p>The <code>DefaultRetention</code> period can be either <code>Days</code> or
|
|
4836
|
+
* <code>Years</code> but you must select one. You cannot specify
|
|
4837
|
+
* <code>Days</code> and <code>Years</code> at the same time.</p>
|
|
4746
4838
|
* </li>
|
|
4747
4839
|
* <li>
|
|
4748
|
-
* <p>You can only enable Object Lock for new buckets. If you want to turn on
|
|
4749
|
-
*
|
|
4840
|
+
* <p>You can only enable Object Lock for new buckets. If you want to turn on Object
|
|
4841
|
+
* Lock for an existing bucket, contact Amazon Web Services Support.</p>
|
|
4750
4842
|
* </li>
|
|
4751
4843
|
* </ul>
|
|
4752
4844
|
* </note>
|
|
@@ -4757,10 +4849,9 @@ export declare class S3 extends S3Client {
|
|
|
4757
4849
|
/**
|
|
4758
4850
|
* @public
|
|
4759
4851
|
* <p>Places an Object Retention configuration on an object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.
|
|
4760
|
-
*
|
|
4761
|
-
*
|
|
4762
|
-
*
|
|
4763
|
-
* </p>
|
|
4852
|
+
* Users or accounts require the <code>s3:PutObjectRetention</code> permission in order to
|
|
4853
|
+
* place an Object Retention configuration on objects. Bypassing a Governance Retention
|
|
4854
|
+
* configuration requires the <code>s3:BypassGovernanceRetention</code> permission. </p>
|
|
4764
4855
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
4765
4856
|
*/
|
|
4766
4857
|
putObjectRetention(args: PutObjectRetentionCommandInput, options?: __HttpHandlerOptions): Promise<PutObjectRetentionCommandOutput>;
|
|
@@ -4795,7 +4886,8 @@ export declare class S3 extends S3Client {
|
|
|
4795
4886
|
* <li>
|
|
4796
4887
|
* <p>
|
|
4797
4888
|
* <i>Cause: The tag provided was not a valid tag. This error can occur
|
|
4798
|
-
* if the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object
|
|
4889
|
+
* if the tag did not pass input validation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object
|
|
4890
|
+
* Tagging</a>.</i>
|
|
4799
4891
|
* </p>
|
|
4800
4892
|
* </li>
|
|
4801
4893
|
* </ul>
|
|
@@ -4823,8 +4915,8 @@ export declare class S3 extends S3Client {
|
|
|
4823
4915
|
* </li>
|
|
4824
4916
|
* <li>
|
|
4825
4917
|
* <p>
|
|
4826
|
-
* <i>Cause: A conflicting conditional action is currently in
|
|
4827
|
-
*
|
|
4918
|
+
* <i>Cause: A conflicting conditional action is currently in progress
|
|
4919
|
+
* against this resource. Please try again.</i>
|
|
4828
4920
|
* </p>
|
|
4829
4921
|
* </li>
|
|
4830
4922
|
* </ul>
|
|
@@ -4869,7 +4961,7 @@ export declare class S3 extends S3Client {
|
|
|
4869
4961
|
* <p>Creates or modifies the <code>PublicAccessBlock</code> configuration for an Amazon S3 bucket.
|
|
4870
4962
|
* To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code>
|
|
4871
4963
|
* permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
4872
|
-
*
|
|
4964
|
+
* Policy</a>.</p>
|
|
4873
4965
|
* <important>
|
|
4874
4966
|
* <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
|
|
4875
4967
|
* an object, it checks the <code>PublicAccessBlock</code> configuration for both the
|
|
@@ -4926,27 +5018,13 @@ export declare class S3 extends S3Client {
|
|
|
4926
5018
|
* </ul>
|
|
4927
5019
|
* <p>To use this operation, you must have permissions to perform the
|
|
4928
5020
|
* <code>s3:RestoreObject</code> action. The bucket owner has this permission by default
|
|
4929
|
-
* and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
4930
|
-
*
|
|
4931
|
-
*
|
|
4932
|
-
*
|
|
4933
|
-
*
|
|
4934
|
-
* <
|
|
4935
|
-
*
|
|
4936
|
-
* uncompressed comma-separated values (CSV) files. You can run queries and custom analytics
|
|
4937
|
-
* on your archived data without having to restore your data to a hotter Amazon S3 tier. For an
|
|
4938
|
-
* overview about select requests, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4939
|
-
* <p>When making a select request, do the following:</p>
|
|
4940
|
-
* <ul>
|
|
4941
|
-
* <li>
|
|
4942
|
-
* <p>Define an output location for the select query's output. This must be an Amazon S3
|
|
4943
|
-
* bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is
|
|
4944
|
-
* being queried. The Amazon Web Services account that initiates the job must have permissions to write
|
|
4945
|
-
* to the S3 bucket. You can specify the storage class and encryption for the output
|
|
4946
|
-
* objects stored in the bucket. For more information about output, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html">Querying Archived Objects</a>
|
|
4947
|
-
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
4948
|
-
* <p>For more information about the <code>S3</code> structure in the request body, see
|
|
4949
|
-
* the following:</p>
|
|
5021
|
+
* and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
5022
|
+
* Access Permissions to Your Amazon S3 Resources</a> in the
|
|
5023
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
5024
|
+
* <p>For more information about the <code>S3</code> structure in the request body, see the
|
|
5025
|
+
* following:</p>
|
|
5026
|
+
* <ul>
|
|
5027
|
+
* <li>
|
|
4950
5028
|
* <ul>
|
|
4951
5029
|
* <li>
|
|
4952
5030
|
* <p>
|
|
@@ -4955,8 +5033,8 @@ export declare class S3 extends S3Client {
|
|
|
4955
5033
|
* </li>
|
|
4956
5034
|
* <li>
|
|
4957
5035
|
* <p>
|
|
4958
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access with
|
|
4959
|
-
*
|
|
5036
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Managing Access with ACLs</a> in the
|
|
5037
|
+
* <i>Amazon S3 User Guide</i>
|
|
4960
5038
|
* </p>
|
|
4961
5039
|
* </li>
|
|
4962
5040
|
* <li>
|
|
@@ -5000,8 +5078,6 @@ export declare class S3 extends S3Client {
|
|
|
5000
5078
|
* </ul>
|
|
5001
5079
|
* </li>
|
|
5002
5080
|
* </ul>
|
|
5003
|
-
* <p>For more information about using SQL with S3 Glacier Select restore, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for Amazon S3 Select and
|
|
5004
|
-
* S3 Glacier Select</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
5005
5081
|
* <p>When making a select request, you can also do the following:</p>
|
|
5006
5082
|
* <ul>
|
|
5007
5083
|
* <li>
|
|
@@ -5021,7 +5097,7 @@ export declare class S3 extends S3Client {
|
|
|
5021
5097
|
* </li>
|
|
5022
5098
|
* <li>
|
|
5023
5099
|
* <p>You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't
|
|
5024
|
-
*
|
|
5100
|
+
* duplicate requests, so avoid issuing duplicate requests.</p>
|
|
5025
5101
|
* </li>
|
|
5026
5102
|
* <li>
|
|
5027
5103
|
* <p> Amazon S3 accepts a select request even if the object has already been restored. A
|
|
@@ -5031,65 +5107,69 @@ export declare class S3 extends S3Client {
|
|
|
5031
5107
|
* <p>
|
|
5032
5108
|
* <b>Restoring objects</b>
|
|
5033
5109
|
* </p>
|
|
5034
|
-
* <p>Objects that you archive to the S3 Glacier or
|
|
5110
|
+
* <p>Objects that you archive to the S3 Glacier Flexible Retrieval or
|
|
5035
5111
|
* S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or
|
|
5036
|
-
* S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in
|
|
5037
|
-
*
|
|
5038
|
-
*
|
|
5039
|
-
*
|
|
5040
|
-
*
|
|
5041
|
-
*
|
|
5042
|
-
*
|
|
5112
|
+
* S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the
|
|
5113
|
+
* S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage
|
|
5114
|
+
* classes, you must first initiate a restore request, and then wait until a temporary copy of
|
|
5115
|
+
* the object is available. If you want a permanent copy of the object, create a copy of it in
|
|
5116
|
+
* the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must
|
|
5117
|
+
* restore the object for the duration (number of days) that you specify. For objects in the
|
|
5118
|
+
* Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first
|
|
5119
|
+
* initiate a restore request, and then wait until the object is moved into the Frequent
|
|
5120
|
+
* Access tier.</p>
|
|
5043
5121
|
* <p>To restore a specific object version, you can provide a version ID. If you don't provide
|
|
5044
5122
|
* a version ID, Amazon S3 restores the current version.</p>
|
|
5045
|
-
* <p>When restoring an archived object
|
|
5046
|
-
*
|
|
5047
|
-
* body: </p>
|
|
5123
|
+
* <p>When restoring an archived object, you can specify one of the following data access tier
|
|
5124
|
+
* options in the <code>Tier</code> element of the request body: </p>
|
|
5048
5125
|
* <ul>
|
|
5049
5126
|
* <li>
|
|
5050
5127
|
* <p>
|
|
5051
5128
|
* <code>Expedited</code> - Expedited retrievals allow you to quickly access your
|
|
5052
|
-
* data stored in the S3 Glacier storage class or
|
|
5053
|
-
* tier when occasional urgent requests for a subset of archives
|
|
5054
|
-
* but the largest archived objects (250 MB+), data accessed using
|
|
5055
|
-
* is typically made available within 1–5 minutes. Provisioned
|
|
5056
|
-
* retrieval capacity for Expedited retrievals is available when
|
|
5057
|
-
* retrievals and provisioned capacity are not available for
|
|
5058
|
-
* S3 Glacier Deep Archive storage class or
|
|
5129
|
+
* data stored in the S3 Glacier Flexible Retrieval storage class or
|
|
5130
|
+
* S3 Intelligent-Tiering Archive tier when occasional urgent requests for a subset of archives
|
|
5131
|
+
* are required. For all but the largest archived objects (250 MB+), data accessed using
|
|
5132
|
+
* Expedited retrievals is typically made available within 1–5 minutes. Provisioned
|
|
5133
|
+
* capacity ensures that retrieval capacity for Expedited retrievals is available when
|
|
5134
|
+
* you need it. Expedited retrievals and provisioned capacity are not available for
|
|
5135
|
+
* objects stored in the S3 Glacier Deep Archive storage class or
|
|
5136
|
+
* S3 Intelligent-Tiering Deep Archive tier.</p>
|
|
5059
5137
|
* </li>
|
|
5060
5138
|
* <li>
|
|
5061
5139
|
* <p>
|
|
5062
5140
|
* <code>Standard</code> - Standard retrievals allow you to access any of your
|
|
5063
5141
|
* archived objects within several hours. This is the default option for retrieval
|
|
5064
5142
|
* requests that do not specify the retrieval option. Standard retrievals typically
|
|
5065
|
-
* finish within 3–5 hours for objects stored in the S3 Glacier
|
|
5066
|
-
* class or S3 Intelligent-Tiering Archive tier. They typically finish within
|
|
5067
|
-
* objects stored in the S3 Glacier Deep Archive storage class or
|
|
5143
|
+
* finish within 3–5 hours for objects stored in the S3 Glacier Flexible
|
|
5144
|
+
* Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within
|
|
5145
|
+
* 12 hours for objects stored in the S3 Glacier Deep Archive storage class or
|
|
5068
5146
|
* S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in
|
|
5069
5147
|
* S3 Intelligent-Tiering.</p>
|
|
5070
5148
|
* </li>
|
|
5071
5149
|
* <li>
|
|
5072
5150
|
* <p>
|
|
5073
|
-
* <code>Bulk</code> - Bulk retrievals
|
|
5074
|
-
*
|
|
5075
|
-
*
|
|
5076
|
-
*
|
|
5077
|
-
*
|
|
5078
|
-
*
|
|
5079
|
-
*
|
|
5151
|
+
* <code>Bulk</code> - Bulk retrievals free for objects stored in the S3 Glacier
|
|
5152
|
+
* Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to
|
|
5153
|
+
* retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically
|
|
5154
|
+
* finish within 5–12 hours for objects stored in the S3 Glacier
|
|
5155
|
+
* Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are
|
|
5156
|
+
* also the lowest-cost retrieval option when restoring objects from
|
|
5157
|
+
* S3 Glacier Deep Archive. They typically finish within 48 hours for objects
|
|
5158
|
+
* stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive
|
|
5159
|
+
* tier. </p>
|
|
5080
5160
|
* </li>
|
|
5081
5161
|
* </ul>
|
|
5082
5162
|
* <p>For more information about archive retrieval options and provisioned capacity for
|
|
5083
|
-
* <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in
|
|
5163
|
+
* <code>Expedited</code> data access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in
|
|
5164
|
+
* the <i>Amazon S3 User Guide</i>. </p>
|
|
5084
5165
|
* <p>You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed
|
|
5085
|
-
* while it is in progress. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html">
|
|
5086
|
-
* Upgrading the speed of an in-progress restore</a> in the
|
|
5166
|
+
* while it is in progress. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html"> Upgrading the speed of an in-progress restore</a> in the
|
|
5087
5167
|
* <i>Amazon S3 User Guide</i>. </p>
|
|
5088
5168
|
* <p>To get the status of object restoration, you can send a <code>HEAD</code> request.
|
|
5089
5169
|
* Operations return the <code>x-amz-restore</code> header, which provides information about
|
|
5090
5170
|
* the restoration status, in the response. You can use Amazon S3 event notifications to notify you
|
|
5091
|
-
* when a restore is initiated or completed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3
|
|
5092
|
-
*
|
|
5171
|
+
* when a restore is initiated or completed. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Amazon S3
|
|
5172
|
+
* Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5093
5173
|
* <p>After restoring an archived object, you can update the restoration period by reissuing
|
|
5094
5174
|
* the request with a new period. Amazon S3 updates the restoration period relative to the current
|
|
5095
5175
|
* time and charges only for the request-there are no data transfer charges. You cannot
|
|
@@ -5099,13 +5179,13 @@ export declare class S3 extends S3Client {
|
|
|
5099
5179
|
* action, the object expiration overrides the life span that you specify in a restore
|
|
5100
5180
|
* request. For example, if you restore an object copy for 10 days, but the object is
|
|
5101
5181
|
* scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information
|
|
5102
|
-
* about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>
|
|
5103
|
-
*
|
|
5182
|
+
* about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a>
|
|
5183
|
+
* in <i>Amazon S3 User Guide</i>.</p>
|
|
5104
5184
|
* <p>
|
|
5105
5185
|
* <b>Responses</b>
|
|
5106
5186
|
* </p>
|
|
5107
|
-
* <p>A successful action returns either the <code>200 OK</code> or <code>202
|
|
5108
|
-
*
|
|
5187
|
+
* <p>A successful action returns either the <code>200 OK</code> or <code>202 Accepted</code>
|
|
5188
|
+
* status code. </p>
|
|
5109
5189
|
* <ul>
|
|
5110
5190
|
* <li>
|
|
5111
5191
|
* <p>If the object is not previously restored, then Amazon S3 returns <code>202
|
|
@@ -5187,13 +5267,6 @@ export declare class S3 extends S3Client {
|
|
|
5187
5267
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html">GetBucketNotificationConfiguration</a>
|
|
5188
5268
|
* </p>
|
|
5189
5269
|
* </li>
|
|
5190
|
-
* <li>
|
|
5191
|
-
* <p>
|
|
5192
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html">SQL Reference for
|
|
5193
|
-
* Amazon S3 Select and S3 Glacier Select </a> in the
|
|
5194
|
-
* <i>Amazon S3 User Guide</i>
|
|
5195
|
-
* </p>
|
|
5196
|
-
* </li>
|
|
5197
5270
|
* </ul>
|
|
5198
5271
|
*/
|
|
5199
5272
|
restoreObject(args: RestoreObjectCommandInput, options?: __HttpHandlerOptions): Promise<RestoreObjectCommandOutput>;
|
|
@@ -5208,19 +5281,16 @@ export declare class S3 extends S3Client {
|
|
|
5208
5281
|
* specified SQL expression. You must also specify the data serialization format for the
|
|
5209
5282
|
* response.</p>
|
|
5210
5283
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
5211
|
-
* <p>For more information about Amazon S3 Select,
|
|
5212
|
-
*
|
|
5213
|
-
*
|
|
5214
|
-
* Command</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5215
|
-
* <p>For more information about using SQL with Amazon S3 Select, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html"> SQL Reference for Amazon S3 Select
|
|
5216
|
-
* and S3 Glacier Select</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5284
|
+
* <p>For more information about Amazon S3 Select, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html">Selecting Content from
|
|
5285
|
+
* Objects</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-glacier-select-sql-reference-select.html">SELECT
|
|
5286
|
+
* Command</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5217
5287
|
* <p></p>
|
|
5218
5288
|
* <p>
|
|
5219
5289
|
* <b>Permissions</b>
|
|
5220
5290
|
* </p>
|
|
5221
5291
|
* <p>You must have <code>s3:GetObject</code> permission for this operation. Amazon S3 Select does
|
|
5222
|
-
* not support anonymous access. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
|
|
5223
|
-
*
|
|
5292
|
+
* not support anonymous access. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
|
|
5293
|
+
* Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5224
5294
|
* <p></p>
|
|
5225
5295
|
* <p>
|
|
5226
5296
|
* <i>Object Data Formats</i>
|
|
@@ -5251,14 +5321,13 @@ export declare class S3 extends S3Client {
|
|
|
5251
5321
|
* <i>Server-side encryption</i> - Amazon S3 Select supports querying
|
|
5252
5322
|
* objects that are protected with server-side encryption.</p>
|
|
5253
5323
|
* <p>For objects that are encrypted with customer-provided encryption keys (SSE-C), you
|
|
5254
|
-
* must use HTTPS, and you must use the headers that are documented in the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
|
|
5255
|
-
* (Using Customer-Provided Encryption Keys)</a> in the
|
|
5324
|
+
* must use HTTPS, and you must use the headers that are documented in the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side
|
|
5325
|
+
* Encryption (Using Customer-Provided Encryption Keys)</a> in the
|
|
5256
5326
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
5257
|
-
* <p>For objects that are encrypted with Amazon S3 managed
|
|
5258
|
-
*
|
|
5259
|
-
*
|
|
5260
|
-
*
|
|
5261
|
-
* SSE-KMS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using
|
|
5327
|
+
* <p>For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys
|
|
5328
|
+
* (SSE-KMS), server-side encryption is handled transparently, so you don't need to
|
|
5329
|
+
* specify anything. For more information about server-side encryption, including SSE-S3
|
|
5330
|
+
* and SSE-KMS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using
|
|
5262
5331
|
* Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5263
5332
|
* </li>
|
|
5264
5333
|
* </ul>
|
|
@@ -5285,8 +5354,8 @@ export declare class S3 extends S3Client {
|
|
|
5285
5354
|
* <li>
|
|
5286
5355
|
* <p>GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify
|
|
5287
5356
|
* the GLACIER, DEEP_ARCHIVE, or <code>REDUCED_REDUNDANCY</code> storage classes. For
|
|
5288
|
-
* more information, about storage classes see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro">Storage
|
|
5289
|
-
*
|
|
5357
|
+
* more information, about storage classes see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro">Storage
|
|
5358
|
+
* Classes</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5290
5359
|
* </li>
|
|
5291
5360
|
* </ul>
|
|
5292
5361
|
* <p></p>
|
|
@@ -5336,14 +5405,15 @@ export declare class S3 extends S3Client {
|
|
|
5336
5405
|
* identifies a part and also defines its position within the object being created. If you
|
|
5337
5406
|
* upload a new part using the same part number that was used with a previous part, the
|
|
5338
5407
|
* previously uploaded part is overwritten.</p>
|
|
5339
|
-
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
5408
|
+
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
5409
|
+
* specifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5340
5410
|
* <p>To ensure that data is not corrupted when traversing the network, specify the
|
|
5341
5411
|
* <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data
|
|
5342
5412
|
* against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p>
|
|
5343
5413
|
* <p>If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the
|
|
5344
5414
|
* <code>x-amz-content-sha256</code> header as a checksum instead of
|
|
5345
|
-
* <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating
|
|
5346
|
-
* 4)</a>. </p>
|
|
5415
|
+
* <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating
|
|
5416
|
+
* Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p>
|
|
5347
5417
|
* <p>
|
|
5348
5418
|
* <b>Note:</b> After you initiate multipart upload and upload
|
|
5349
5419
|
* one or more parts, you must either complete or abort multipart upload in order to stop
|
|
@@ -5353,23 +5423,29 @@ export declare class S3 extends S3Client {
|
|
|
5353
5423
|
* <p>For more information on multipart uploads, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the
|
|
5354
5424
|
* <i>Amazon S3 User Guide </i>.</p>
|
|
5355
5425
|
* <p>For information on the permissions required to use the multipart upload API, go to
|
|
5356
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
|
|
5357
|
-
* Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5358
|
-
* <p>
|
|
5359
|
-
* writes it to disks in its data centers and decrypts it
|
|
5360
|
-
*
|
|
5361
|
-
*
|
|
5362
|
-
*
|
|
5363
|
-
*
|
|
5364
|
-
*
|
|
5426
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
|
|
5427
|
+
* Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5428
|
+
* <p>Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it
|
|
5429
|
+
* writes it to disks in its data centers and decrypts it when you access it. You have three
|
|
5430
|
+
* mutually exclusive options to protect data using server-side encryption in Amazon S3, depending
|
|
5431
|
+
* on how you choose to manage the encryption keys. Specifically, the encryption key options
|
|
5432
|
+
* are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys
|
|
5433
|
+
* (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by
|
|
5434
|
+
* default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption
|
|
5435
|
+
* with other key options. The option you use depends on whether you want to use KMS keys
|
|
5436
|
+
* (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide your own
|
|
5437
|
+
* encryption key, the request headers you provide in the request must match the headers you
|
|
5438
|
+
* used in the request to initiate the upload by using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.
|
|
5439
|
+
* For more information, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side
|
|
5440
|
+
* Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5365
5441
|
* <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are
|
|
5366
|
-
* using a customer-provided encryption key, you don't need to specify the encryption
|
|
5442
|
+
* using a customer-provided encryption key (SSE-C), you don't need to specify the encryption
|
|
5367
5443
|
* parameters in each UploadPart request. Instead, you only need to specify the server-side
|
|
5368
5444
|
* encryption parameters in the initial Initiate Multipart request. For more information, see
|
|
5369
5445
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p>
|
|
5370
|
-
* <p>If you requested server-side encryption using a customer-provided encryption key
|
|
5371
|
-
* initiate multipart upload request, you must provide identical encryption
|
|
5372
|
-
* each part upload using the following headers.</p>
|
|
5446
|
+
* <p>If you requested server-side encryption using a customer-provided encryption key (SSE-C)
|
|
5447
|
+
* in your initiate multipart upload request, you must provide identical encryption
|
|
5448
|
+
* information in each part upload using the following headers.</p>
|
|
5373
5449
|
* <ul>
|
|
5374
5450
|
* <li>
|
|
5375
5451
|
* <p>x-amz-server-side-encryption-customer-algorithm</p>
|
|
@@ -5452,7 +5528,8 @@ export declare class S3 extends S3Client {
|
|
|
5452
5528
|
* data source by adding the request header <code>x-amz-copy-source</code> in your request and
|
|
5453
5529
|
* a byte range by adding the request header <code>x-amz-copy-source-range</code> in your
|
|
5454
5530
|
* request. </p>
|
|
5455
|
-
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
5531
|
+
* <p>For information about maximum and minimum part sizes and other multipart upload
|
|
5532
|
+
* specifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
5456
5533
|
* <note>
|
|
5457
5534
|
* <p>Instead of using an existing object as part data, you might use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
|
|
5458
5535
|
* action and provide data in your request.</p>
|
|
@@ -5464,13 +5541,14 @@ export declare class S3 extends S3Client {
|
|
|
5464
5541
|
* following:</p>
|
|
5465
5542
|
* <ul>
|
|
5466
5543
|
* <li>
|
|
5467
|
-
* <p>For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading
|
|
5468
|
-
* Upload</a> in the
|
|
5544
|
+
* <p>For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading
|
|
5545
|
+
* Objects Using Multipart Upload</a> in the
|
|
5546
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
5469
5547
|
* </li>
|
|
5470
5548
|
* <li>
|
|
5471
5549
|
* <p>For information about permissions required to use the multipart upload API, see
|
|
5472
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload
|
|
5473
|
-
*
|
|
5550
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and Permissions</a> in the
|
|
5551
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
5474
5552
|
* </li>
|
|
5475
5553
|
* <li>
|
|
5476
5554
|
* <p>For information about copying objects using a single atomic action vs. a multipart
|
|
@@ -5621,29 +5699,40 @@ export declare class S3 extends S3Client {
|
|
|
5621
5699
|
uploadPartCopy(args: UploadPartCopyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadPartCopyCommandOutput) => void): void;
|
|
5622
5700
|
/**
|
|
5623
5701
|
* @public
|
|
5624
|
-
* <p>Passes transformed
|
|
5625
|
-
*
|
|
5626
|
-
* Object Lambda access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with
|
|
5702
|
+
* <p>Passes transformed objects to a <code>GetObject</code> operation when using Object Lambda access points. For
|
|
5703
|
+
* information about Object Lambda access points, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html">Transforming objects with
|
|
5627
5704
|
* Object Lambda access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5628
5705
|
* <p>This operation supports metadata that can be returned by <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>, in addition to
|
|
5629
|
-
*
|
|
5630
|
-
*
|
|
5631
|
-
*
|
|
5632
|
-
*
|
|
5633
|
-
*
|
|
5634
|
-
*
|
|
5635
|
-
*
|
|
5636
|
-
* <p>You can include any number of metadata headers. When including a metadata header, it
|
|
5637
|
-
* prefaced with <code>x-amz-meta</code>. For example,
|
|
5638
|
-
*
|
|
5639
|
-
*
|
|
5640
|
-
*
|
|
5641
|
-
*
|
|
5642
|
-
*
|
|
5643
|
-
*
|
|
5644
|
-
* <p>Example
|
|
5645
|
-
*
|
|
5646
|
-
*
|
|
5706
|
+
* <code>RequestRoute</code>, <code>RequestToken</code>, <code>StatusCode</code>,
|
|
5707
|
+
* <code>ErrorCode</code>, and <code>ErrorMessage</code>. The <code>GetObject</code>
|
|
5708
|
+
* response metadata is supported so that the <code>WriteGetObjectResponse</code> caller,
|
|
5709
|
+
* typically an Lambda function, can provide the same metadata when it internally invokes
|
|
5710
|
+
* <code>GetObject</code>. When <code>WriteGetObjectResponse</code> is called by a
|
|
5711
|
+
* customer-owned Lambda function, the metadata returned to the end user
|
|
5712
|
+
* <code>GetObject</code> call might differ from what Amazon S3 would normally return.</p>
|
|
5713
|
+
* <p>You can include any number of metadata headers. When including a metadata header, it
|
|
5714
|
+
* should be prefaced with <code>x-amz-meta</code>. For example,
|
|
5715
|
+
* <code>x-amz-meta-my-custom-header: MyCustomValue</code>. The primary use case for this
|
|
5716
|
+
* is to forward <code>GetObject</code> metadata.</p>
|
|
5717
|
+
* <p>Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to
|
|
5718
|
+
* detect and redact personally identifiable information (PII) and decompress S3 objects.
|
|
5719
|
+
* These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and
|
|
5720
|
+
* can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.</p>
|
|
5721
|
+
* <p>Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a
|
|
5722
|
+
* natural language processing (NLP) service using machine learning to find insights and
|
|
5723
|
+
* relationships in text. It automatically detects personally identifiable information (PII)
|
|
5724
|
+
* such as names, addresses, dates, credit card numbers, and social security numbers from
|
|
5725
|
+
* documents in your Amazon S3 bucket. </p>
|
|
5726
|
+
* <p>Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural
|
|
5727
|
+
* language processing (NLP) service using machine learning to find insights and relationships
|
|
5728
|
+
* in text. It automatically redacts personally identifiable information (PII) such as names,
|
|
5729
|
+
* addresses, dates, credit card numbers, and social security numbers from documents in your
|
|
5730
|
+
* Amazon S3 bucket. </p>
|
|
5731
|
+
* <p>Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is
|
|
5732
|
+
* equipped to decompress objects stored in S3 in one of six compressed file formats including
|
|
5733
|
+
* bzip2, gzip, snappy, zlib, zstandard and ZIP. </p>
|
|
5734
|
+
* <p>For information on how to view and use these functions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html">Using Amazon Web Services built Lambda
|
|
5735
|
+
* functions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5647
5736
|
*/
|
|
5648
5737
|
writeGetObjectResponse(args: WriteGetObjectResponseCommandInput, options?: __HttpHandlerOptions): Promise<WriteGetObjectResponseCommandOutput>;
|
|
5649
5738
|
writeGetObjectResponse(args: WriteGetObjectResponseCommandInput, cb: (err: any, data?: WriteGetObjectResponseCommandOutput) => void): void;
|