@aws-sdk/client-s3 3.326.0 → 3.328.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-types/commands/AbortMultipartUploadCommand.d.ts +2 -2
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +22 -14
- package/dist-types/commands/CopyObjectCommand.d.ts +171 -144
- package/dist-types/commands/CreateBucketCommand.d.ts +128 -118
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +73 -48
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketCommand.d.ts +1 -3
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +3 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +8 -8
- 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/DeleteBucketPolicyCommand.d.ts +6 -3
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -3
- package/dist-types/commands/DeleteObjectCommand.d.ts +21 -21
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +13 -15
- package/dist-types/commands/DeleteObjectsCommand.d.ts +35 -36
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +6 -7
- package/dist-types/commands/GetBucketAclCommand.d.ts +14 -10
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +6 -7
- package/dist-types/commands/GetBucketCorsCommand.d.ts +5 -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 +10 -2
- 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 +7 -2
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +4 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +11 -3
- 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 +2 -3
- package/dist-types/commands/GetObjectAclCommand.d.ts +5 -7
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +42 -45
- package/dist-types/commands/GetObjectCommand.d.ts +116 -112
- 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 +19 -9
- package/dist-types/commands/HeadObjectCommand.d.ts +36 -33
- 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 +9 -7
- 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 +13 -14
- 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 +114 -111
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +7 -10
- package/dist-types/commands/PutBucketCorsCommand.d.ts +3 -5
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +17 -17
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +31 -59
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +50 -65
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +64 -62
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +45 -39
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -2
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +8 -4
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +31 -28
- 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 +7 -9
- package/dist-types/commands/PutObjectAclCommand.d.ts +123 -119
- package/dist-types/commands/PutObjectCommand.d.ts +81 -90
- 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 +7 -9
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +2 -4
- package/dist-types/commands/RestoreObjectCommand.d.ts +175 -199
- package/dist-types/commands/SelectObjectContentCommand.d.ts +83 -90
- package/dist-types/commands/UploadPartCommand.d.ts +26 -22
- package/dist-types/commands/UploadPartCopyCommand.d.ts +78 -76
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +32 -21
- package/dist-types/models/models_0.d.ts +468 -382
- package/dist-types/models/models_1.d.ts +82 -80
- package/package.json +9 -9
|
@@ -6,7 +6,7 @@ import { S3ServiceException as __BaseException } from "./S3ServiceException";
|
|
|
6
6
|
* @public
|
|
7
7
|
* <p>Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will
|
|
8
8
|
* wait before permanently removing all parts of the upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">
|
|
9
|
-
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
|
9
|
+
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a> in the
|
|
10
10
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
11
11
|
*/
|
|
12
12
|
export interface AbortIncompleteMultipartUpload {
|
|
@@ -55,8 +55,8 @@ export interface AbortMultipartUploadRequest {
|
|
|
55
55
|
/**
|
|
56
56
|
* <p>The bucket name to which the upload was taking place. </p>
|
|
57
57
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
58
|
-
* <p>When
|
|
59
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
58
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
59
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
60
60
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
61
61
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
62
62
|
*/
|
|
@@ -221,7 +221,34 @@ export interface Grant {
|
|
|
221
221
|
*/
|
|
222
222
|
export interface Owner {
|
|
223
223
|
/**
|
|
224
|
-
* <p>Container for the display name of the owner
|
|
224
|
+
* <p>Container for the display name of the owner. This value is only supported in the
|
|
225
|
+
* following Amazon Web Services Regions:</p>
|
|
226
|
+
* <ul>
|
|
227
|
+
* <li>
|
|
228
|
+
* <p>US East (N. Virginia)</p>
|
|
229
|
+
* </li>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p>US West (N. California)</p>
|
|
232
|
+
* </li>
|
|
233
|
+
* <li>
|
|
234
|
+
* <p>US West (Oregon)</p>
|
|
235
|
+
* </li>
|
|
236
|
+
* <li>
|
|
237
|
+
* <p>Asia Pacific (Singapore)</p>
|
|
238
|
+
* </li>
|
|
239
|
+
* <li>
|
|
240
|
+
* <p>Asia Pacific (Sydney)</p>
|
|
241
|
+
* </li>
|
|
242
|
+
* <li>
|
|
243
|
+
* <p>Asia Pacific (Tokyo)</p>
|
|
244
|
+
* </li>
|
|
245
|
+
* <li>
|
|
246
|
+
* <p>Europe (Ireland)</p>
|
|
247
|
+
* </li>
|
|
248
|
+
* <li>
|
|
249
|
+
* <p>South America (São Paulo)</p>
|
|
250
|
+
* </li>
|
|
251
|
+
* </ul>
|
|
225
252
|
*/
|
|
226
253
|
DisplayName?: string;
|
|
227
254
|
/**
|
|
@@ -286,10 +313,11 @@ export interface CompleteMultipartUploadOutput {
|
|
|
286
313
|
*/
|
|
287
314
|
Location?: string;
|
|
288
315
|
/**
|
|
289
|
-
* <p>The name of the bucket that contains the newly created object. Does not return the access point
|
|
316
|
+
* <p>The name of the bucket that contains the newly created object. Does not return the access point
|
|
317
|
+
* ARN or access point alias if used.</p>
|
|
290
318
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
291
|
-
* <p>When
|
|
292
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
319
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
320
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
293
321
|
*/
|
|
294
322
|
Bucket?: string;
|
|
295
323
|
/**
|
|
@@ -308,9 +336,8 @@ export interface CompleteMultipartUploadOutput {
|
|
|
308
336
|
* tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5
|
|
309
337
|
* digest of the object data, it will contain one or more nonhexadecimal characters and/or
|
|
310
338
|
* will consist of less than 32 or more than 32 hexadecimal digits. For more information about
|
|
311
|
-
* how the entity tag is calculated, see
|
|
312
|
-
*
|
|
313
|
-
* object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
339
|
+
* how the entity tag is calculated, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object
|
|
340
|
+
* integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
314
341
|
*/
|
|
315
342
|
ETag?: string;
|
|
316
343
|
/**
|
|
@@ -342,10 +369,8 @@ export interface CompleteMultipartUploadOutput {
|
|
|
342
369
|
*/
|
|
343
370
|
ChecksumSHA256?: string;
|
|
344
371
|
/**
|
|
345
|
-
* <p>
|
|
346
|
-
*
|
|
347
|
-
* includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the
|
|
348
|
-
* object.</p>
|
|
372
|
+
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
373
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
349
374
|
*/
|
|
350
375
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
351
376
|
/**
|
|
@@ -355,11 +380,12 @@ export interface CompleteMultipartUploadOutput {
|
|
|
355
380
|
VersionId?: string;
|
|
356
381
|
/**
|
|
357
382
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
358
|
-
* customer managed key that was used for the object.</p>
|
|
383
|
+
* encryption customer managed key that was used for the object.</p>
|
|
359
384
|
*/
|
|
360
385
|
SSEKMSKeyId?: string;
|
|
361
386
|
/**
|
|
362
|
-
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
387
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
388
|
+
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
363
389
|
*/
|
|
364
390
|
BucketKeyEnabled?: boolean;
|
|
365
391
|
/**
|
|
@@ -418,8 +444,8 @@ export interface CompletedPart {
|
|
|
418
444
|
export interface CompletedMultipartUpload {
|
|
419
445
|
/**
|
|
420
446
|
* <p>Array of CompletedPart data types.</p>
|
|
421
|
-
* <p>If you do not supply a valid <code>Part</code> with your request, the service sends back
|
|
422
|
-
* 400 response.</p>
|
|
447
|
+
* <p>If you do not supply a valid <code>Part</code> with your request, the service sends back
|
|
448
|
+
* an HTTP 400 response.</p>
|
|
423
449
|
*/
|
|
424
450
|
Parts?: CompletedPart[];
|
|
425
451
|
}
|
|
@@ -430,8 +456,8 @@ export interface CompleteMultipartUploadRequest {
|
|
|
430
456
|
/**
|
|
431
457
|
* <p>Name of the bucket to which the multipart upload was initiated.</p>
|
|
432
458
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
433
|
-
* <p>When
|
|
434
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
459
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
460
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
435
461
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
436
462
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
437
463
|
*/
|
|
@@ -515,7 +541,8 @@ export interface CompleteMultipartUploadRequest {
|
|
|
515
541
|
*/
|
|
516
542
|
export interface CopyObjectResult {
|
|
517
543
|
/**
|
|
518
|
-
* <p>Returns the ETag of the new object. The ETag reflects only changes to the contents of an
|
|
544
|
+
* <p>Returns the ETag of the new object. The ETag reflects only changes to the contents of an
|
|
545
|
+
* object, not its metadata.</p>
|
|
519
546
|
*/
|
|
520
547
|
ETag?: string;
|
|
521
548
|
/**
|
|
@@ -573,7 +600,7 @@ export interface CopyObjectOutput {
|
|
|
573
600
|
VersionId?: string;
|
|
574
601
|
/**
|
|
575
602
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
576
|
-
* AES256, aws:kms).</p>
|
|
603
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
577
604
|
*/
|
|
578
605
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
579
606
|
/**
|
|
@@ -589,7 +616,7 @@ export interface CopyObjectOutput {
|
|
|
589
616
|
SSECustomerKeyMD5?: string;
|
|
590
617
|
/**
|
|
591
618
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
592
|
-
* customer managed key that was used for the object.</p>
|
|
619
|
+
* encryption customer managed key that was used for the object.</p>
|
|
593
620
|
*/
|
|
594
621
|
SSEKMSKeyId?: string;
|
|
595
622
|
/**
|
|
@@ -599,7 +626,8 @@ export interface CopyObjectOutput {
|
|
|
599
626
|
*/
|
|
600
627
|
SSEKMSEncryptionContext?: string;
|
|
601
628
|
/**
|
|
602
|
-
* <p>Indicates whether the copied object uses an S3 Bucket Key for server-side encryption
|
|
629
|
+
* <p>Indicates whether the copied object uses an S3 Bucket Key for server-side encryption
|
|
630
|
+
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
603
631
|
*/
|
|
604
632
|
BucketKeyEnabled?: boolean;
|
|
605
633
|
/**
|
|
@@ -719,8 +747,8 @@ export interface CopyObjectRequest {
|
|
|
719
747
|
/**
|
|
720
748
|
* <p>The name of the destination bucket.</p>
|
|
721
749
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
722
|
-
* <p>When
|
|
723
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
750
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
751
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
724
752
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
725
753
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
726
754
|
*/
|
|
@@ -800,14 +828,12 @@ export interface CopyObjectRequest {
|
|
|
800
828
|
*/
|
|
801
829
|
Expires?: Date;
|
|
802
830
|
/**
|
|
803
|
-
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
804
|
-
* object.</p>
|
|
831
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>
|
|
805
832
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
806
833
|
*/
|
|
807
834
|
GrantFullControl?: string;
|
|
808
835
|
/**
|
|
809
|
-
* <p>Allows grantee to read the object data and its
|
|
810
|
-
* metadata.</p>
|
|
836
|
+
* <p>Allows grantee to read the object data and its metadata.</p>
|
|
811
837
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
812
838
|
*/
|
|
813
839
|
GrantRead?: string;
|
|
@@ -817,8 +843,7 @@ export interface CopyObjectRequest {
|
|
|
817
843
|
*/
|
|
818
844
|
GrantReadACP?: string;
|
|
819
845
|
/**
|
|
820
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
821
|
-
* object.</p>
|
|
846
|
+
* <p>Allows grantee to write the ACL for the applicable object.</p>
|
|
822
847
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
823
848
|
*/
|
|
824
849
|
GrantWriteACP?: string;
|
|
@@ -842,7 +867,7 @@ export interface CopyObjectRequest {
|
|
|
842
867
|
TaggingDirective?: TaggingDirective | string;
|
|
843
868
|
/**
|
|
844
869
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
845
|
-
* AES256, aws:kms).</p>
|
|
870
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
846
871
|
*/
|
|
847
872
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
848
873
|
/**
|
|
@@ -850,13 +875,15 @@ export interface CopyObjectRequest {
|
|
|
850
875
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
851
876
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
852
877
|
* 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
|
|
853
|
-
*
|
|
878
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
854
879
|
*/
|
|
855
880
|
StorageClass?: StorageClass | string;
|
|
856
881
|
/**
|
|
857
882
|
* <p>If the bucket is configured as a website, redirects requests for this object to another
|
|
858
883
|
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
|
|
859
|
-
* the object metadata
|
|
884
|
+
* the object metadata. This value is unique to each object and is not copied when using the
|
|
885
|
+
* <code>x-amz-metadata-directive</code> header. Instead, you may opt to provide this
|
|
886
|
+
* header in combination with the directive.</p>
|
|
860
887
|
*/
|
|
861
888
|
WebsiteRedirectLocation?: string;
|
|
862
889
|
/**
|
|
@@ -878,22 +905,26 @@ export interface CopyObjectRequest {
|
|
|
878
905
|
*/
|
|
879
906
|
SSECustomerKeyMD5?: string;
|
|
880
907
|
/**
|
|
881
|
-
* <p>Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests
|
|
882
|
-
* an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For
|
|
883
|
-
* information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services
|
|
884
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the
|
|
885
|
-
* Signature Version in Request Authentication</a> in the
|
|
908
|
+
* <p>Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests
|
|
909
|
+
* for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For
|
|
910
|
+
* information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services
|
|
911
|
+
* CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the
|
|
912
|
+
* Signature Version in Request Authentication</a> in the
|
|
913
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
886
914
|
*/
|
|
887
915
|
SSEKMSKeyId?: string;
|
|
888
916
|
/**
|
|
889
|
-
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
890
|
-
* header is a base64-encoded UTF-8 string holding JSON with the encryption context
|
|
891
|
-
* pairs.</p>
|
|
917
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
918
|
+
* this header is a base64-encoded UTF-8 string holding JSON with the encryption context
|
|
919
|
+
* key-value pairs.</p>
|
|
892
920
|
*/
|
|
893
921
|
SSEKMSEncryptionContext?: string;
|
|
894
922
|
/**
|
|
895
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
896
|
-
*
|
|
923
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
924
|
+
* server-side encryption using AWS KMS (SSE-KMS). Setting this header to <code>true</code>
|
|
925
|
+
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. </p>
|
|
926
|
+
* <p>Specifying this header with a COPY action doesn’t affect bucket-level settings for S3
|
|
927
|
+
* Bucket Key.</p>
|
|
897
928
|
*/
|
|
898
929
|
BucketKeyEnabled?: boolean;
|
|
899
930
|
/**
|
|
@@ -1102,7 +1133,8 @@ export interface CreateBucketRequest {
|
|
|
1102
1133
|
GrantReadACP?: string;
|
|
1103
1134
|
/**
|
|
1104
1135
|
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
1105
|
-
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
1136
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
1137
|
+
* overwrites of those objects.</p>
|
|
1106
1138
|
*/
|
|
1107
1139
|
GrantWrite?: string;
|
|
1108
1140
|
/**
|
|
@@ -1120,11 +1152,11 @@ export interface CreateBucketRequest {
|
|
|
1120
1152
|
* ACL.</p>
|
|
1121
1153
|
* <p>ObjectWriter - The uploading account will own the object if the object is uploaded with
|
|
1122
1154
|
* the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
1123
|
-
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect
|
|
1124
|
-
* The bucket owner automatically owns and has full control over every object in
|
|
1125
|
-
* accepts PUT requests that don't specify an ACL or bucket owner
|
|
1126
|
-
* ACLs, such as the <code>bucket-owner-full-control</code> canned
|
|
1127
|
-
*
|
|
1155
|
+
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect
|
|
1156
|
+
* permissions. The bucket owner automatically owns and has full control over every object in
|
|
1157
|
+
* the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner
|
|
1158
|
+
* full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an
|
|
1159
|
+
* equivalent form of this ACL expressed in the XML format.</p>
|
|
1128
1160
|
*/
|
|
1129
1161
|
ObjectOwnership?: ObjectOwnership | string;
|
|
1130
1162
|
}
|
|
@@ -1137,7 +1169,7 @@ export interface CreateMultipartUploadOutput {
|
|
|
1137
1169
|
* multipart uploads and the prefix in the lifecycle rule matches the object name in the
|
|
1138
1170
|
* request, the response includes this header. The header indicates when the initiated
|
|
1139
1171
|
* multipart upload becomes eligible for an abort operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">
|
|
1140
|
-
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
|
1172
|
+
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p>
|
|
1141
1173
|
* <p>The response also includes the <code>x-amz-abort-rule-id</code> header that provides the
|
|
1142
1174
|
* ID of the lifecycle configuration rule that defines this action.</p>
|
|
1143
1175
|
*/
|
|
@@ -1149,10 +1181,11 @@ export interface CreateMultipartUploadOutput {
|
|
|
1149
1181
|
*/
|
|
1150
1182
|
AbortRuleId?: string;
|
|
1151
1183
|
/**
|
|
1152
|
-
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
1184
|
+
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
1185
|
+
* access point ARN or access point alias if used.</p>
|
|
1153
1186
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1154
|
-
* <p>When
|
|
1155
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
1187
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1188
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1156
1189
|
*/
|
|
1157
1190
|
Bucket?: string;
|
|
1158
1191
|
/**
|
|
@@ -1165,7 +1198,7 @@ export interface CreateMultipartUploadOutput {
|
|
|
1165
1198
|
UploadId?: string;
|
|
1166
1199
|
/**
|
|
1167
1200
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
1168
|
-
* AES256, aws:kms).</p>
|
|
1201
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
1169
1202
|
*/
|
|
1170
1203
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
1171
1204
|
/**
|
|
@@ -1181,7 +1214,7 @@ export interface CreateMultipartUploadOutput {
|
|
|
1181
1214
|
SSECustomerKeyMD5?: string;
|
|
1182
1215
|
/**
|
|
1183
1216
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
1184
|
-
* customer managed key that was used for the object.</p>
|
|
1217
|
+
* encryption customer managed key that was used for the object.</p>
|
|
1185
1218
|
*/
|
|
1186
1219
|
SSEKMSKeyId?: string;
|
|
1187
1220
|
/**
|
|
@@ -1191,7 +1224,8 @@ export interface CreateMultipartUploadOutput {
|
|
|
1191
1224
|
*/
|
|
1192
1225
|
SSEKMSEncryptionContext?: string;
|
|
1193
1226
|
/**
|
|
1194
|
-
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
1227
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
1228
|
+
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
1195
1229
|
*/
|
|
1196
1230
|
BucketKeyEnabled?: boolean;
|
|
1197
1231
|
/**
|
|
@@ -1216,8 +1250,8 @@ export interface CreateMultipartUploadRequest {
|
|
|
1216
1250
|
/**
|
|
1217
1251
|
* <p>The name of the bucket to which to initiate the upload</p>
|
|
1218
1252
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1219
|
-
* <p>When
|
|
1220
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
1253
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1254
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1221
1255
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1222
1256
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1223
1257
|
*/
|
|
@@ -1249,14 +1283,12 @@ export interface CreateMultipartUploadRequest {
|
|
|
1249
1283
|
*/
|
|
1250
1284
|
Expires?: Date;
|
|
1251
1285
|
/**
|
|
1252
|
-
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
1253
|
-
* object.</p>
|
|
1286
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>
|
|
1254
1287
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
1255
1288
|
*/
|
|
1256
1289
|
GrantFullControl?: string;
|
|
1257
1290
|
/**
|
|
1258
|
-
* <p>Allows grantee to read the object data and its
|
|
1259
|
-
* metadata.</p>
|
|
1291
|
+
* <p>Allows grantee to read the object data and its metadata.</p>
|
|
1260
1292
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
1261
1293
|
*/
|
|
1262
1294
|
GrantRead?: string;
|
|
@@ -1266,8 +1298,7 @@ export interface CreateMultipartUploadRequest {
|
|
|
1266
1298
|
*/
|
|
1267
1299
|
GrantReadACP?: string;
|
|
1268
1300
|
/**
|
|
1269
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
1270
|
-
* object.</p>
|
|
1301
|
+
* <p>Allows grantee to write the ACL for the applicable object.</p>
|
|
1271
1302
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
1272
1303
|
*/
|
|
1273
1304
|
GrantWriteACP?: string;
|
|
@@ -1281,7 +1312,7 @@ export interface CreateMultipartUploadRequest {
|
|
|
1281
1312
|
Metadata?: Record<string, string>;
|
|
1282
1313
|
/**
|
|
1283
1314
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
1284
|
-
* AES256, aws:kms).</p>
|
|
1315
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
1285
1316
|
*/
|
|
1286
1317
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
1287
1318
|
/**
|
|
@@ -1289,7 +1320,7 @@ export interface CreateMultipartUploadRequest {
|
|
|
1289
1320
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
1290
1321
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
1291
1322
|
* 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
|
|
1292
|
-
*
|
|
1323
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1293
1324
|
*/
|
|
1294
1325
|
StorageClass?: StorageClass | string;
|
|
1295
1326
|
/**
|
|
@@ -1317,22 +1348,25 @@ export interface CreateMultipartUploadRequest {
|
|
|
1317
1348
|
*/
|
|
1318
1349
|
SSECustomerKeyMD5?: string;
|
|
1319
1350
|
/**
|
|
1320
|
-
* <p>Specifies the ID of the symmetric customer managed key to use for object
|
|
1321
|
-
*
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1351
|
+
* <p>Specifies the ID of the symmetric encryption customer managed key to use for object encryption.
|
|
1352
|
+
* All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL
|
|
1353
|
+
* or using SigV4. For information about configuring using any of the officially supported
|
|
1354
|
+
* Amazon Web Services SDKs and Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in Request Authentication</a>
|
|
1324
1355
|
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
1325
1356
|
*/
|
|
1326
1357
|
SSEKMSKeyId?: string;
|
|
1327
1358
|
/**
|
|
1328
|
-
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
1329
|
-
* header is a base64-encoded UTF-8 string holding JSON with the encryption context
|
|
1330
|
-
* pairs.</p>
|
|
1359
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
1360
|
+
* this header is a base64-encoded UTF-8 string holding JSON with the encryption context
|
|
1361
|
+
* key-value pairs.</p>
|
|
1331
1362
|
*/
|
|
1332
1363
|
SSEKMSEncryptionContext?: string;
|
|
1333
1364
|
/**
|
|
1334
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
1335
|
-
*
|
|
1365
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
1366
|
+
* server-side encryption using AWS KMS (SSE-KMS). Setting this header to <code>true</code>
|
|
1367
|
+
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
1368
|
+
* <p>Specifying this header with an object action doesn’t affect bucket-level settings for S3
|
|
1369
|
+
* Bucket Key.</p>
|
|
1336
1370
|
*/
|
|
1337
1371
|
BucketKeyEnabled?: boolean;
|
|
1338
1372
|
/**
|
|
@@ -1492,7 +1526,8 @@ export interface DeleteBucketMetricsConfigurationRequest {
|
|
|
1492
1526
|
*/
|
|
1493
1527
|
Bucket: string | undefined;
|
|
1494
1528
|
/**
|
|
1495
|
-
* <p>The ID used to identify the metrics configuration
|
|
1529
|
+
* <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and
|
|
1530
|
+
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
1496
1531
|
*/
|
|
1497
1532
|
Id: string | undefined;
|
|
1498
1533
|
/**
|
|
@@ -1602,8 +1637,8 @@ export interface DeleteObjectRequest {
|
|
|
1602
1637
|
/**
|
|
1603
1638
|
* <p>The bucket name of the bucket containing the object. </p>
|
|
1604
1639
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1605
|
-
* <p>When
|
|
1606
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
1640
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1641
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1607
1642
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1608
1643
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1609
1644
|
*/
|
|
@@ -1631,8 +1666,8 @@ export interface DeleteObjectRequest {
|
|
|
1631
1666
|
RequestPayer?: RequestPayer | string;
|
|
1632
1667
|
/**
|
|
1633
1668
|
* <p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process
|
|
1634
|
-
* this operation. To use this header, you must have the
|
|
1635
|
-
*
|
|
1669
|
+
* this operation. To use this header, you must have the
|
|
1670
|
+
* <code>s3:BypassGovernanceRetention</code> permission.</p>
|
|
1636
1671
|
*/
|
|
1637
1672
|
BypassGovernanceRetention?: boolean;
|
|
1638
1673
|
/**
|
|
@@ -1681,10 +1716,8 @@ export interface _Error {
|
|
|
1681
1716
|
VersionId?: string;
|
|
1682
1717
|
/**
|
|
1683
1718
|
* <p>The error code is a string that uniquely identifies an error condition. It is meant to
|
|
1684
|
-
* be read and understood by programs that detect and handle errors by type.
|
|
1685
|
-
* <
|
|
1686
|
-
* <b>Amazon S3 error codes</b>
|
|
1687
|
-
* </p>
|
|
1719
|
+
* be read and understood by programs that detect and handle errors by type. The following is
|
|
1720
|
+
* a list of Amazon S3 error codes. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error responses</a>.</p>
|
|
1688
1721
|
* <ul>
|
|
1689
1722
|
* <li>
|
|
1690
1723
|
* <ul>
|
|
@@ -2244,8 +2277,8 @@ export interface _Error {
|
|
|
2244
2277
|
* <li>
|
|
2245
2278
|
* <p>
|
|
2246
2279
|
* <i>Description:</i> The specified location constraint is not
|
|
2247
|
-
* valid. For more information about Regions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">How to Select
|
|
2248
|
-
* Region for Your Buckets</a>. </p>
|
|
2280
|
+
* valid. For more information about Regions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">How to Select
|
|
2281
|
+
* a Region for Your Buckets</a>. </p>
|
|
2249
2282
|
* </li>
|
|
2250
2283
|
* <li>
|
|
2251
2284
|
* <p>
|
|
@@ -2393,7 +2426,8 @@ export interface _Error {
|
|
|
2393
2426
|
* </li>
|
|
2394
2427
|
* <li>
|
|
2395
2428
|
* <p>
|
|
2396
|
-
* <i>Description:</i> Please use
|
|
2429
|
+
* <i>Description:</i> Please use
|
|
2430
|
+
* <code>AWS4-HMAC-SHA256</code>.</p>
|
|
2397
2431
|
* </li>
|
|
2398
2432
|
* <li>
|
|
2399
2433
|
* <p>
|
|
@@ -3362,9 +3396,9 @@ export interface _Error {
|
|
|
3362
3396
|
* <p>
|
|
3363
3397
|
* <i>Description:</i> The request signature we calculated does
|
|
3364
3398
|
* not match the signature you provided. Check your Amazon Web Services secret access key and
|
|
3365
|
-
* signing method. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST
|
|
3366
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html">SOAP
|
|
3367
|
-
*
|
|
3399
|
+
* signing method. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST
|
|
3400
|
+
* Authentication</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html">SOAP
|
|
3401
|
+
* Authentication</a> for details.</p>
|
|
3368
3402
|
* </li>
|
|
3369
3403
|
* <li>
|
|
3370
3404
|
* <p>
|
|
@@ -3384,7 +3418,8 @@ export interface _Error {
|
|
|
3384
3418
|
* </li>
|
|
3385
3419
|
* <li>
|
|
3386
3420
|
* <p>
|
|
3387
|
-
* <i>Description:</i>
|
|
3421
|
+
* <i>Description:</i> Service is unable to handle
|
|
3422
|
+
* request.</p>
|
|
3388
3423
|
* </li>
|
|
3389
3424
|
* <li>
|
|
3390
3425
|
* <p>
|
|
@@ -3616,8 +3651,8 @@ export interface DeleteObjectsRequest {
|
|
|
3616
3651
|
/**
|
|
3617
3652
|
* <p>The bucket name containing the objects to delete. </p>
|
|
3618
3653
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3619
|
-
* <p>When
|
|
3620
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
3654
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
3655
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3621
3656
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
3622
3657
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
3623
3658
|
*/
|
|
@@ -3641,8 +3676,8 @@ export interface DeleteObjectsRequest {
|
|
|
3641
3676
|
RequestPayer?: RequestPayer | string;
|
|
3642
3677
|
/**
|
|
3643
3678
|
* <p>Specifies whether you want to delete this object even if it has a Governance-type Object
|
|
3644
|
-
* Lock in place. To use this header, you must have the
|
|
3645
|
-
*
|
|
3679
|
+
* Lock in place. To use this header, you must have the
|
|
3680
|
+
* <code>s3:BypassGovernanceRetention</code> permission.</p>
|
|
3646
3681
|
*/
|
|
3647
3682
|
BypassGovernanceRetention?: boolean;
|
|
3648
3683
|
/**
|
|
@@ -3657,8 +3692,8 @@ export interface DeleteObjectsRequest {
|
|
|
3657
3692
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3658
3693
|
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
3659
3694
|
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
3660
|
-
* <p>This checksum algorithm must be the same for all parts and it match the checksum
|
|
3661
|
-
*
|
|
3695
|
+
* <p>This checksum algorithm must be the same for all parts and it match the checksum value
|
|
3696
|
+
* supplied in the <code>CreateMultipartUpload</code> request.</p>
|
|
3662
3697
|
*/
|
|
3663
3698
|
ChecksumAlgorithm?: ChecksumAlgorithm | string;
|
|
3664
3699
|
}
|
|
@@ -3678,8 +3713,8 @@ export interface DeleteObjectTaggingRequest {
|
|
|
3678
3713
|
/**
|
|
3679
3714
|
* <p>The bucket name containing the objects from which to remove the tags. </p>
|
|
3680
3715
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3681
|
-
* <p>When
|
|
3682
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
3716
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
3717
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3683
3718
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
3684
3719
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
3685
3720
|
*/
|
|
@@ -3756,6 +3791,11 @@ export interface GetBucketAclOutput {
|
|
|
3756
3791
|
export interface GetBucketAclRequest {
|
|
3757
3792
|
/**
|
|
3758
3793
|
* <p>Specifies the S3 bucket whose ACL is being requested.</p>
|
|
3794
|
+
* <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
3795
|
+
* <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
3796
|
+
* If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
|
|
3797
|
+
* For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
|
|
3798
|
+
* Error Codes</a>.</p>
|
|
3759
3799
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
3760
3800
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
3761
3801
|
*/
|
|
@@ -3938,7 +3978,8 @@ export interface StorageClassAnalysis {
|
|
|
3938
3978
|
}
|
|
3939
3979
|
/**
|
|
3940
3980
|
* @public
|
|
3941
|
-
* <p>Specifies the configuration and any analyses for the analytics filter of an Amazon S3
|
|
3981
|
+
* <p>Specifies the configuration and any analyses for the analytics filter of an Amazon S3
|
|
3982
|
+
* bucket.</p>
|
|
3942
3983
|
*/
|
|
3943
3984
|
export interface AnalyticsConfiguration {
|
|
3944
3985
|
/**
|
|
@@ -4037,6 +4078,11 @@ export interface GetBucketCorsOutput {
|
|
|
4037
4078
|
export interface GetBucketCorsRequest {
|
|
4038
4079
|
/**
|
|
4039
4080
|
* <p>The bucket name for which to get the cors configuration.</p>
|
|
4081
|
+
* <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
4082
|
+
* <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
4083
|
+
* If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
|
|
4084
|
+
* For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
|
|
4085
|
+
* Error Codes</a>.</p>
|
|
4040
4086
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
4041
4087
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
4042
4088
|
*/
|
|
@@ -4051,8 +4097,9 @@ export interface GetBucketCorsRequest {
|
|
|
4051
4097
|
* <p>Describes the default server-side encryption to apply to new objects in the bucket. If a
|
|
4052
4098
|
* PUT Object request doesn't specify any server-side encryption, this default encryption will
|
|
4053
4099
|
* be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates
|
|
4054
|
-
* an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted
|
|
4055
|
-
* SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more
|
|
4100
|
+
* an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted
|
|
4101
|
+
* with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more
|
|
4102
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html">PUT Bucket encryption</a> in
|
|
4056
4103
|
* the <i>Amazon S3 API Reference</i>.</p>
|
|
4057
4104
|
*/
|
|
4058
4105
|
export interface ServerSideEncryptionByDefault {
|
|
@@ -4062,14 +4109,13 @@ export interface ServerSideEncryptionByDefault {
|
|
|
4062
4109
|
SSEAlgorithm: ServerSideEncryption | string | undefined;
|
|
4063
4110
|
/**
|
|
4064
4111
|
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default
|
|
4065
|
-
*
|
|
4066
|
-
*
|
|
4067
|
-
* <p>You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key.
|
|
4068
|
-
*
|
|
4069
|
-
*
|
|
4070
|
-
* <p>
|
|
4071
|
-
*
|
|
4072
|
-
* </p>
|
|
4112
|
+
* encryption. This parameter is allowed if and only if <code>SSEAlgorithm</code> is set to
|
|
4113
|
+
* <code>aws:kms</code>.</p>
|
|
4114
|
+
* <p>You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. If you use
|
|
4115
|
+
* a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow
|
|
4116
|
+
* log. </p>
|
|
4117
|
+
* <p>If you are using encryption with cross-account or Amazon Web Services service operations you must use
|
|
4118
|
+
* a fully qualified KMS key ARN. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using encryption for cross-account operations</a>. </p>
|
|
4073
4119
|
* <ul>
|
|
4074
4120
|
* <li>
|
|
4075
4121
|
* <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
@@ -4082,9 +4128,8 @@ export interface ServerSideEncryptionByDefault {
|
|
|
4082
4128
|
* </li>
|
|
4083
4129
|
* </ul>
|
|
4084
4130
|
* <important>
|
|
4085
|
-
* <p>Amazon S3 only supports symmetric KMS keys
|
|
4086
|
-
*
|
|
4087
|
-
* asymmetric keys</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>.</p>
|
|
4131
|
+
* <p>Amazon S3 only supports symmetric encryption KMS keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric keys in Amazon Web Services KMS</a> in the <i>Amazon Web Services Key Management Service
|
|
4132
|
+
* Developer Guide</i>.</p>
|
|
4088
4133
|
* </important>
|
|
4089
4134
|
*/
|
|
4090
4135
|
KMSMasterKeyID?: string;
|
|
@@ -4101,8 +4146,12 @@ export interface ServerSideEncryptionRule {
|
|
|
4101
4146
|
*/
|
|
4102
4147
|
ApplyServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;
|
|
4103
4148
|
/**
|
|
4104
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS
|
|
4105
|
-
*
|
|
4149
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS
|
|
4150
|
+
* (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the
|
|
4151
|
+
* <code>BucketKeyEnabled</code> element to <code>true</code> causes Amazon S3 to use an S3
|
|
4152
|
+
* Bucket Key. By default, S3 Bucket Key is not enabled.</p>
|
|
4153
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
4154
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
4106
4155
|
*/
|
|
4107
4156
|
BucketKeyEnabled?: boolean;
|
|
4108
4157
|
}
|
|
@@ -4225,17 +4274,18 @@ export interface Tiering {
|
|
|
4225
4274
|
*/
|
|
4226
4275
|
Days: number | undefined;
|
|
4227
4276
|
/**
|
|
4228
|
-
* <p>S3 Intelligent-Tiering access tier. See <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class
|
|
4229
|
-
* automatically optimizing frequently and infrequently accessed objects</a> for a
|
|
4230
|
-
* of access tiers in the S3 Intelligent-Tiering storage class.</p>
|
|
4277
|
+
* <p>S3 Intelligent-Tiering access tier. See <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class
|
|
4278
|
+
* for automatically optimizing frequently and infrequently accessed objects</a> for a
|
|
4279
|
+
* list of access tiers in the S3 Intelligent-Tiering storage class.</p>
|
|
4231
4280
|
*/
|
|
4232
4281
|
AccessTier: IntelligentTieringAccessTier | string | undefined;
|
|
4233
4282
|
}
|
|
4234
4283
|
/**
|
|
4235
4284
|
* @public
|
|
4236
4285
|
* <p>Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.</p>
|
|
4237
|
-
* <p>For information about the S3 Intelligent-Tiering storage class, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class
|
|
4238
|
-
* automatically optimizing frequently and infrequently accessed
|
|
4286
|
+
* <p>For information about the S3 Intelligent-Tiering storage class, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class
|
|
4287
|
+
* for automatically optimizing frequently and infrequently accessed
|
|
4288
|
+
* objects</a>.</p>
|
|
4239
4289
|
*/
|
|
4240
4290
|
export interface IntelligentTieringConfiguration {
|
|
4241
4291
|
/**
|
|
@@ -4286,8 +4336,8 @@ export interface GetBucketIntelligentTieringConfigurationRequest {
|
|
|
4286
4336
|
*/
|
|
4287
4337
|
export interface SSEKMS {
|
|
4288
4338
|
/**
|
|
4289
|
-
* <p>Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
4290
|
-
* to use for encrypting inventory reports.</p>
|
|
4339
|
+
* <p>Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption
|
|
4340
|
+
* customer managed key to use for encrypting inventory reports.</p>
|
|
4291
4341
|
*/
|
|
4292
4342
|
KeyId: string | undefined;
|
|
4293
4343
|
}
|
|
@@ -4441,8 +4491,7 @@ export interface InventorySchedule {
|
|
|
4441
4491
|
/**
|
|
4442
4492
|
* @public
|
|
4443
4493
|
* <p>Specifies the inventory configuration for an Amazon S3 bucket. For more information, see
|
|
4444
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html">GET Bucket inventory</a> in the <i>Amazon S3 API Reference</i>.
|
|
4445
|
-
* </p>
|
|
4494
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html">GET Bucket inventory</a> in the <i>Amazon S3 API Reference</i>. </p>
|
|
4446
4495
|
*/
|
|
4447
4496
|
export interface InventoryConfiguration {
|
|
4448
4497
|
/**
|
|
@@ -4512,11 +4561,13 @@ export interface GetBucketInventoryConfigurationRequest {
|
|
|
4512
4561
|
/**
|
|
4513
4562
|
* @public
|
|
4514
4563
|
* <p>Container for the expiration for the lifecycle of the object.</p>
|
|
4564
|
+
* <p>For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage
|
|
4565
|
+
* lifecycle</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4515
4566
|
*/
|
|
4516
4567
|
export interface LifecycleExpiration {
|
|
4517
4568
|
/**
|
|
4518
|
-
* <p>Indicates at what date the object is to be moved or deleted.
|
|
4519
|
-
*
|
|
4569
|
+
* <p>Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format.
|
|
4570
|
+
* The time is always midnight UTC.</p>
|
|
4520
4571
|
*/
|
|
4521
4572
|
Date?: Date;
|
|
4522
4573
|
/**
|
|
@@ -4657,15 +4708,17 @@ export declare namespace LifecycleRuleFilter {
|
|
|
4657
4708
|
export interface NoncurrentVersionExpiration {
|
|
4658
4709
|
/**
|
|
4659
4710
|
* <p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the
|
|
4660
|
-
* associated action. The value must be a non-zero positive integer. For information about the
|
|
4661
|
-
*
|
|
4711
|
+
* associated action. The value must be a non-zero positive integer. For information about the
|
|
4712
|
+
* noncurrent days calculations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations">How
|
|
4713
|
+
* Amazon S3 Calculates When an Object Became Noncurrent</a> in the
|
|
4714
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
4662
4715
|
*/
|
|
4663
4716
|
NoncurrentDays?: number;
|
|
4664
4717
|
/**
|
|
4665
|
-
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more
|
|
4666
|
-
* noncurrent versions, Amazon S3 will take the associated action. For more information
|
|
4667
|
-
* versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration
|
|
4668
|
-
*
|
|
4718
|
+
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more
|
|
4719
|
+
* recent noncurrent versions, Amazon S3 will take the associated action. For more information
|
|
4720
|
+
* about noncurrent versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration
|
|
4721
|
+
* elements</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4669
4722
|
*/
|
|
4670
4723
|
NewerNoncurrentVersions?: number;
|
|
4671
4724
|
}
|
|
@@ -4689,12 +4742,12 @@ export type TransitionStorageClass = (typeof TransitionStorageClass)[keyof typeo
|
|
|
4689
4742
|
* @public
|
|
4690
4743
|
* <p>Container for the transition rule that describes when noncurrent objects transition to
|
|
4691
4744
|
* the <code>STANDARD_IA</code>, <code>ONEZONE_IA</code>, <code>INTELLIGENT_TIERING</code>,
|
|
4692
|
-
*
|
|
4693
|
-
* versioning-enabled (or versioning is suspended), you can set this
|
|
4694
|
-
* Amazon S3 transition noncurrent object versions to the
|
|
4695
|
-
* <code>
|
|
4696
|
-
* <code>DEEP_ARCHIVE</code> storage
|
|
4697
|
-
* lifetime.</p>
|
|
4745
|
+
* <code>GLACIER_IR</code>, <code>GLACIER</code>, or <code>DEEP_ARCHIVE</code> storage
|
|
4746
|
+
* class. If your bucket is versioning-enabled (or versioning is suspended), you can set this
|
|
4747
|
+
* action to request that Amazon S3 transition noncurrent object versions to the
|
|
4748
|
+
* <code>STANDARD_IA</code>, <code>ONEZONE_IA</code>, <code>INTELLIGENT_TIERING</code>,
|
|
4749
|
+
* <code>GLACIER_IR</code>, <code>GLACIER</code>, or <code>DEEP_ARCHIVE</code> storage
|
|
4750
|
+
* class at a specific period in the object's lifetime.</p>
|
|
4698
4751
|
*/
|
|
4699
4752
|
export interface NoncurrentVersionTransition {
|
|
4700
4753
|
/**
|
|
@@ -4709,10 +4762,10 @@ export interface NoncurrentVersionTransition {
|
|
|
4709
4762
|
*/
|
|
4710
4763
|
StorageClass?: TransitionStorageClass | string;
|
|
4711
4764
|
/**
|
|
4712
|
-
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more
|
|
4713
|
-
* noncurrent versions, Amazon S3 will take the associated action. For more information
|
|
4714
|
-
* versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration
|
|
4715
|
-
*
|
|
4765
|
+
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more
|
|
4766
|
+
* recent noncurrent versions, Amazon S3 will take the associated action. For more information
|
|
4767
|
+
* about noncurrent versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration
|
|
4768
|
+
* elements</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4716
4769
|
*/
|
|
4717
4770
|
NewerNoncurrentVersions?: number;
|
|
4718
4771
|
}
|
|
@@ -4753,6 +4806,8 @@ export interface Transition {
|
|
|
4753
4806
|
/**
|
|
4754
4807
|
* @public
|
|
4755
4808
|
* <p>A lifecycle rule for individual objects in an Amazon S3 bucket.</p>
|
|
4809
|
+
* <p>For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage
|
|
4810
|
+
* lifecycle</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4756
4811
|
*/
|
|
4757
4812
|
export interface LifecycleRule {
|
|
4758
4813
|
/**
|
|
@@ -4810,7 +4865,7 @@ export interface LifecycleRule {
|
|
|
4810
4865
|
/**
|
|
4811
4866
|
* <p>Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will
|
|
4812
4867
|
* wait before permanently removing all parts of the upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">
|
|
4813
|
-
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
|
4868
|
+
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a> in the
|
|
4814
4869
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
4815
4870
|
*/
|
|
4816
4871
|
AbortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload;
|
|
@@ -4845,9 +4900,8 @@ export interface GetBucketLifecycleConfigurationRequest {
|
|
|
4845
4900
|
export interface GetBucketLocationOutput {
|
|
4846
4901
|
/**
|
|
4847
4902
|
* <p>Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported
|
|
4848
|
-
* location constraints by Region, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a>.
|
|
4849
|
-
*
|
|
4850
|
-
* <code>null</code>.</p>
|
|
4903
|
+
* location constraints by Region, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a>. Buckets in
|
|
4904
|
+
* Region <code>us-east-1</code> have a LocationConstraint of <code>null</code>.</p>
|
|
4851
4905
|
*/
|
|
4852
4906
|
LocationConstraint?: BucketLocationConstraint | string;
|
|
4853
4907
|
}
|
|
@@ -4857,6 +4911,11 @@ export interface GetBucketLocationOutput {
|
|
|
4857
4911
|
export interface GetBucketLocationRequest {
|
|
4858
4912
|
/**
|
|
4859
4913
|
* <p>The name of the bucket for which to get the location.</p>
|
|
4914
|
+
* <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
4915
|
+
* <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
4916
|
+
* If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
|
|
4917
|
+
* For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
|
|
4918
|
+
* Error Codes</a>.</p>
|
|
4860
4919
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
4861
4920
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
4862
4921
|
*/
|
|
@@ -4882,9 +4941,9 @@ export type BucketLogsPermission = (typeof BucketLogsPermission)[keyof typeof Bu
|
|
|
4882
4941
|
/**
|
|
4883
4942
|
* @public
|
|
4884
4943
|
* <p>Container for granting information.</p>
|
|
4885
|
-
* <p>Buckets that use the bucket owner enforced setting for Object
|
|
4886
|
-
*
|
|
4887
|
-
*
|
|
4944
|
+
* <p>Buckets that use the bucket owner enforced setting for Object Ownership don't support
|
|
4945
|
+
* target grants. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions server access log delivery</a> in the
|
|
4946
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
4888
4947
|
*/
|
|
4889
4948
|
export interface TargetGrant {
|
|
4890
4949
|
/**
|
|
@@ -4913,8 +4972,8 @@ export interface LoggingEnabled {
|
|
|
4913
4972
|
TargetBucket: string | undefined;
|
|
4914
4973
|
/**
|
|
4915
4974
|
* <p>Container for granting information.</p>
|
|
4916
|
-
* <p>Buckets that use the bucket owner enforced setting for Object
|
|
4917
|
-
*
|
|
4975
|
+
* <p>Buckets that use the bucket owner enforced setting for Object Ownership don't support
|
|
4976
|
+
* target grants. For more information, see <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
|
|
4918
4977
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
4919
4978
|
*/
|
|
4920
4979
|
TargetGrants?: TargetGrant[];
|
|
@@ -4974,8 +5033,8 @@ export interface MetricsAndOperator {
|
|
|
4974
5033
|
/**
|
|
4975
5034
|
* @public
|
|
4976
5035
|
* <p>Specifies a metrics configuration filter. The metrics configuration only includes
|
|
4977
|
-
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an
|
|
4978
|
-
* (MetricsAndOperator). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a>.</p>
|
|
5036
|
+
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an
|
|
5037
|
+
* access point ARN, or a conjunction (MetricsAndOperator). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a>.</p>
|
|
4979
5038
|
*/
|
|
4980
5039
|
export type MetricsFilter = MetricsFilter.AccessPointArnMember | MetricsFilter.AndMember | MetricsFilter.PrefixMember | MetricsFilter.TagMember | MetricsFilter.$UnknownMember;
|
|
4981
5040
|
/**
|
|
@@ -5050,13 +5109,14 @@ export declare namespace MetricsFilter {
|
|
|
5050
5109
|
*/
|
|
5051
5110
|
export interface MetricsConfiguration {
|
|
5052
5111
|
/**
|
|
5053
|
-
* <p>The ID used to identify the metrics configuration
|
|
5112
|
+
* <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and
|
|
5113
|
+
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
5054
5114
|
*/
|
|
5055
5115
|
Id: string | undefined;
|
|
5056
5116
|
/**
|
|
5057
5117
|
* <p>Specifies a metrics configuration filter. The metrics configuration will only include
|
|
5058
|
-
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an
|
|
5059
|
-
* (MetricsAndOperator).</p>
|
|
5118
|
+
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an
|
|
5119
|
+
* access point ARN, or a conjunction (MetricsAndOperator).</p>
|
|
5060
5120
|
*/
|
|
5061
5121
|
Filter?: MetricsFilter;
|
|
5062
5122
|
}
|
|
@@ -5080,7 +5140,8 @@ export interface GetBucketMetricsConfigurationRequest {
|
|
|
5080
5140
|
*/
|
|
5081
5141
|
Bucket: string | undefined;
|
|
5082
5142
|
/**
|
|
5083
|
-
* <p>The ID used to identify the metrics configuration
|
|
5143
|
+
* <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and
|
|
5144
|
+
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
5084
5145
|
*/
|
|
5085
5146
|
Id: string | undefined;
|
|
5086
5147
|
/**
|
|
@@ -5094,6 +5155,11 @@ export interface GetBucketMetricsConfigurationRequest {
|
|
|
5094
5155
|
export interface GetBucketNotificationConfigurationRequest {
|
|
5095
5156
|
/**
|
|
5096
5157
|
* <p>The name of the bucket for which to get the notification configuration.</p>
|
|
5158
|
+
* <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
5159
|
+
* <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
5160
|
+
* If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
|
|
5161
|
+
* For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
|
|
5162
|
+
* Error Codes</a>.</p>
|
|
5097
5163
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
5098
5164
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
5099
5165
|
*/
|
|
@@ -5190,8 +5256,7 @@ export interface S3KeyFilter {
|
|
|
5190
5256
|
/**
|
|
5191
5257
|
* @public
|
|
5192
5258
|
* <p>Specifies object key name filtering rules. For information about key name filtering, see
|
|
5193
|
-
*
|
|
5194
|
-
* Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5259
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html">Configuring event notifications using object key name filtering</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5195
5260
|
*/
|
|
5196
5261
|
export interface NotificationConfigurationFilter {
|
|
5197
5262
|
/**
|
|
@@ -5222,8 +5287,7 @@ export interface LambdaFunctionConfiguration {
|
|
|
5222
5287
|
Events: (Event | string)[] | undefined;
|
|
5223
5288
|
/**
|
|
5224
5289
|
* <p>Specifies object key name filtering rules. For information about key name filtering, see
|
|
5225
|
-
*
|
|
5226
|
-
* Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5290
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html">Configuring event notifications using object key name filtering</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5227
5291
|
*/
|
|
5228
5292
|
Filter?: NotificationConfigurationFilter;
|
|
5229
5293
|
}
|
|
@@ -5249,8 +5313,7 @@ export interface QueueConfiguration {
|
|
|
5249
5313
|
Events: (Event | string)[] | undefined;
|
|
5250
5314
|
/**
|
|
5251
5315
|
* <p>Specifies object key name filtering rules. For information about key name filtering, see
|
|
5252
|
-
*
|
|
5253
|
-
* Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5316
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html">Configuring event notifications using object key name filtering</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5254
5317
|
*/
|
|
5255
5318
|
Filter?: NotificationConfigurationFilter;
|
|
5256
5319
|
}
|
|
@@ -5278,8 +5341,7 @@ export interface TopicConfiguration {
|
|
|
5278
5341
|
Events: (Event | string)[] | undefined;
|
|
5279
5342
|
/**
|
|
5280
5343
|
* <p>Specifies object key name filtering rules. For information about key name filtering, see
|
|
5281
|
-
*
|
|
5282
|
-
* Event Notifications</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5344
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html">Configuring event notifications using object key name filtering</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5283
5345
|
*/
|
|
5284
5346
|
Filter?: NotificationConfigurationFilter;
|
|
5285
5347
|
}
|
|
@@ -5321,11 +5383,11 @@ export interface OwnershipControlsRule {
|
|
|
5321
5383
|
* ACL.</p>
|
|
5322
5384
|
* <p>ObjectWriter - The uploading account will own the object if the object is uploaded with
|
|
5323
5385
|
* the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
5324
|
-
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect
|
|
5325
|
-
* The bucket owner automatically owns and has full control over every object in
|
|
5326
|
-
* accepts PUT requests that don't specify an ACL or bucket owner
|
|
5327
|
-
* ACLs, such as the <code>bucket-owner-full-control</code> canned
|
|
5328
|
-
*
|
|
5386
|
+
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect
|
|
5387
|
+
* permissions. The bucket owner automatically owns and has full control over every object in
|
|
5388
|
+
* the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner
|
|
5389
|
+
* full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL or an
|
|
5390
|
+
* equivalent form of this ACL expressed in the XML format.</p>
|
|
5329
5391
|
*/
|
|
5330
5392
|
ObjectOwnership: ObjectOwnership | string | undefined;
|
|
5331
5393
|
}
|
|
@@ -5344,8 +5406,8 @@ export interface OwnershipControls {
|
|
|
5344
5406
|
*/
|
|
5345
5407
|
export interface GetBucketOwnershipControlsOutput {
|
|
5346
5408
|
/**
|
|
5347
|
-
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
5348
|
-
* effect for this Amazon S3 bucket.</p>
|
|
5409
|
+
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
5410
|
+
* ObjectWriter) currently in effect for this Amazon S3 bucket.</p>
|
|
5349
5411
|
*/
|
|
5350
5412
|
OwnershipControls?: OwnershipControls;
|
|
5351
5413
|
}
|
|
@@ -5380,6 +5442,11 @@ export interface GetBucketPolicyOutput {
|
|
|
5380
5442
|
export interface GetBucketPolicyRequest {
|
|
5381
5443
|
/**
|
|
5382
5444
|
* <p>The bucket name for which to get the bucket policy.</p>
|
|
5445
|
+
* <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
5446
|
+
* <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
5447
|
+
* If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
|
|
5448
|
+
* For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
|
|
5449
|
+
* Error Codes</a>.</p>
|
|
5383
5450
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
5384
5451
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
5385
5452
|
*/
|
|
@@ -5467,11 +5534,12 @@ export interface DeleteMarkerReplication {
|
|
|
5467
5534
|
*/
|
|
5468
5535
|
export interface EncryptionConfiguration {
|
|
5469
5536
|
/**
|
|
5470
|
-
* <p>Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key
|
|
5471
|
-
*
|
|
5472
|
-
*
|
|
5473
|
-
*
|
|
5474
|
-
*
|
|
5537
|
+
* <p>Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in
|
|
5538
|
+
* Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to
|
|
5539
|
+
* encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more
|
|
5540
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric keys in Amazon Web Services
|
|
5541
|
+
* KMS</a> in the <i>Amazon Web Services Key Management Service Developer
|
|
5542
|
+
* Guide</i>.</p>
|
|
5475
5543
|
*/
|
|
5476
5544
|
ReplicaKmsKeyID?: string;
|
|
5477
5545
|
}
|
|
@@ -5551,15 +5619,17 @@ export interface ReplicationTime {
|
|
|
5551
5619
|
*/
|
|
5552
5620
|
export interface Destination {
|
|
5553
5621
|
/**
|
|
5554
|
-
* <p> The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the
|
|
5622
|
+
* <p> The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the
|
|
5623
|
+
* results.</p>
|
|
5555
5624
|
*/
|
|
5556
5625
|
Bucket: string | undefined;
|
|
5557
5626
|
/**
|
|
5558
5627
|
* <p>Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to
|
|
5559
|
-
* change replica ownership to the Amazon Web Services account that owns the destination bucket by
|
|
5560
|
-
* the <code>AccessControlTranslation</code> property, this is the account ID of
|
|
5561
|
-
* destination bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html">Replication Additional
|
|
5562
|
-
* Configuration: Changing the Replica Owner</a> in the
|
|
5628
|
+
* change replica ownership to the Amazon Web Services account that owns the destination bucket by
|
|
5629
|
+
* specifying the <code>AccessControlTranslation</code> property, this is the account ID of
|
|
5630
|
+
* the destination bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html">Replication Additional
|
|
5631
|
+
* Configuration: Changing the Replica Owner</a> in the
|
|
5632
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
5563
5633
|
*/
|
|
5564
5634
|
Account?: string;
|
|
5565
5635
|
/**
|
|
@@ -5572,9 +5642,10 @@ export interface Destination {
|
|
|
5572
5642
|
StorageClass?: StorageClass | string;
|
|
5573
5643
|
/**
|
|
5574
5644
|
* <p>Specify this only in a cross-account scenario (where source and destination bucket
|
|
5575
|
-
* owners are not the same), and you want to change replica ownership to the Amazon Web Services account
|
|
5576
|
-
* owns the destination bucket. If this is not specified in the replication
|
|
5577
|
-
* replicas are owned by same Amazon Web Services account that owns the source
|
|
5645
|
+
* owners are not the same), and you want to change replica ownership to the Amazon Web Services account
|
|
5646
|
+
* that owns the destination bucket. If this is not specified in the replication
|
|
5647
|
+
* configuration, the replicas are owned by same Amazon Web Services account that owns the source
|
|
5648
|
+
* object.</p>
|
|
5578
5649
|
*/
|
|
5579
5650
|
AccessControlTranslation?: AccessControlTranslation;
|
|
5580
5651
|
/**
|
|
@@ -5614,7 +5685,7 @@ export type ExistingObjectReplicationStatus = (typeof ExistingObjectReplicationS
|
|
|
5614
5685
|
*/
|
|
5615
5686
|
export interface ExistingObjectReplication {
|
|
5616
5687
|
/**
|
|
5617
|
-
* <p
|
|
5688
|
+
* <p>Specifies whether Amazon S3 replicates existing source bucket objects. </p>
|
|
5618
5689
|
*/
|
|
5619
5690
|
Status: ExistingObjectReplicationStatus | string | undefined;
|
|
5620
5691
|
}
|
|
@@ -5775,14 +5846,14 @@ export interface SseKmsEncryptedObjects {
|
|
|
5775
5846
|
* <p>A container that describes additional filters for identifying the source objects that
|
|
5776
5847
|
* you want to replicate. You can choose to enable or disable the replication of these
|
|
5777
5848
|
* objects. Currently, Amazon S3 supports only the filter that you can specify for objects created
|
|
5778
|
-
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management
|
|
5779
|
-
*
|
|
5849
|
+
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service
|
|
5850
|
+
* (SSE-KMS).</p>
|
|
5780
5851
|
*/
|
|
5781
5852
|
export interface SourceSelectionCriteria {
|
|
5782
5853
|
/**
|
|
5783
|
-
* <p> A container for filter information for the selection of Amazon S3 objects encrypted with
|
|
5784
|
-
* KMS. If you include <code>SourceSelectionCriteria</code> in the replication
|
|
5785
|
-
* this element is required. </p>
|
|
5854
|
+
* <p> A container for filter information for the selection of Amazon S3 objects encrypted with
|
|
5855
|
+
* Amazon Web Services KMS. If you include <code>SourceSelectionCriteria</code> in the replication
|
|
5856
|
+
* configuration, this element is required. </p>
|
|
5786
5857
|
*/
|
|
5787
5858
|
SseKmsEncryptedObjects?: SseKmsEncryptedObjects;
|
|
5788
5859
|
/**
|
|
@@ -5856,12 +5927,14 @@ export interface ReplicationRule {
|
|
|
5856
5927
|
* <p>A container that describes additional filters for identifying the source objects that
|
|
5857
5928
|
* you want to replicate. You can choose to enable or disable the replication of these
|
|
5858
5929
|
* objects. Currently, Amazon S3 supports only the filter that you can specify for objects created
|
|
5859
|
-
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management
|
|
5860
|
-
*
|
|
5930
|
+
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service
|
|
5931
|
+
* (SSE-KMS).</p>
|
|
5861
5932
|
*/
|
|
5862
5933
|
SourceSelectionCriteria?: SourceSelectionCriteria;
|
|
5863
5934
|
/**
|
|
5864
|
-
* <p
|
|
5935
|
+
* <p>Optional configuration to replicate existing source bucket objects. For more
|
|
5936
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication">Replicating Existing Objects</a> in the <i>Amazon S3 User Guide</i>.
|
|
5937
|
+
* </p>
|
|
5865
5938
|
*/
|
|
5866
5939
|
ExistingObjectReplication?: ExistingObjectReplication;
|
|
5867
5940
|
/**
|
|
@@ -5892,9 +5965,9 @@ export interface ReplicationRule {
|
|
|
5892
5965
|
*/
|
|
5893
5966
|
export interface ReplicationConfiguration {
|
|
5894
5967
|
/**
|
|
5895
|
-
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that
|
|
5896
|
-
*
|
|
5897
|
-
*
|
|
5968
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when
|
|
5969
|
+
* replicating objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html">How to Set Up Replication</a>
|
|
5970
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
5898
5971
|
*/
|
|
5899
5972
|
Role: string | undefined;
|
|
5900
5973
|
/**
|
|
@@ -6280,8 +6353,8 @@ export interface GetObjectOutput {
|
|
|
6280
6353
|
*/
|
|
6281
6354
|
Expiration?: string;
|
|
6282
6355
|
/**
|
|
6283
|
-
* <p>Provides information about object restoration action and expiration time of the
|
|
6284
|
-
*
|
|
6356
|
+
* <p>Provides information about object restoration action and expiration time of the restored
|
|
6357
|
+
* object copy.</p>
|
|
6285
6358
|
*/
|
|
6286
6359
|
Restore?: string;
|
|
6287
6360
|
/**
|
|
@@ -6374,7 +6447,7 @@ export interface GetObjectOutput {
|
|
|
6374
6447
|
WebsiteRedirectLocation?: string;
|
|
6375
6448
|
/**
|
|
6376
6449
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
6377
|
-
* AES256, aws:kms).</p>
|
|
6450
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
6378
6451
|
*/
|
|
6379
6452
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
6380
6453
|
/**
|
|
@@ -6394,11 +6467,12 @@ export interface GetObjectOutput {
|
|
|
6394
6467
|
SSECustomerKeyMD5?: string;
|
|
6395
6468
|
/**
|
|
6396
6469
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
6397
|
-
* customer managed key that was used for the object.</p>
|
|
6470
|
+
* encryption customer managed key that was used for the object.</p>
|
|
6398
6471
|
*/
|
|
6399
6472
|
SSEKMSKeyId?: string;
|
|
6400
6473
|
/**
|
|
6401
|
-
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services
|
|
6474
|
+
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services
|
|
6475
|
+
* KMS (SSE-KMS).</p>
|
|
6402
6476
|
*/
|
|
6403
6477
|
BucketKeyEnabled?: boolean;
|
|
6404
6478
|
/**
|
|
@@ -6417,8 +6491,9 @@ export interface GetObjectOutput {
|
|
|
6417
6491
|
*/
|
|
6418
6492
|
ReplicationStatus?: ReplicationStatus | string;
|
|
6419
6493
|
/**
|
|
6420
|
-
* <p>The count of parts this object has. This value is only returned if you specify
|
|
6421
|
-
*
|
|
6494
|
+
* <p>The count of parts this object has. This value is only returned if you specify
|
|
6495
|
+
* <code>partNumber</code> in your request and the object was uploaded as a multipart
|
|
6496
|
+
* upload.</p>
|
|
6422
6497
|
*/
|
|
6423
6498
|
PartsCount?: number;
|
|
6424
6499
|
/**
|
|
@@ -6458,8 +6533,8 @@ export interface GetObjectRequest {
|
|
|
6458
6533
|
* <p>The bucket name containing the object. </p>
|
|
6459
6534
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6460
6535
|
* <p>When using an Object Lambda access point the hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com.</p>
|
|
6461
|
-
* <p>When
|
|
6462
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
6536
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
6537
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6463
6538
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
6464
6539
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
6465
6540
|
*/
|
|
@@ -6490,7 +6565,7 @@ export interface GetObjectRequest {
|
|
|
6490
6565
|
Key: string | undefined;
|
|
6491
6566
|
/**
|
|
6492
6567
|
* <p>Downloads the specified range bytes of an object. For more information about the HTTP
|
|
6493
|
-
* Range header, see <a href="https://www.
|
|
6568
|
+
* Range header, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-range">https://www.rfc-editor.org/rfc/rfc9110.html#name-range</a>.</p>
|
|
6494
6569
|
* <note>
|
|
6495
6570
|
* <p>Amazon S3 doesn't support retrieving multiple ranges of data per <code>GET</code>
|
|
6496
6571
|
* request.</p>
|
|
@@ -6741,9 +6816,9 @@ export interface GetObjectAttributesParts {
|
|
|
6741
6816
|
*/
|
|
6742
6817
|
MaxParts?: number;
|
|
6743
6818
|
/**
|
|
6744
|
-
* <p>Indicates whether the returned list of parts is truncated. A value of
|
|
6745
|
-
*
|
|
6746
|
-
*
|
|
6819
|
+
* <p>Indicates whether the returned list of parts is truncated. A value of <code>true</code>
|
|
6820
|
+
* indicates that the list was truncated. A list can be truncated if the number of parts
|
|
6821
|
+
* exceeds the limit returned in the <code>MaxParts</code> element.</p>
|
|
6747
6822
|
*/
|
|
6748
6823
|
IsTruncated?: boolean;
|
|
6749
6824
|
/**
|
|
@@ -6777,7 +6852,7 @@ export interface GetObjectAttributesOutput {
|
|
|
6777
6852
|
RequestCharged?: RequestCharged | string;
|
|
6778
6853
|
/**
|
|
6779
6854
|
* <p>An ETag is an opaque identifier assigned by a web server to a specific version of a
|
|
6780
|
-
*
|
|
6855
|
+
* resource found at a URL.</p>
|
|
6781
6856
|
*/
|
|
6782
6857
|
ETag?: string;
|
|
6783
6858
|
/**
|
|
@@ -6791,8 +6866,7 @@ export interface GetObjectAttributesOutput {
|
|
|
6791
6866
|
/**
|
|
6792
6867
|
* <p>Provides the storage class information of the object. Amazon S3 returns this header for all
|
|
6793
6868
|
* objects except for S3 Standard storage class objects.</p>
|
|
6794
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
6795
|
-
* Classes</a>.</p>
|
|
6869
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p>
|
|
6796
6870
|
*/
|
|
6797
6871
|
StorageClass?: StorageClass | string;
|
|
6798
6872
|
/**
|
|
@@ -6822,8 +6896,8 @@ export interface GetObjectAttributesRequest {
|
|
|
6822
6896
|
/**
|
|
6823
6897
|
* <p>The name of the bucket that contains the object.</p>
|
|
6824
6898
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6825
|
-
* <p>When
|
|
6826
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
6899
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
6900
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6827
6901
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
6828
6902
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
6829
6903
|
*/
|
|
@@ -6842,25 +6916,24 @@ export interface GetObjectAttributesRequest {
|
|
|
6842
6916
|
MaxParts?: number;
|
|
6843
6917
|
/**
|
|
6844
6918
|
* <p>Specifies the part after which listing should begin. Only parts with higher part numbers
|
|
6845
|
-
*
|
|
6919
|
+
* will be listed.</p>
|
|
6846
6920
|
*/
|
|
6847
6921
|
PartNumberMarker?: string;
|
|
6848
6922
|
/**
|
|
6849
|
-
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
6850
|
-
* AES256).</p>
|
|
6923
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>
|
|
6851
6924
|
*/
|
|
6852
6925
|
SSECustomerAlgorithm?: string;
|
|
6853
6926
|
/**
|
|
6854
6927
|
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
6855
|
-
*
|
|
6856
|
-
*
|
|
6928
|
+
* value is used to store the object and then it is discarded; Amazon S3 does not store the
|
|
6929
|
+
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
6857
6930
|
* <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
|
|
6858
6931
|
*/
|
|
6859
6932
|
SSECustomerKey?: string;
|
|
6860
6933
|
/**
|
|
6861
6934
|
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
6862
|
-
*
|
|
6863
|
-
*
|
|
6935
|
+
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
6936
|
+
* without error.</p>
|
|
6864
6937
|
*/
|
|
6865
6938
|
SSECustomerKeyMD5?: string;
|
|
6866
6939
|
/**
|
|
@@ -6875,8 +6948,8 @@ export interface GetObjectAttributesRequest {
|
|
|
6875
6948
|
*/
|
|
6876
6949
|
ExpectedBucketOwner?: string;
|
|
6877
6950
|
/**
|
|
6878
|
-
* <p>An XML header that specifies the fields at the root level that you want returned in
|
|
6879
|
-
*
|
|
6951
|
+
* <p>An XML header that specifies the fields at the root level that you want returned in the
|
|
6952
|
+
* response. Fields that you do not specify are not returned.</p>
|
|
6880
6953
|
*/
|
|
6881
6954
|
ObjectAttributes: (ObjectAttributes | string)[] | undefined;
|
|
6882
6955
|
}
|
|
@@ -6961,12 +7034,12 @@ export type ObjectLockRetentionMode = (typeof ObjectLockRetentionMode)[keyof typ
|
|
|
6961
7034
|
* <ul>
|
|
6962
7035
|
* <li>
|
|
6963
7036
|
* <p>The <code>DefaultRetention</code> settings require both a mode and a
|
|
6964
|
-
*
|
|
7037
|
+
* period.</p>
|
|
6965
7038
|
* </li>
|
|
6966
7039
|
* <li>
|
|
6967
|
-
* <p>The <code>DefaultRetention</code> period can be either <code>Days</code>
|
|
6968
|
-
*
|
|
6969
|
-
*
|
|
7040
|
+
* <p>The <code>DefaultRetention</code> period can be either <code>Days</code> or
|
|
7041
|
+
* <code>Years</code> but you must select one. You cannot specify
|
|
7042
|
+
* <code>Days</code> and <code>Years</code> at the same time.</p>
|
|
6970
7043
|
* </li>
|
|
6971
7044
|
* </ul>
|
|
6972
7045
|
* </note>
|
|
@@ -6995,9 +7068,9 @@ export interface DefaultRetention {
|
|
|
6995
7068
|
export interface ObjectLockRule {
|
|
6996
7069
|
/**
|
|
6997
7070
|
* <p>The default Object Lock retention mode and period that you want to apply to new objects
|
|
6998
|
-
* placed in the specified bucket. Bucket settings require both a mode and a period.
|
|
6999
|
-
*
|
|
7000
|
-
*
|
|
7071
|
+
* placed in the specified bucket. Bucket settings require both a mode and a period. The
|
|
7072
|
+
* period can be either <code>Days</code> or <code>Years</code> but you must select one. You
|
|
7073
|
+
* cannot specify <code>Days</code> and <code>Years</code> at the same time.</p>
|
|
7001
7074
|
*/
|
|
7002
7075
|
DefaultRetention?: DefaultRetention;
|
|
7003
7076
|
}
|
|
@@ -7007,16 +7080,17 @@ export interface ObjectLockRule {
|
|
|
7007
7080
|
*/
|
|
7008
7081
|
export interface ObjectLockConfiguration {
|
|
7009
7082
|
/**
|
|
7010
|
-
* <p>Indicates whether this bucket has an Object Lock configuration enabled.
|
|
7011
|
-
*
|
|
7012
|
-
*
|
|
7083
|
+
* <p>Indicates whether this bucket has an Object Lock configuration enabled. Enable
|
|
7084
|
+
* <code>ObjectLockEnabled</code> when you apply <code>ObjectLockConfiguration</code> to a
|
|
7085
|
+
* bucket. </p>
|
|
7013
7086
|
*/
|
|
7014
7087
|
ObjectLockEnabled?: ObjectLockEnabled | string;
|
|
7015
7088
|
/**
|
|
7016
|
-
* <p>Specifies the Object Lock rule for the specified object. Enable the this rule when you
|
|
7017
|
-
* <code>ObjectLockConfiguration</code> to a bucket. Bucket settings require both a mode
|
|
7018
|
-
* The period can be either <code>Days</code> or <code>Years</code> but you must
|
|
7019
|
-
* You cannot specify <code>Days</code> and <code>Years</code> at the same
|
|
7089
|
+
* <p>Specifies the Object Lock rule for the specified object. Enable the this rule when you
|
|
7090
|
+
* apply <code>ObjectLockConfiguration</code> to a bucket. Bucket settings require both a mode
|
|
7091
|
+
* and a period. The period can be either <code>Days</code> or <code>Years</code> but you must
|
|
7092
|
+
* select one. You cannot specify <code>Days</code> and <code>Years</code> at the same
|
|
7093
|
+
* time.</p>
|
|
7020
7094
|
*/
|
|
7021
7095
|
Rule?: ObjectLockRule;
|
|
7022
7096
|
}
|
|
@@ -7119,8 +7193,8 @@ export interface GetObjectTaggingRequest {
|
|
|
7119
7193
|
/**
|
|
7120
7194
|
* <p>The bucket name containing the object for which to get the tagging information. </p>
|
|
7121
7195
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7122
|
-
* <p>When
|
|
7123
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
7196
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
7197
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7124
7198
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
7125
7199
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
7126
7200
|
*/
|
|
@@ -7228,9 +7302,8 @@ export interface PublicAccessBlockConfiguration {
|
|
|
7228
7302
|
BlockPublicPolicy?: boolean;
|
|
7229
7303
|
/**
|
|
7230
7304
|
* <p>Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting
|
|
7231
|
-
* this element to <code>TRUE</code> restricts access to this bucket to only Amazon Web Service
|
|
7232
|
-
*
|
|
7233
|
-
* policy.</p>
|
|
7305
|
+
* this element to <code>TRUE</code> restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has
|
|
7306
|
+
* a public policy.</p>
|
|
7234
7307
|
* <p>Enabling this setting doesn't affect previously stored bucket policies, except that
|
|
7235
7308
|
* public and cross-account access within any public bucket policy, including non-public
|
|
7236
7309
|
* delegation to specific accounts, is blocked.</p>
|
|
@@ -7270,8 +7343,12 @@ export interface HeadBucketRequest {
|
|
|
7270
7343
|
/**
|
|
7271
7344
|
* <p>The bucket name.</p>
|
|
7272
7345
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7273
|
-
* <p>When
|
|
7274
|
-
*
|
|
7346
|
+
* <p>When you use this action with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
7347
|
+
* If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned.
|
|
7348
|
+
* For more information about <code>InvalidAccessPointAliasError</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList">List of
|
|
7349
|
+
* Error Codes</a>.</p>
|
|
7350
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
7351
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7275
7352
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
7276
7353
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
7277
7354
|
*/
|
|
@@ -7428,10 +7505,8 @@ export interface HeadObjectOutput {
|
|
|
7428
7505
|
*/
|
|
7429
7506
|
WebsiteRedirectLocation?: string;
|
|
7430
7507
|
/**
|
|
7431
|
-
* <p>
|
|
7432
|
-
*
|
|
7433
|
-
* the value of the server-side encryption algorithm used when storing this object in Amazon
|
|
7434
|
-
* S3 (for example, AES256, aws:kms).</p>
|
|
7508
|
+
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
7509
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
7435
7510
|
*/
|
|
7436
7511
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
7437
7512
|
/**
|
|
@@ -7451,18 +7526,18 @@ export interface HeadObjectOutput {
|
|
|
7451
7526
|
SSECustomerKeyMD5?: string;
|
|
7452
7527
|
/**
|
|
7453
7528
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
7454
|
-
* customer managed key that was used for the object.</p>
|
|
7529
|
+
* encryption customer managed key that was used for the object.</p>
|
|
7455
7530
|
*/
|
|
7456
7531
|
SSEKMSKeyId?: string;
|
|
7457
7532
|
/**
|
|
7458
|
-
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services
|
|
7533
|
+
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services
|
|
7534
|
+
* KMS (SSE-KMS).</p>
|
|
7459
7535
|
*/
|
|
7460
7536
|
BucketKeyEnabled?: boolean;
|
|
7461
7537
|
/**
|
|
7462
7538
|
* <p>Provides storage class information of the object. Amazon S3 returns this header for all
|
|
7463
7539
|
* objects except for S3 Standard storage class objects.</p>
|
|
7464
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
7465
|
-
* Classes</a>.</p>
|
|
7540
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p>
|
|
7466
7541
|
*/
|
|
7467
7542
|
StorageClass?: StorageClass | string;
|
|
7468
7543
|
/**
|
|
@@ -7481,9 +7556,9 @@ export interface HeadObjectOutput {
|
|
|
7481
7556
|
* <ul>
|
|
7482
7557
|
* <li>
|
|
7483
7558
|
* <p>
|
|
7484
|
-
* <b>If requesting an object from the source bucket</b>,
|
|
7485
|
-
*
|
|
7486
|
-
* eligible for replication.</p>
|
|
7559
|
+
* <b>If requesting an object from the source bucket</b>,
|
|
7560
|
+
* Amazon S3 will return the <code>x-amz-replication-status</code> header if the object in
|
|
7561
|
+
* your request is eligible for replication.</p>
|
|
7487
7562
|
* <p> For example, suppose that in your replication configuration, you specify object
|
|
7488
7563
|
* prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix
|
|
7489
7564
|
* <code>TaxDocs</code>. Any objects you upload with this key name prefix, for
|
|
@@ -7494,34 +7569,34 @@ export interface HeadObjectOutput {
|
|
|
7494
7569
|
* </li>
|
|
7495
7570
|
* <li>
|
|
7496
7571
|
* <p>
|
|
7497
|
-
* <b>If requesting an object from a destination
|
|
7498
|
-
*
|
|
7499
|
-
* your request is a replica that Amazon S3 created and
|
|
7500
|
-
* replication in progress.</p>
|
|
7572
|
+
* <b>If requesting an object from a destination
|
|
7573
|
+
* bucket</b>, Amazon S3 will return the <code>x-amz-replication-status</code> header
|
|
7574
|
+
* with value REPLICA if the object in your request is a replica that Amazon S3 created and
|
|
7575
|
+
* there is no replica modification replication in progress.</p>
|
|
7501
7576
|
* </li>
|
|
7502
7577
|
* <li>
|
|
7503
7578
|
* <p>
|
|
7504
|
-
* <b>When replicating objects to multiple destination
|
|
7505
|
-
* <code>x-amz-replication-status</code> header acts
|
|
7506
|
-
* source object will only return a value of COMPLETED
|
|
7507
|
-
* all destinations. The header will remain at value
|
|
7508
|
-
* completed for all destinations. If one or more
|
|
7509
|
-
* header will return FAILED. </p>
|
|
7579
|
+
* <b>When replicating objects to multiple destination
|
|
7580
|
+
* buckets</b>, the <code>x-amz-replication-status</code> header acts
|
|
7581
|
+
* differently. The header of the source object will only return a value of COMPLETED
|
|
7582
|
+
* when replication is successful to all destinations. The header will remain at value
|
|
7583
|
+
* PENDING until replication has completed for all destinations. If one or more
|
|
7584
|
+
* destinations fails replication the header will return FAILED. </p>
|
|
7510
7585
|
* </li>
|
|
7511
7586
|
* </ul>
|
|
7512
7587
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p>
|
|
7513
7588
|
*/
|
|
7514
7589
|
ReplicationStatus?: ReplicationStatus | string;
|
|
7515
7590
|
/**
|
|
7516
|
-
* <p>The count of parts this object has. This value is only returned if you specify
|
|
7517
|
-
*
|
|
7591
|
+
* <p>The count of parts this object has. This value is only returned if you specify
|
|
7592
|
+
* <code>partNumber</code> in your request and the object was uploaded as a multipart
|
|
7593
|
+
* upload.</p>
|
|
7518
7594
|
*/
|
|
7519
7595
|
PartsCount?: number;
|
|
7520
7596
|
/**
|
|
7521
7597
|
* <p>The Object Lock mode, if any, that's in effect for this object. This header is only
|
|
7522
7598
|
* returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more
|
|
7523
|
-
* information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object
|
|
7524
|
-
* Lock</a>. </p>
|
|
7599
|
+
* information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>. </p>
|
|
7525
7600
|
*/
|
|
7526
7601
|
ObjectLockMode?: ObjectLockMode | string;
|
|
7527
7602
|
/**
|
|
@@ -7544,8 +7619,8 @@ export interface HeadObjectRequest {
|
|
|
7544
7619
|
/**
|
|
7545
7620
|
* <p>The name of the bucket containing the object.</p>
|
|
7546
7621
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7547
|
-
* <p>When
|
|
7548
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
7622
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
7623
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7549
7624
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
7550
7625
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
7551
7626
|
*/
|
|
@@ -7575,8 +7650,9 @@ export interface HeadObjectRequest {
|
|
|
7575
7650
|
*/
|
|
7576
7651
|
Key: string | undefined;
|
|
7577
7652
|
/**
|
|
7578
|
-
* <p>
|
|
7579
|
-
*
|
|
7653
|
+
* <p>HeadObject returns only the metadata for an object. If the Range is satisfiable, only
|
|
7654
|
+
* the <code>ContentLength</code> is affected in the response. If the Range is not
|
|
7655
|
+
* satisfiable, S3 returns a <code>416 - Requested Range Not Satisfiable</code> error.</p>
|
|
7580
7656
|
*/
|
|
7581
7657
|
Range?: string;
|
|
7582
7658
|
/**
|
|
@@ -7621,8 +7697,8 @@ export interface HeadObjectRequest {
|
|
|
7621
7697
|
/**
|
|
7622
7698
|
* <p>To retrieve the checksum, this parameter must be enabled.</p>
|
|
7623
7699
|
* <p>In addition, if you enable <code>ChecksumMode</code> and the object is encrypted with
|
|
7624
|
-
*
|
|
7625
|
-
*
|
|
7700
|
+
* Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the
|
|
7701
|
+
* <code>kms:Decrypt</code> action for the request to succeed.</p>
|
|
7626
7702
|
*/
|
|
7627
7703
|
ChecksumMode?: ChecksumMode | string;
|
|
7628
7704
|
}
|
|
@@ -7823,7 +7899,8 @@ export interface Bucket {
|
|
|
7823
7899
|
*/
|
|
7824
7900
|
Name?: string;
|
|
7825
7901
|
/**
|
|
7826
|
-
* <p>Date the bucket was created. This date can change when making changes to your bucket,
|
|
7902
|
+
* <p>Date the bucket was created. This date can change when making changes to your bucket,
|
|
7903
|
+
* such as editing its bucket policy.</p>
|
|
7827
7904
|
*/
|
|
7828
7905
|
CreationDate?: Date;
|
|
7829
7906
|
}
|
|
@@ -7870,8 +7947,8 @@ export type EncodingType = (typeof EncodingType)[keyof typeof EncodingType];
|
|
|
7870
7947
|
*/
|
|
7871
7948
|
export interface Initiator {
|
|
7872
7949
|
/**
|
|
7873
|
-
* <p>If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the
|
|
7874
|
-
* is an IAM User, it provides a user ARN value.</p>
|
|
7950
|
+
* <p>If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the
|
|
7951
|
+
* principal is an IAM User, it provides a user ARN value.</p>
|
|
7875
7952
|
*/
|
|
7876
7953
|
ID?: string;
|
|
7877
7954
|
/**
|
|
@@ -7918,7 +7995,8 @@ export interface MultipartUpload {
|
|
|
7918
7995
|
*/
|
|
7919
7996
|
export interface ListMultipartUploadsOutput {
|
|
7920
7997
|
/**
|
|
7921
|
-
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
7998
|
+
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
7999
|
+
* access point ARN or access point alias if used.</p>
|
|
7922
8000
|
*/
|
|
7923
8001
|
Bucket?: string;
|
|
7924
8002
|
/**
|
|
@@ -7989,8 +8067,8 @@ export interface ListMultipartUploadsRequest {
|
|
|
7989
8067
|
/**
|
|
7990
8068
|
* <p>The name of the bucket to which the multipart upload was initiated. </p>
|
|
7991
8069
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7992
|
-
* <p>When
|
|
7993
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8070
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8071
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7994
8072
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
7995
8073
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
7996
8074
|
*/
|
|
@@ -8090,8 +8168,8 @@ export interface _Object {
|
|
|
8090
8168
|
* <ul>
|
|
8091
8169
|
* <li>
|
|
8092
8170
|
* <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the
|
|
8093
|
-
* Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that
|
|
8094
|
-
* an MD5 digest of their object data.</p>
|
|
8171
|
+
* Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that
|
|
8172
|
+
* are an MD5 digest of their object data.</p>
|
|
8095
8173
|
* </li>
|
|
8096
8174
|
* <li>
|
|
8097
8175
|
* <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the
|
|
@@ -8100,8 +8178,8 @@ export interface _Object {
|
|
|
8100
8178
|
* </li>
|
|
8101
8179
|
* <li>
|
|
8102
8180
|
* <p>If an object is created by either the Multipart Upload or Part Copy operation, the
|
|
8103
|
-
* ETag is not an MD5 digest, regardless of the method of encryption. If an object
|
|
8104
|
-
*
|
|
8181
|
+
* ETag is not an MD5 digest, regardless of the method of encryption. If an object is
|
|
8182
|
+
* larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a
|
|
8105
8183
|
* Multipart Upload, and therefore the ETag will not be an MD5 digest.</p>
|
|
8106
8184
|
* </li>
|
|
8107
8185
|
* </ul>
|
|
@@ -8172,8 +8250,8 @@ export interface ListObjectsOutput {
|
|
|
8172
8250
|
*/
|
|
8173
8251
|
MaxKeys?: number;
|
|
8174
8252
|
/**
|
|
8175
|
-
* <p>All of the keys (up to 1,000) rolled up in a common prefix count as a single return when
|
|
8176
|
-
* the number of returns. </p>
|
|
8253
|
+
* <p>All of the keys (up to 1,000) rolled up in a common prefix count as a single return when
|
|
8254
|
+
* calculating the number of returns. </p>
|
|
8177
8255
|
* <p>A response can contain CommonPrefixes only if you specify a delimiter.</p>
|
|
8178
8256
|
* <p>CommonPrefixes contains all (if there are any) keys between Prefix and the next
|
|
8179
8257
|
* occurrence of the string specified by the delimiter.</p>
|
|
@@ -8196,8 +8274,8 @@ export interface ListObjectsRequest {
|
|
|
8196
8274
|
/**
|
|
8197
8275
|
* <p>The name of the bucket containing the objects.</p>
|
|
8198
8276
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8199
|
-
* <p>When
|
|
8200
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8277
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8278
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8201
8279
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8202
8280
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8203
8281
|
*/
|
|
@@ -8216,12 +8294,12 @@ export interface ListObjectsRequest {
|
|
|
8216
8294
|
EncodingType?: EncodingType | string;
|
|
8217
8295
|
/**
|
|
8218
8296
|
* <p>Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after
|
|
8219
|
-
*
|
|
8297
|
+
* this specified key. Marker can be any key in the bucket.</p>
|
|
8220
8298
|
*/
|
|
8221
8299
|
Marker?: string;
|
|
8222
8300
|
/**
|
|
8223
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8224
|
-
* to 1,000 key names. The response might contain fewer keys but will never contain more.
|
|
8301
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8302
|
+
* up to 1,000 key names. The response might contain fewer keys but will never contain more.
|
|
8225
8303
|
* </p>
|
|
8226
8304
|
*/
|
|
8227
8305
|
MaxKeys?: number;
|
|
@@ -8268,8 +8346,8 @@ export interface ListObjectsV2Output {
|
|
|
8268
8346
|
/**
|
|
8269
8347
|
* <p>The bucket name.</p>
|
|
8270
8348
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8271
|
-
* <p>When
|
|
8272
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8349
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8350
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8273
8351
|
*/
|
|
8274
8352
|
Name?: string;
|
|
8275
8353
|
/**
|
|
@@ -8284,14 +8362,14 @@ export interface ListObjectsV2Output {
|
|
|
8284
8362
|
*/
|
|
8285
8363
|
Delimiter?: string;
|
|
8286
8364
|
/**
|
|
8287
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8288
|
-
* to 1,000 key names. The response might contain fewer keys but will never contain
|
|
8365
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8366
|
+
* up to 1,000 key names. The response might contain fewer keys but will never contain
|
|
8289
8367
|
* more.</p>
|
|
8290
8368
|
*/
|
|
8291
8369
|
MaxKeys?: number;
|
|
8292
8370
|
/**
|
|
8293
|
-
* <p>All of the keys (up to 1,000) rolled up into a common prefix count as a single return
|
|
8294
|
-
* the number of returns.</p>
|
|
8371
|
+
* <p>All of the keys (up to 1,000) rolled up into a common prefix count as a single return
|
|
8372
|
+
* when calculating the number of returns.</p>
|
|
8295
8373
|
* <p>A response can contain <code>CommonPrefixes</code> only if you specify a
|
|
8296
8374
|
* delimiter.</p>
|
|
8297
8375
|
* <p>
|
|
@@ -8317,8 +8395,8 @@ export interface ListObjectsV2Output {
|
|
|
8317
8395
|
EncodingType?: EncodingType | string;
|
|
8318
8396
|
/**
|
|
8319
8397
|
* <p>KeyCount is the number of keys returned with this request. KeyCount will always be less
|
|
8320
|
-
* than or
|
|
8321
|
-
*
|
|
8398
|
+
* than or equal to the <code>MaxKeys</code> field. Say you ask for 50 keys, your result will
|
|
8399
|
+
* include 50 keys or fewer.</p>
|
|
8322
8400
|
*/
|
|
8323
8401
|
KeyCount?: number;
|
|
8324
8402
|
/**
|
|
@@ -8345,8 +8423,8 @@ export interface ListObjectsV2Request {
|
|
|
8345
8423
|
/**
|
|
8346
8424
|
* <p>Bucket name to list. </p>
|
|
8347
8425
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8348
|
-
* <p>When
|
|
8349
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8426
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8427
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8350
8428
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8351
8429
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8352
8430
|
*/
|
|
@@ -8360,8 +8438,8 @@ export interface ListObjectsV2Request {
|
|
|
8360
8438
|
*/
|
|
8361
8439
|
EncodingType?: EncodingType | string;
|
|
8362
8440
|
/**
|
|
8363
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8364
|
-
* to 1,000 key names. The response might contain fewer keys but will never contain
|
|
8441
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8442
|
+
* up to 1,000 key names. The response might contain fewer keys but will never contain
|
|
8365
8443
|
* more.</p>
|
|
8366
8444
|
*/
|
|
8367
8445
|
MaxKeys?: number;
|
|
@@ -8582,9 +8660,9 @@ export interface ListObjectVersionsRequest {
|
|
|
8582
8660
|
*/
|
|
8583
8661
|
KeyMarker?: string;
|
|
8584
8662
|
/**
|
|
8585
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8586
|
-
* to 1,000 key names. The response might contain fewer keys but will never contain more.
|
|
8587
|
-
* additional keys satisfy the search criteria, but were not returned because max-keys was
|
|
8663
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8664
|
+
* up to 1,000 key names. The response might contain fewer keys but will never contain more.
|
|
8665
|
+
* If additional keys satisfy the search criteria, but were not returned because max-keys was
|
|
8588
8666
|
* exceeded, the response contains <isTruncated>true</isTruncated>. To return the
|
|
8589
8667
|
* additional keys, see key-marker and version-id-marker.</p>
|
|
8590
8668
|
*/
|
|
@@ -8665,8 +8743,7 @@ export interface ListPartsOutput {
|
|
|
8665
8743
|
* <p>If the bucket has a lifecycle rule configured with an action to abort incomplete
|
|
8666
8744
|
* multipart uploads and the prefix in the lifecycle rule matches the object name in the
|
|
8667
8745
|
* request, then the response includes this header indicating when the initiated multipart
|
|
8668
|
-
* upload will become eligible for abort operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting
|
|
8669
|
-
* Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p>
|
|
8746
|
+
* upload will become eligible for abort operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p>
|
|
8670
8747
|
* <p>The response will also include the <code>x-amz-abort-rule-id</code> header that will
|
|
8671
8748
|
* provide the ID of the lifecycle configuration rule that defines this action.</p>
|
|
8672
8749
|
*/
|
|
@@ -8678,7 +8755,8 @@ export interface ListPartsOutput {
|
|
|
8678
8755
|
*/
|
|
8679
8756
|
AbortRuleId?: string;
|
|
8680
8757
|
/**
|
|
8681
|
-
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
8758
|
+
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
8759
|
+
* access point ARN or access point alias if used.</p>
|
|
8682
8760
|
*/
|
|
8683
8761
|
Bucket?: string;
|
|
8684
8762
|
/**
|
|
@@ -8751,8 +8829,8 @@ export interface ListPartsRequest {
|
|
|
8751
8829
|
/**
|
|
8752
8830
|
* <p>The name of the bucket to which the parts are being uploaded. </p>
|
|
8753
8831
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8754
|
-
* <p>When
|
|
8755
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8832
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8833
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8756
8834
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8757
8835
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8758
8836
|
*/
|
|
@@ -8888,7 +8966,8 @@ export interface PutBucketAclRequest {
|
|
|
8888
8966
|
GrantReadACP?: string;
|
|
8889
8967
|
/**
|
|
8890
8968
|
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
8891
|
-
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
8969
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
8970
|
+
* overwrites of those objects.</p>
|
|
8892
8971
|
*/
|
|
8893
8972
|
GrantWrite?: string;
|
|
8894
8973
|
/**
|
|
@@ -8927,7 +9006,8 @@ export interface PutBucketAnalyticsConfigurationRequest {
|
|
|
8927
9006
|
* @public
|
|
8928
9007
|
* <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more
|
|
8929
9008
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
8930
|
-
* Cross-Origin Resource Sharing</a> in the
|
|
9009
|
+
* Cross-Origin Resource Sharing</a> in the
|
|
9010
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
8931
9011
|
*/
|
|
8932
9012
|
export interface CORSConfiguration {
|
|
8933
9013
|
/**
|
|
@@ -8948,8 +9028,9 @@ export interface PutBucketCorsRequest {
|
|
|
8948
9028
|
Bucket: string | undefined;
|
|
8949
9029
|
/**
|
|
8950
9030
|
* <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more
|
|
8951
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
8952
|
-
* Sharing</a> in the
|
|
9031
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
9032
|
+
* Cross-Origin Resource Sharing</a> in the
|
|
9033
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
8953
9034
|
*/
|
|
8954
9035
|
CORSConfiguration: CORSConfiguration | undefined;
|
|
8955
9036
|
/**
|
|
@@ -8981,16 +9062,19 @@ export interface PutBucketCorsRequest {
|
|
|
8981
9062
|
*/
|
|
8982
9063
|
export interface PutBucketEncryptionRequest {
|
|
8983
9064
|
/**
|
|
8984
|
-
* <p>Specifies default encryption for a bucket using server-side encryption with
|
|
8985
|
-
*
|
|
8986
|
-
*
|
|
9065
|
+
* <p>Specifies default encryption for a bucket using server-side encryption with different
|
|
9066
|
+
* key options. By default, all buckets have a default encryption configuration that
|
|
9067
|
+
* uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side
|
|
9068
|
+
* encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default
|
|
9069
|
+
* encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
|
|
8987
9070
|
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
8988
9071
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8989
9072
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8990
9073
|
*/
|
|
8991
9074
|
Bucket: string | undefined;
|
|
8992
9075
|
/**
|
|
8993
|
-
* <p>The base64-encoded 128-bit MD5 digest of the server-side encryption
|
|
9076
|
+
* <p>The base64-encoded 128-bit MD5 digest of the server-side encryption
|
|
9077
|
+
* configuration.</p>
|
|
8994
9078
|
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
8995
9079
|
*/
|
|
8996
9080
|
ContentMD5?: string;
|
|
@@ -9153,7 +9237,8 @@ export interface PutBucketMetricsConfigurationRequest {
|
|
|
9153
9237
|
*/
|
|
9154
9238
|
Bucket: string | undefined;
|
|
9155
9239
|
/**
|
|
9156
|
-
* <p>The ID used to identify the metrics configuration
|
|
9240
|
+
* <p>The ID used to identify the metrics configuration. The ID has a 64 character limit and
|
|
9241
|
+
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
9157
9242
|
*/
|
|
9158
9243
|
Id: string | undefined;
|
|
9159
9244
|
/**
|
|
@@ -9185,7 +9270,8 @@ export interface PutBucketNotificationConfigurationRequest {
|
|
|
9185
9270
|
*/
|
|
9186
9271
|
ExpectedBucketOwner?: string;
|
|
9187
9272
|
/**
|
|
9188
|
-
* <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda
|
|
9273
|
+
* <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda
|
|
9274
|
+
* destinations. True or false value.</p>
|
|
9189
9275
|
*/
|
|
9190
9276
|
SkipDestinationValidation?: boolean;
|
|
9191
9277
|
}
|
|
@@ -9209,8 +9295,8 @@ export interface PutBucketOwnershipControlsRequest {
|
|
|
9209
9295
|
*/
|
|
9210
9296
|
ExpectedBucketOwner?: string;
|
|
9211
9297
|
/**
|
|
9212
|
-
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
9213
|
-
* to apply to this Amazon S3 bucket.</p>
|
|
9298
|
+
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
9299
|
+
* ObjectWriter) that you want to apply to this Amazon S3 bucket.</p>
|
|
9214
9300
|
*/
|
|
9215
9301
|
OwnershipControls: OwnershipControls | undefined;
|
|
9216
9302
|
}
|
|
@@ -9315,10 +9401,9 @@ export interface PutBucketRequestPaymentRequest {
|
|
|
9315
9401
|
*/
|
|
9316
9402
|
Bucket: string | undefined;
|
|
9317
9403
|
/**
|
|
9318
|
-
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a
|
|
9319
|
-
*
|
|
9320
|
-
*
|
|
9321
|
-
* 1864</a>.</p>
|
|
9404
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message
|
|
9405
|
+
* integrity check to verify that the request body was not corrupted in transit. For more
|
|
9406
|
+
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC 1864</a>.</p>
|
|
9322
9407
|
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
9323
9408
|
*/
|
|
9324
9409
|
ContentMD5?: string;
|
|
@@ -9563,9 +9648,8 @@ export interface PutObjectOutput {
|
|
|
9563
9648
|
*/
|
|
9564
9649
|
ChecksumSHA256?: string;
|
|
9565
9650
|
/**
|
|
9566
|
-
* <p>
|
|
9567
|
-
*
|
|
9568
|
-
* confirms the encryption algorithm that Amazon S3 used to encrypt the object.</p>
|
|
9651
|
+
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
9652
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
9569
9653
|
*/
|
|
9570
9654
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
9571
9655
|
/**
|
|
@@ -9584,20 +9668,22 @@ export interface PutObjectOutput {
|
|
|
9584
9668
|
*/
|
|
9585
9669
|
SSECustomerKeyMD5?: string;
|
|
9586
9670
|
/**
|
|
9587
|
-
* <p>If <code>x-amz-server-side-encryption</code> is
|
|
9671
|
+
* <p>If <code>x-amz-server-side-encryption</code> is has a valid value of
|
|
9588
9672
|
* <code>aws:kms</code>, this header specifies the ID of the Amazon Web Services Key Management Service
|
|
9589
|
-
* (Amazon Web Services KMS) symmetric customer managed key that was used for the
|
|
9590
|
-
* object. </p>
|
|
9673
|
+
* (Amazon Web Services KMS) symmetric encryption customer managed key that was used for the object. </p>
|
|
9591
9674
|
*/
|
|
9592
9675
|
SSEKMSKeyId?: string;
|
|
9593
9676
|
/**
|
|
9594
9677
|
* <p>If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The
|
|
9595
9678
|
* value of this header is a base64-encoded UTF-8 string holding JSON with the encryption
|
|
9596
|
-
* context key-value pairs
|
|
9679
|
+
* context key-value pairs. This value is stored as object metadata and automatically gets passed
|
|
9680
|
+
* on to Amazon Web Services KMS for future <code>GetObject</code> or <code>CopyObject</code> operations on
|
|
9681
|
+
* this object.</p>
|
|
9597
9682
|
*/
|
|
9598
9683
|
SSEKMSEncryptionContext?: string;
|
|
9599
9684
|
/**
|
|
9600
|
-
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption
|
|
9685
|
+
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption
|
|
9686
|
+
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
9601
9687
|
*/
|
|
9602
9688
|
BucketKeyEnabled?: boolean;
|
|
9603
9689
|
/**
|
|
@@ -9612,7 +9698,7 @@ export interface PutObjectOutput {
|
|
|
9612
9698
|
export interface PutObjectRequest {
|
|
9613
9699
|
/**
|
|
9614
9700
|
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
9615
|
-
*
|
|
9701
|
+
* ACL</a>.</p>
|
|
9616
9702
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9617
9703
|
*/
|
|
9618
9704
|
ACL?: ObjectCannedACL | string;
|
|
@@ -9623,8 +9709,8 @@ export interface PutObjectRequest {
|
|
|
9623
9709
|
/**
|
|
9624
9710
|
* <p>The bucket name to which the PUT action was initiated. </p>
|
|
9625
9711
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9626
|
-
* <p>When
|
|
9627
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
9712
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
9713
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9628
9714
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
9629
9715
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
9630
9716
|
*/
|
|
@@ -9635,13 +9721,13 @@ export interface PutObjectRequest {
|
|
|
9635
9721
|
*/
|
|
9636
9722
|
CacheControl?: string;
|
|
9637
9723
|
/**
|
|
9638
|
-
* <p>Specifies presentational information for the object. For more information, see <a href="
|
|
9724
|
+
* <p>Specifies presentational information for the object. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc6266#section-4">https://www.rfc-editor.org/rfc/rfc6266#section-4</a>.</p>
|
|
9639
9725
|
*/
|
|
9640
9726
|
ContentDisposition?: string;
|
|
9641
9727
|
/**
|
|
9642
9728
|
* <p>Specifies what content encodings have been applied to the object and thus what decoding
|
|
9643
9729
|
* mechanisms must be applied to obtain the media-type referenced by the Content-Type header
|
|
9644
|
-
* field. For more information, see <a href="
|
|
9730
|
+
* field. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding">https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding</a>.</p>
|
|
9645
9731
|
*/
|
|
9646
9732
|
ContentEncoding?: string;
|
|
9647
9733
|
/**
|
|
@@ -9650,7 +9736,7 @@ export interface PutObjectRequest {
|
|
|
9650
9736
|
ContentLanguage?: string;
|
|
9651
9737
|
/**
|
|
9652
9738
|
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be
|
|
9653
|
-
* determined automatically. For more information, see <a href="
|
|
9739
|
+
* determined automatically. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length</a>.</p>
|
|
9654
9740
|
*/
|
|
9655
9741
|
ContentLength?: number;
|
|
9656
9742
|
/**
|
|
@@ -9658,13 +9744,12 @@ export interface PutObjectRequest {
|
|
|
9658
9744
|
* RFC 1864. This header can be used as a message integrity check to verify that the data is
|
|
9659
9745
|
* the same data that was originally sent. Although it is optional, we recommend using the
|
|
9660
9746
|
* Content-MD5 mechanism as an end-to-end integrity check. For more information about REST
|
|
9661
|
-
* request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST
|
|
9662
|
-
* Authentication</a>.</p>
|
|
9747
|
+
* request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
|
|
9663
9748
|
*/
|
|
9664
9749
|
ContentMD5?: string;
|
|
9665
9750
|
/**
|
|
9666
9751
|
* <p>A standard MIME type describing the format of the contents. For more information, see
|
|
9667
|
-
* <a href="
|
|
9752
|
+
* <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type">https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type</a>.</p>
|
|
9668
9753
|
*/
|
|
9669
9754
|
ContentType?: string;
|
|
9670
9755
|
/**
|
|
@@ -9707,18 +9792,16 @@ export interface PutObjectRequest {
|
|
|
9707
9792
|
ChecksumSHA256?: string;
|
|
9708
9793
|
/**
|
|
9709
9794
|
* <p>The date and time at which the object is no longer cacheable. For more information, see
|
|
9710
|
-
* <a href="
|
|
9795
|
+
* <a href="https://www.rfc-editor.org/rfc/rfc7234#section-5.3">https://www.rfc-editor.org/rfc/rfc7234#section-5.3</a>.</p>
|
|
9711
9796
|
*/
|
|
9712
9797
|
Expires?: Date;
|
|
9713
9798
|
/**
|
|
9714
|
-
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
9715
|
-
* object.</p>
|
|
9799
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>
|
|
9716
9800
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9717
9801
|
*/
|
|
9718
9802
|
GrantFullControl?: string;
|
|
9719
9803
|
/**
|
|
9720
|
-
* <p>Allows grantee to read the object data and its
|
|
9721
|
-
* metadata.</p>
|
|
9804
|
+
* <p>Allows grantee to read the object data and its metadata.</p>
|
|
9722
9805
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9723
9806
|
*/
|
|
9724
9807
|
GrantRead?: string;
|
|
@@ -9728,8 +9811,7 @@ export interface PutObjectRequest {
|
|
|
9728
9811
|
*/
|
|
9729
9812
|
GrantReadACP?: string;
|
|
9730
9813
|
/**
|
|
9731
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
9732
|
-
* object.</p>
|
|
9814
|
+
* <p>Allows grantee to write the ACL for the applicable object.</p>
|
|
9733
9815
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9734
9816
|
*/
|
|
9735
9817
|
GrantWriteACP?: string;
|
|
@@ -9743,7 +9825,7 @@ export interface PutObjectRequest {
|
|
|
9743
9825
|
Metadata?: Record<string, string>;
|
|
9744
9826
|
/**
|
|
9745
9827
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
9746
|
-
* AES256, aws:kms).</p>
|
|
9828
|
+
* AES256, <code>aws:kms</code>).</p>
|
|
9747
9829
|
*/
|
|
9748
9830
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
9749
9831
|
/**
|
|
@@ -9751,7 +9833,7 @@ export interface PutObjectRequest {
|
|
|
9751
9833
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
9752
9834
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
9753
9835
|
* 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
|
|
9754
|
-
*
|
|
9836
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
9755
9837
|
*/
|
|
9756
9838
|
StorageClass?: StorageClass | string;
|
|
9757
9839
|
/**
|
|
@@ -9768,8 +9850,9 @@ export interface PutObjectRequest {
|
|
|
9768
9850
|
* <p>
|
|
9769
9851
|
* <code>x-amz-website-redirect-location: http://www.example.com/</code>
|
|
9770
9852
|
* </p>
|
|
9771
|
-
* <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and
|
|
9772
|
-
*
|
|
9853
|
+
* <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and
|
|
9854
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to
|
|
9855
|
+
* Configure Website Page Redirects</a>. </p>
|
|
9773
9856
|
*/
|
|
9774
9857
|
WebsiteRedirectLocation?: string;
|
|
9775
9858
|
/**
|
|
@@ -9791,25 +9874,29 @@ export interface PutObjectRequest {
|
|
|
9791
9874
|
*/
|
|
9792
9875
|
SSECustomerKeyMD5?: string;
|
|
9793
9876
|
/**
|
|
9794
|
-
* <p>If <code>x-amz-server-side-encryption</code>
|
|
9795
|
-
*
|
|
9796
|
-
*
|
|
9797
|
-
*
|
|
9798
|
-
*
|
|
9799
|
-
*
|
|
9800
|
-
*
|
|
9801
|
-
* </p>
|
|
9877
|
+
* <p>If <code>x-amz-server-side-encryption</code> has a valid value of <code>aws:kms</code>,
|
|
9878
|
+
* this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
9879
|
+
* encryption customer managed key that was used for the object. If you specify
|
|
9880
|
+
* <code>x-amz-server-side-encryption:aws:kms</code>, but do not provide<code>
|
|
9881
|
+
* x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key to
|
|
9882
|
+
* protect the data. If the KMS key does not exist in the same account issuing the command,
|
|
9883
|
+
* you must use the full ARN and not just the ID. </p>
|
|
9802
9884
|
*/
|
|
9803
9885
|
SSEKMSKeyId?: string;
|
|
9804
9886
|
/**
|
|
9805
|
-
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
9806
|
-
* header is a base64-encoded UTF-8 string holding JSON with the encryption context
|
|
9807
|
-
* pairs
|
|
9887
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
9888
|
+
* this header is a base64-encoded UTF-8 string holding JSON with the encryption context
|
|
9889
|
+
* key-value pairs. This value is stored as object metadata and automatically gets passed on to
|
|
9890
|
+
* Amazon Web Services KMS for future <code>GetObject</code> or <code>CopyObject</code> operations on this
|
|
9891
|
+
* object.</p>
|
|
9808
9892
|
*/
|
|
9809
9893
|
SSEKMSEncryptionContext?: string;
|
|
9810
9894
|
/**
|
|
9811
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
9812
|
-
*
|
|
9895
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
9896
|
+
* server-side encryption using AWS KMS (SSE-KMS). Setting this header to <code>true</code>
|
|
9897
|
+
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
9898
|
+
* <p>Specifying this header with a PUT action doesn’t affect bucket-level settings for S3
|
|
9899
|
+
* Bucket Key.</p>
|
|
9813
9900
|
*/
|
|
9814
9901
|
BucketKeyEnabled?: boolean;
|
|
9815
9902
|
/**
|
|
@@ -9835,8 +9922,7 @@ export interface PutObjectRequest {
|
|
|
9835
9922
|
ObjectLockRetainUntilDate?: Date;
|
|
9836
9923
|
/**
|
|
9837
9924
|
* <p>Specifies whether a legal hold will be applied to this object. For more information
|
|
9838
|
-
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object
|
|
9839
|
-
* Lock</a>.</p>
|
|
9925
|
+
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a>.</p>
|
|
9840
9926
|
*/
|
|
9841
9927
|
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string;
|
|
9842
9928
|
/**
|
|
@@ -9859,7 +9945,8 @@ export interface PutObjectAclOutput {
|
|
|
9859
9945
|
*/
|
|
9860
9946
|
export interface PutObjectAclRequest {
|
|
9861
9947
|
/**
|
|
9862
|
-
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
9948
|
+
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
9949
|
+
* ACL</a>.</p>
|
|
9863
9950
|
*/
|
|
9864
9951
|
ACL?: ObjectCannedACL | string;
|
|
9865
9952
|
/**
|
|
@@ -9899,8 +9986,7 @@ export interface PutObjectAclRequest {
|
|
|
9899
9986
|
*/
|
|
9900
9987
|
GrantFullControl?: string;
|
|
9901
9988
|
/**
|
|
9902
|
-
* <p>Allows grantee to list the objects in the
|
|
9903
|
-
* bucket.</p>
|
|
9989
|
+
* <p>Allows grantee to list the objects in the bucket.</p>
|
|
9904
9990
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9905
9991
|
*/
|
|
9906
9992
|
GrantRead?: string;
|
|
@@ -9911,20 +9997,20 @@ export interface PutObjectAclRequest {
|
|
|
9911
9997
|
GrantReadACP?: string;
|
|
9912
9998
|
/**
|
|
9913
9999
|
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
9914
|
-
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
10000
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
10001
|
+
* overwrites of those objects.</p>
|
|
9915
10002
|
*/
|
|
9916
10003
|
GrantWrite?: string;
|
|
9917
10004
|
/**
|
|
9918
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
9919
|
-
* bucket.</p>
|
|
10005
|
+
* <p>Allows grantee to write the ACL for the applicable bucket.</p>
|
|
9920
10006
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9921
10007
|
*/
|
|
9922
10008
|
GrantWriteACP?: string;
|
|
9923
10009
|
/**
|
|
9924
10010
|
* <p>Key for which the PUT action was initiated.</p>
|
|
9925
10011
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9926
|
-
* <p>When
|
|
9927
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
10012
|
+
* <p>When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
10013
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">What is S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9928
10014
|
*/
|
|
9929
10015
|
Key: string | undefined;
|
|
9930
10016
|
/**
|