@aws-sdk/client-s3 3.697.0 → 3.698.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +152 -5
- package/dist-es/models/models_1.js +48 -0
- package/dist-es/protocols/Aws_restXml.js +75 -4
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +16 -13
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +47 -42
- package/dist-types/commands/CopyObjectCommand.d.ts +77 -57
- package/dist-types/commands/CreateBucketCommand.d.ts +60 -45
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +92 -66
- package/dist-types/commands/CreateSessionCommand.d.ts +30 -16
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketCommand.d.ts +10 -3
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +18 -10
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +52 -9
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +25 -21
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/DeleteObjectCommand.d.ts +3 -0
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteObjectsCommand.d.ts +41 -27
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAclCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +18 -10
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +61 -17
- package/dist-types/commands/GetBucketLocationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +30 -21
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +62 -44
- package/dist-types/commands/GetObjectCommand.d.ts +79 -60
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +1 -1
- 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 +32 -16
- package/dist-types/commands/HeadObjectCommand.d.ts +60 -38
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBucketsCommand.d.ts +6 -6
- package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +10 -4
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +50 -33
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListObjectsCommand.d.ts +1 -1
- package/dist-types/commands/ListObjectsV2Command.d.ts +23 -14
- package/dist-types/commands/ListPartsCommand.d.ts +22 -17
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketAclCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +47 -32
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +84 -45
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +30 -21
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +3 -4
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +3 -6
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectCommand.d.ts +83 -35
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -1
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +2 -2
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +1 -1
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +1 -1
- package/dist-types/commands/SelectObjectContentCommand.d.ts +1 -1
- package/dist-types/commands/UploadPartCommand.d.ts +52 -41
- package/dist-types/commands/UploadPartCopyCommand.d.ts +53 -39
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +938 -632
- package/dist-types/models/models_1.d.ts +230 -135
- package/dist-types/ts3.4/models/models_0.d.ts +7 -0
- package/dist-types/ts3.4/models/models_1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -59,7 +59,8 @@ export interface AbortMultipartUploadRequest {
|
|
|
59
59
|
/**
|
|
60
60
|
* <p>The bucket name to which the upload was taking place. </p>
|
|
61
61
|
* <p>
|
|
62
|
-
* <b>Directory buckets</b> -
|
|
62
|
+
* <b>Directory buckets</b> -
|
|
63
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
63
64
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
64
65
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
65
66
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -91,9 +92,9 @@ export interface AbortMultipartUploadRequest {
|
|
|
91
92
|
/**
|
|
92
93
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
93
94
|
* owners need not specify this parameter in their requests. If either the source or
|
|
94
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
95
|
-
*
|
|
96
|
-
*
|
|
95
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
96
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
97
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
97
98
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
98
99
|
* <note>
|
|
99
100
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -106,6 +107,17 @@ export interface AbortMultipartUploadRequest {
|
|
|
106
107
|
* @public
|
|
107
108
|
*/
|
|
108
109
|
ExpectedBucketOwner?: string | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* <p>If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp.
|
|
112
|
+
* If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a <code>412 Precondition Failed</code> error.
|
|
113
|
+
* If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a <code>204 Success (No Content)</code> response.
|
|
114
|
+
* </p>
|
|
115
|
+
* <note>
|
|
116
|
+
* <p>This functionality is only supported for directory buckets.</p>
|
|
117
|
+
* </note>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
IfMatchInitiatedTime?: Date | undefined;
|
|
109
121
|
}
|
|
110
122
|
/**
|
|
111
123
|
* <p>The specified multipart upload does not exist.</p>
|
|
@@ -508,14 +520,20 @@ export interface CompletedPart {
|
|
|
508
520
|
* <ul>
|
|
509
521
|
* <li>
|
|
510
522
|
* <p>
|
|
511
|
-
* <b>General purpose buckets</b> - In
|
|
512
|
-
*
|
|
513
|
-
*
|
|
523
|
+
* <b>General purpose buckets</b> - In
|
|
524
|
+
* <code>CompleteMultipartUpload</code>, when a additional checksum (including
|
|
525
|
+
* <code>x-amz-checksum-crc32</code>, <code>x-amz-checksum-crc32c</code>,
|
|
526
|
+
* <code>x-amz-checksum-sha1</code>, or <code>x-amz-checksum-sha256</code>) is
|
|
527
|
+
* applied to each part, the <code>PartNumber</code> must start at 1 and the part
|
|
528
|
+
* numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP <code>400 Bad
|
|
529
|
+
* Request</code> status code and an <code>InvalidPartOrder</code> error
|
|
530
|
+
* code.</p>
|
|
514
531
|
* </li>
|
|
515
532
|
* <li>
|
|
516
533
|
* <p>
|
|
517
|
-
* <b>Directory buckets</b> - In
|
|
518
|
-
*
|
|
534
|
+
* <b>Directory buckets</b> - In
|
|
535
|
+
* <code>CompleteMultipartUpload</code>, the <code>PartNumber</code> must start at
|
|
536
|
+
* 1 and the part numbers must be consecutive.</p>
|
|
519
537
|
* </li>
|
|
520
538
|
* </ul>
|
|
521
539
|
* </note>
|
|
@@ -543,7 +561,8 @@ export interface CompleteMultipartUploadRequest {
|
|
|
543
561
|
/**
|
|
544
562
|
* <p>Name of the bucket to which the multipart upload was initiated.</p>
|
|
545
563
|
* <p>
|
|
546
|
-
* <b>Directory buckets</b> -
|
|
564
|
+
* <b>Directory buckets</b> -
|
|
565
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
547
566
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
548
567
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
549
568
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -612,9 +631,9 @@ export interface CompleteMultipartUploadRequest {
|
|
|
612
631
|
/**
|
|
613
632
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
614
633
|
* owners need not specify this parameter in their requests. If either the source or
|
|
615
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
616
|
-
*
|
|
617
|
-
*
|
|
634
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
635
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
636
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
618
637
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
619
638
|
* <note>
|
|
620
639
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -628,8 +647,11 @@ export interface CompleteMultipartUploadRequest {
|
|
|
628
647
|
*/
|
|
629
648
|
ExpectedBucketOwner?: string | undefined;
|
|
630
649
|
/**
|
|
631
|
-
* <p>Uploads the object only if the object key name does not already exist in the bucket
|
|
632
|
-
*
|
|
650
|
+
* <p>Uploads the object only if the object key name does not already exist in the bucket
|
|
651
|
+
* specified. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
|
|
652
|
+
* <p>If a conflicting operation occurs during the upload S3 returns a <code>409
|
|
653
|
+
* ConditionalRequestConflict</code> response. On a 409 failure you should re-initiate the
|
|
654
|
+
* multipart upload with <code>CreateMultipartUpload</code> and re-upload each part.</p>
|
|
633
655
|
* <p>Expects the '*' (asterisk) character.</p>
|
|
634
656
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>, or <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Conditional requests</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
635
657
|
* @public
|
|
@@ -637,9 +659,9 @@ export interface CompleteMultipartUploadRequest {
|
|
|
637
659
|
IfNoneMatch?: string | undefined;
|
|
638
660
|
/**
|
|
639
661
|
* <p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is
|
|
640
|
-
* required only when the object was created using a checksum algorithm or if
|
|
641
|
-
*
|
|
642
|
-
*
|
|
662
|
+
* required only when the object was created using a checksum algorithm or if your bucket
|
|
663
|
+
* policy requires the use of SSE-C. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html#ssec-require-condition-key">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User
|
|
664
|
+
* Guide</i>.</p>
|
|
643
665
|
* <note>
|
|
644
666
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
645
667
|
* </note>
|
|
@@ -748,8 +770,8 @@ export interface CopyObjectOutput {
|
|
|
748
770
|
*/
|
|
749
771
|
VersionId?: string | undefined;
|
|
750
772
|
/**
|
|
751
|
-
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
752
|
-
*
|
|
773
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
774
|
+
* example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
|
|
753
775
|
* @public
|
|
754
776
|
*/
|
|
755
777
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
@@ -764,8 +786,8 @@ export interface CopyObjectOutput {
|
|
|
764
786
|
SSECustomerAlgorithm?: string | undefined;
|
|
765
787
|
/**
|
|
766
788
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
767
|
-
* response will include this header to provide the round-trip message integrity verification
|
|
768
|
-
* the customer-provided encryption key.</p>
|
|
789
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
790
|
+
* of the customer-provided encryption key.</p>
|
|
769
791
|
* <note>
|
|
770
792
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
771
793
|
* </note>
|
|
@@ -906,25 +928,23 @@ export type TaggingDirective = (typeof TaggingDirective)[keyof typeof TaggingDir
|
|
|
906
928
|
export interface CopyObjectRequest {
|
|
907
929
|
/**
|
|
908
930
|
* <p>The canned access control list (ACL) to apply to the object.</p>
|
|
909
|
-
* <p>When you copy an object, the ACL metadata is not preserved and is set
|
|
910
|
-
*
|
|
911
|
-
*
|
|
912
|
-
*
|
|
913
|
-
* ACLs</a>. </p>
|
|
931
|
+
* <p>When you copy an object, the ACL metadata is not preserved and is set to
|
|
932
|
+
* <code>private</code> by default. Only the owner has full access control. To override the
|
|
933
|
+
* default ACL setting, specify a new ACL when you generate a copy request. For more
|
|
934
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. </p>
|
|
914
935
|
* <p>If the destination bucket that you're copying objects to uses the bucket owner enforced
|
|
915
|
-
* setting for S3 Object Ownership, ACLs are disabled and no longer affect
|
|
916
|
-
*
|
|
917
|
-
*
|
|
918
|
-
*
|
|
919
|
-
*
|
|
920
|
-
*
|
|
921
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
936
|
+
* setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions.
|
|
937
|
+
* Buckets that use this setting only accept <code>PUT</code> requests that don't specify an
|
|
938
|
+
* ACL or <code>PUT</code> requests that specify bucket owner full control ACLs, such as the
|
|
939
|
+
* <code>bucket-owner-full-control</code> canned ACL or an equivalent form of this ACL
|
|
940
|
+
* expressed in the XML format. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of
|
|
941
|
+
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
922
942
|
* <note>
|
|
923
943
|
* <ul>
|
|
924
944
|
* <li>
|
|
925
|
-
* <p>If your destination bucket uses the bucket owner enforced setting for Object
|
|
926
|
-
* all objects written to the bucket by any account will be owned by the
|
|
927
|
-
* owner.</p>
|
|
945
|
+
* <p>If your destination bucket uses the bucket owner enforced setting for Object
|
|
946
|
+
* Ownership, all objects written to the bucket by any account will be owned by the
|
|
947
|
+
* bucket owner.</p>
|
|
928
948
|
* </li>
|
|
929
949
|
* <li>
|
|
930
950
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -940,7 +960,8 @@ export interface CopyObjectRequest {
|
|
|
940
960
|
/**
|
|
941
961
|
* <p>The name of the destination bucket.</p>
|
|
942
962
|
* <p>
|
|
943
|
-
* <b>Directory buckets</b> -
|
|
963
|
+
* <b>Directory buckets</b> -
|
|
964
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
944
965
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
945
966
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
946
967
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -968,10 +989,13 @@ export interface CopyObjectRequest {
|
|
|
968
989
|
* <p>Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see
|
|
969
990
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
|
|
970
991
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
971
|
-
* <p>When you copy an object, if the source object has a checksum, that checksum value will
|
|
972
|
-
* the new object by default. If the <code>CopyObject</code> request does not
|
|
973
|
-
*
|
|
974
|
-
*
|
|
992
|
+
* <p>When you copy an object, if the source object has a checksum, that checksum value will
|
|
993
|
+
* be copied to the new object by default. If the <code>CopyObject</code> request does not
|
|
994
|
+
* include this <code>x-amz-checksum-algorithm</code> header, the checksum algorithm will be
|
|
995
|
+
* copied from the source object to the destination object (if it's present on the source
|
|
996
|
+
* object). You can optionally specify a different checksum algorithm to use with the
|
|
997
|
+
* <code>x-amz-checksum-algorithm</code> header. Unrecognized or unsupported values will
|
|
998
|
+
* respond with the HTTP status code <code>400 Bad Request</code>.</p>
|
|
975
999
|
* <note>
|
|
976
1000
|
* <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>
|
|
977
1001
|
* </note>
|
|
@@ -979,7 +1003,9 @@ export interface CopyObjectRequest {
|
|
|
979
1003
|
*/
|
|
980
1004
|
ChecksumAlgorithm?: ChecksumAlgorithm | undefined;
|
|
981
1005
|
/**
|
|
982
|
-
* <p>Specifies presentational information for the object. Indicates whether an object should
|
|
1006
|
+
* <p>Specifies presentational information for the object. Indicates whether an object should
|
|
1007
|
+
* be displayed in a web browser or downloaded as a file. It allows specifying the desired
|
|
1008
|
+
* filename for the downloaded file.</p>
|
|
983
1009
|
* @public
|
|
984
1010
|
*/
|
|
985
1011
|
ContentDisposition?: string | undefined;
|
|
@@ -1004,20 +1030,23 @@ export interface CopyObjectRequest {
|
|
|
1004
1030
|
*/
|
|
1005
1031
|
ContentType?: string | undefined;
|
|
1006
1032
|
/**
|
|
1007
|
-
* <p>Specifies the source object for the copy operation. The source object
|
|
1008
|
-
*
|
|
1009
|
-
*
|
|
1010
|
-
*
|
|
1033
|
+
* <p>Specifies the source object for the copy operation. The source object can be up to 5 GB.
|
|
1034
|
+
* If the source object is an object that was uploaded by using a multipart upload, the object
|
|
1035
|
+
* copy will be a single part object after the source object is copied to the destination
|
|
1036
|
+
* bucket.</p>
|
|
1037
|
+
* <p>You specify the value of the copy source in one of two formats, depending on whether you
|
|
1038
|
+
* want to access the source object through an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">access point</a>:</p>
|
|
1011
1039
|
* <ul>
|
|
1012
1040
|
* <li>
|
|
1013
1041
|
* <p>For objects not accessed through an access point, specify the name of the source bucket
|
|
1014
1042
|
* and the key of the source object, separated by a slash (/). For example, to copy the
|
|
1015
1043
|
* object <code>reports/january.pdf</code> from the general purpose bucket
|
|
1016
|
-
*
|
|
1017
|
-
*
|
|
1018
|
-
* object <code>reports/january.pdf</code> from the directory bucket
|
|
1019
|
-
*
|
|
1020
|
-
*
|
|
1044
|
+
* <code>awsexamplebucket</code>, use
|
|
1045
|
+
* <code>awsexamplebucket/reports/january.pdf</code>. The value must be URL-encoded.
|
|
1046
|
+
* To copy the object <code>reports/january.pdf</code> from the directory bucket
|
|
1047
|
+
* <code>awsexamplebucket--use1-az5--x-s3</code>, use
|
|
1048
|
+
* <code>awsexamplebucket--use1-az5--x-s3/reports/january.pdf</code>. The value must
|
|
1049
|
+
* be URL-encoded.</p>
|
|
1021
1050
|
* </li>
|
|
1022
1051
|
* <li>
|
|
1023
1052
|
* <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p>
|
|
@@ -1034,24 +1063,25 @@ export interface CopyObjectRequest {
|
|
|
1034
1063
|
* <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL-encoded. </p>
|
|
1035
1064
|
* </li>
|
|
1036
1065
|
* </ul>
|
|
1037
|
-
* <p>If your source bucket versioning is enabled, the <code>x-amz-copy-source</code> header
|
|
1038
|
-
* version of an object to copy. If the current version is a
|
|
1039
|
-
* behaves as if the object was deleted. To copy a different version, use
|
|
1040
|
-
* <code>versionId</code> query parameter. Specifically, append
|
|
1041
|
-
*
|
|
1042
|
-
*
|
|
1066
|
+
* <p>If your source bucket versioning is enabled, the <code>x-amz-copy-source</code> header
|
|
1067
|
+
* by default identifies the current version of an object to copy. If the current version is a
|
|
1068
|
+
* delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use
|
|
1069
|
+
* the <code>versionId</code> query parameter. Specifically, append
|
|
1070
|
+
* <code>?versionId=<version-id></code> to the value (for example,
|
|
1071
|
+
* <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>).
|
|
1043
1072
|
* If you don't specify a version ID, Amazon S3 copies the latest version of the source
|
|
1044
1073
|
* object.</p>
|
|
1045
|
-
* <p>If you enable versioning on the destination bucket, Amazon S3 generates a unique version
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1048
|
-
*
|
|
1049
|
-
* <p>If you do not enable versioning or suspend it on the destination bucket, the version
|
|
1050
|
-
*
|
|
1051
|
-
*
|
|
1074
|
+
* <p>If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID
|
|
1075
|
+
* for the copied object. This version ID is different from the version ID of the source
|
|
1076
|
+
* object. Amazon S3 returns the version ID of the copied object in the
|
|
1077
|
+
* <code>x-amz-version-id</code> response header in the response.</p>
|
|
1078
|
+
* <p>If you do not enable versioning or suspend it on the destination bucket, the version ID
|
|
1079
|
+
* that Amazon S3 generates in the <code>x-amz-version-id</code> response header is always
|
|
1080
|
+
* null.</p>
|
|
1052
1081
|
* <note>
|
|
1053
1082
|
* <p>
|
|
1054
|
-
* <b>Directory buckets</b> -
|
|
1083
|
+
* <b>Directory buckets</b> -
|
|
1084
|
+
* S3 Versioning isn't enabled and supported for directory buckets.</p>
|
|
1055
1085
|
* </note>
|
|
1056
1086
|
* @public
|
|
1057
1087
|
*/
|
|
@@ -1059,14 +1089,12 @@ export interface CopyObjectRequest {
|
|
|
1059
1089
|
/**
|
|
1060
1090
|
* <p>Copies the object if its entity tag (ETag) matches the specified tag.</p>
|
|
1061
1091
|
* <p> If both the <code>x-amz-copy-source-if-match</code> and
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
* data:</p>
|
|
1092
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request
|
|
1093
|
+
* and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the data:</p>
|
|
1065
1094
|
* <ul>
|
|
1066
1095
|
* <li>
|
|
1067
1096
|
* <p>
|
|
1068
|
-
* <code>x-amz-copy-source-if-match</code> condition evaluates to
|
|
1069
|
-
* true</p>
|
|
1097
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to true</p>
|
|
1070
1098
|
* </li>
|
|
1071
1099
|
* <li>
|
|
1072
1100
|
* <p>
|
|
@@ -1080,14 +1108,13 @@ export interface CopyObjectRequest {
|
|
|
1080
1108
|
/**
|
|
1081
1109
|
* <p>Copies the object if it has been modified since the specified time.</p>
|
|
1082
1110
|
* <p>If both the <code>x-amz-copy-source-if-none-match</code> and
|
|
1083
|
-
*
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
1111
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and
|
|
1112
|
+
* evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response
|
|
1113
|
+
* code:</p>
|
|
1086
1114
|
* <ul>
|
|
1087
1115
|
* <li>
|
|
1088
1116
|
* <p>
|
|
1089
|
-
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
1090
|
-
* false</p>
|
|
1117
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p>
|
|
1091
1118
|
* </li>
|
|
1092
1119
|
* <li>
|
|
1093
1120
|
* <p>
|
|
@@ -1101,14 +1128,13 @@ export interface CopyObjectRequest {
|
|
|
1101
1128
|
/**
|
|
1102
1129
|
* <p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>
|
|
1103
1130
|
* <p>If both the <code>x-amz-copy-source-if-none-match</code> and
|
|
1104
|
-
*
|
|
1105
|
-
*
|
|
1106
|
-
*
|
|
1131
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and
|
|
1132
|
+
* evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response
|
|
1133
|
+
* code:</p>
|
|
1107
1134
|
* <ul>
|
|
1108
1135
|
* <li>
|
|
1109
1136
|
* <p>
|
|
1110
|
-
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
1111
|
-
* false</p>
|
|
1137
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to false</p>
|
|
1112
1138
|
* </li>
|
|
1113
1139
|
* <li>
|
|
1114
1140
|
* <p>
|
|
@@ -1122,14 +1148,12 @@ export interface CopyObjectRequest {
|
|
|
1122
1148
|
/**
|
|
1123
1149
|
* <p>Copies the object if it hasn't been modified since the specified time.</p>
|
|
1124
1150
|
* <p> If both the <code>x-amz-copy-source-if-match</code> and
|
|
1125
|
-
*
|
|
1126
|
-
*
|
|
1127
|
-
* data:</p>
|
|
1151
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request
|
|
1152
|
+
* and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the data:</p>
|
|
1128
1153
|
* <ul>
|
|
1129
1154
|
* <li>
|
|
1130
1155
|
* <p>
|
|
1131
|
-
* <code>x-amz-copy-source-if-match</code> condition evaluates to
|
|
1132
|
-
* true</p>
|
|
1156
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to true</p>
|
|
1133
1157
|
* </li>
|
|
1134
1158
|
* <li>
|
|
1135
1159
|
* <p>
|
|
@@ -1217,20 +1241,21 @@ export interface CopyObjectRequest {
|
|
|
1217
1241
|
Metadata?: Record<string, string> | undefined;
|
|
1218
1242
|
/**
|
|
1219
1243
|
* <p>Specifies whether the metadata is copied from the source object or replaced with
|
|
1220
|
-
* metadata that's provided in the request.
|
|
1221
|
-
*
|
|
1222
|
-
*
|
|
1223
|
-
* </p>
|
|
1244
|
+
* metadata that's provided in the request. When copying an object, you can preserve all
|
|
1245
|
+
* metadata (the default) or specify new metadata. If this header isn’t specified,
|
|
1246
|
+
* <code>COPY</code> is the default behavior. </p>
|
|
1224
1247
|
* <p>
|
|
1225
|
-
* <b>General purpose bucket</b> - For general purpose buckets, when you
|
|
1226
|
-
* can use the <code>s3:x-amz-metadata-directive</code> condition key
|
|
1227
|
-
* certain metadata behavior when objects are uploaded. For more information, see
|
|
1228
|
-
*
|
|
1248
|
+
* <b>General purpose bucket</b> - For general purpose buckets, when you
|
|
1249
|
+
* grant permissions, you can use the <code>s3:x-amz-metadata-directive</code> condition key
|
|
1250
|
+
* to enforce certain metadata behavior when objects are uploaded. For more information, see
|
|
1251
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Amazon S3
|
|
1252
|
+
* condition key examples</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1229
1253
|
* <note>
|
|
1230
1254
|
* <p>
|
|
1231
|
-
* <code>x-amz-website-redirect-location</code> is unique to each object and is not
|
|
1232
|
-
* <code>x-amz-metadata-directive</code> header. To copy the value,
|
|
1233
|
-
* must specify <code>x-amz-website-redirect-location</code> in the request
|
|
1255
|
+
* <code>x-amz-website-redirect-location</code> is unique to each object and is not
|
|
1256
|
+
* copied when using the <code>x-amz-metadata-directive</code> header. To copy the value,
|
|
1257
|
+
* you must specify <code>x-amz-website-redirect-location</code> in the request
|
|
1258
|
+
* header.</p>
|
|
1234
1259
|
* </note>
|
|
1235
1260
|
* @public
|
|
1236
1261
|
*/
|
|
@@ -1274,37 +1299,36 @@ export interface CopyObjectRequest {
|
|
|
1274
1299
|
*/
|
|
1275
1300
|
TaggingDirective?: TaggingDirective | undefined;
|
|
1276
1301
|
/**
|
|
1277
|
-
* <p>The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized
|
|
1278
|
-
*
|
|
1279
|
-
*
|
|
1280
|
-
*
|
|
1281
|
-
*
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1284
|
-
* configuration
|
|
1285
|
-
*
|
|
1286
|
-
* object copy.</p>
|
|
1287
|
-
* <p>With server-side
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1291
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
1302
|
+
* <p>The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized
|
|
1303
|
+
* or unsupported values won’t write a destination object and will receive a <code>400 Bad
|
|
1304
|
+
* Request</code> response. </p>
|
|
1305
|
+
* <p>Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When
|
|
1306
|
+
* copying an object, if you don't specify encryption information in your copy request, the
|
|
1307
|
+
* encryption setting of the target object is set to the default encryption configuration of
|
|
1308
|
+
* the destination bucket. By default, all buckets have a base level of encryption
|
|
1309
|
+
* configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
|
|
1310
|
+
* destination bucket has a different default encryption configuration, Amazon S3 uses the
|
|
1311
|
+
* corresponding encryption key to encrypt the target object copy.</p>
|
|
1312
|
+
* <p>With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in
|
|
1313
|
+
* its data centers and decrypts the data when you access it. For more information about
|
|
1314
|
+
* server-side encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using Server-Side Encryption</a>
|
|
1315
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
1292
1316
|
* <p>
|
|
1293
1317
|
* <b>General purpose buckets </b>
|
|
1294
1318
|
* </p>
|
|
1295
1319
|
* <ul>
|
|
1296
1320
|
* <li>
|
|
1297
|
-
* <p>For general purpose buckets, there are the following supported options for server-side
|
|
1298
|
-
*
|
|
1299
|
-
*
|
|
1300
|
-
*
|
|
1301
|
-
*
|
|
1321
|
+
* <p>For general purpose buckets, there are the following supported options for server-side
|
|
1322
|
+
* encryption: server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
|
|
1323
|
+
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and server-side encryption
|
|
1324
|
+
* with customer-provided encryption keys (SSE-C). Amazon S3 uses the corresponding
|
|
1325
|
+
* KMS key, or a customer-provided key to encrypt the target object copy.</p>
|
|
1302
1326
|
* </li>
|
|
1303
1327
|
* <li>
|
|
1304
1328
|
* <p>When you perform a <code>CopyObject</code> operation, if you want to use a
|
|
1305
1329
|
* different type of encryption setting for the target object, you can specify
|
|
1306
|
-
* appropriate encryption-related headers to encrypt the target object with an Amazon S3
|
|
1307
|
-
* KMS key, or a customer-provided key. If the encryption setting in
|
|
1330
|
+
* appropriate encryption-related headers to encrypt the target object with an Amazon S3
|
|
1331
|
+
* managed key, a KMS key, or a customer-provided key. If the encryption setting in
|
|
1308
1332
|
* your request is different from the default encryption configuration of the
|
|
1309
1333
|
* destination bucket, the encryption setting in your request takes precedence. </p>
|
|
1310
1334
|
* </li>
|
|
@@ -1320,63 +1344,73 @@ export interface CopyObjectRequest {
|
|
|
1320
1344
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.</p>
|
|
1321
1345
|
* </li>
|
|
1322
1346
|
* <li>
|
|
1323
|
-
* <p>To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you
|
|
1324
|
-
*
|
|
1325
|
-
*
|
|
1326
|
-
*
|
|
1347
|
+
* <p>To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you
|
|
1348
|
+
* specify SSE-KMS as the directory bucket's default encryption configuration with
|
|
1349
|
+
* a KMS key (specifically, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>).
|
|
1350
|
+
* The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. Your SSE-KMS
|
|
1351
|
+
* configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per
|
|
1352
|
+
* directory bucket for the lifetime of the bucket. After you specify a customer managed key for
|
|
1353
|
+
* SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS
|
|
1354
|
+
* configuration. Then, when you perform a <code>CopyObject</code> operation and want to
|
|
1355
|
+
* specify server-side encryption settings for new object copies with SSE-KMS in the
|
|
1356
|
+
* encryption-related request headers, you must ensure the encryption key is the same
|
|
1357
|
+
* customer managed key that you specified for the directory bucket's default encryption
|
|
1358
|
+
* configuration.
|
|
1359
|
+
* </p>
|
|
1327
1360
|
* </li>
|
|
1328
1361
|
* </ul>
|
|
1329
1362
|
* @public
|
|
1330
1363
|
*/
|
|
1331
1364
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
1332
1365
|
/**
|
|
1333
|
-
* <p>If the <code>x-amz-storage-class</code> header is not used, the copied object will be
|
|
1334
|
-
* <code>STANDARD</code> Storage Class by default. The <code>STANDARD</code>
|
|
1335
|
-
* high availability. Depending on performance
|
|
1336
|
-
* Class.
|
|
1337
|
-
* </p>
|
|
1366
|
+
* <p>If the <code>x-amz-storage-class</code> header is not used, the copied object will be
|
|
1367
|
+
* stored in the <code>STANDARD</code> Storage Class by default. The <code>STANDARD</code>
|
|
1368
|
+
* storage class provides high durability and high availability. Depending on performance
|
|
1369
|
+
* needs, you can specify a different Storage Class. </p>
|
|
1338
1370
|
* <note>
|
|
1339
1371
|
* <ul>
|
|
1340
1372
|
* <li>
|
|
1341
1373
|
* <p>
|
|
1342
|
-
* <b>Directory buckets </b> -
|
|
1374
|
+
* <b>Directory buckets </b> -
|
|
1375
|
+
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
|
|
1343
1376
|
* Unsupported storage class values won't write a destination object and will respond with the HTTP status code <code>400 Bad Request</code>.</p>
|
|
1344
1377
|
* </li>
|
|
1345
1378
|
* <li>
|
|
1346
1379
|
* <p>
|
|
1347
|
-
* <b>Amazon S3 on Outposts </b> - S3 on Outposts only
|
|
1380
|
+
* <b>Amazon S3 on Outposts </b> - S3 on Outposts only
|
|
1381
|
+
* uses the <code>OUTPOSTS</code> Storage Class.</p>
|
|
1348
1382
|
* </li>
|
|
1349
1383
|
* </ul>
|
|
1350
1384
|
* </note>
|
|
1351
|
-
* <p>You can use the <code>CopyObject</code> action to change the storage class of
|
|
1352
|
-
*
|
|
1353
|
-
*
|
|
1354
|
-
*
|
|
1355
|
-
* <p>Before using an object as a source object for the copy operation, you must restore a
|
|
1385
|
+
* <p>You can use the <code>CopyObject</code> action to change the storage class of an object
|
|
1386
|
+
* that is already stored in Amazon S3 by using the <code>x-amz-storage-class</code> header. For
|
|
1387
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the
|
|
1388
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1389
|
+
* <p>Before using an object as a source object for the copy operation, you must restore a
|
|
1390
|
+
* copy of it if it meets any of the following conditions:</p>
|
|
1356
1391
|
* <ul>
|
|
1357
1392
|
* <li>
|
|
1358
1393
|
* <p>The storage class of the source object is <code>GLACIER</code> or
|
|
1359
|
-
*
|
|
1394
|
+
* <code>DEEP_ARCHIVE</code>.</p>
|
|
1360
1395
|
* </li>
|
|
1361
1396
|
* <li>
|
|
1362
|
-
* <p>The storage class of the source object is
|
|
1363
|
-
*
|
|
1364
|
-
*
|
|
1397
|
+
* <p>The storage class of the source object is <code>INTELLIGENT_TIERING</code> and
|
|
1398
|
+
* it's <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition">S3 Intelligent-Tiering access tier</a> is <code>Archive Access</code> or
|
|
1399
|
+
* <code>Deep Archive Access</code>.</p>
|
|
1365
1400
|
* </li>
|
|
1366
1401
|
* </ul>
|
|
1367
|
-
* <p>For more
|
|
1368
|
-
*
|
|
1369
|
-
* Objects</a> in
|
|
1370
|
-
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1402
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying
|
|
1403
|
+
* Objects</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1371
1404
|
* @public
|
|
1372
1405
|
*/
|
|
1373
1406
|
StorageClass?: StorageClass | undefined;
|
|
1374
1407
|
/**
|
|
1375
|
-
* <p>If the destination bucket is configured as a website, redirects requests for this object
|
|
1376
|
-
* object in the same bucket or to an external URL. Amazon S3 stores the value of
|
|
1377
|
-
* the object metadata. This value is unique to each object and is not copied
|
|
1378
|
-
*
|
|
1379
|
-
* header in combination with the <code>x-amz-metadata-directive</code>
|
|
1408
|
+
* <p>If the destination bucket is configured as a website, redirects requests for this object
|
|
1409
|
+
* copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of
|
|
1410
|
+
* this header in the object metadata. This value is unique to each object and is not copied
|
|
1411
|
+
* when using the <code>x-amz-metadata-directive</code> header. Instead, you may opt to
|
|
1412
|
+
* provide this header in combination with the <code>x-amz-metadata-directive</code>
|
|
1413
|
+
* header.</p>
|
|
1380
1414
|
* <note>
|
|
1381
1415
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1382
1416
|
* </note>
|
|
@@ -1385,13 +1419,13 @@ export interface CopyObjectRequest {
|
|
|
1385
1419
|
WebsiteRedirectLocation?: string | undefined;
|
|
1386
1420
|
/**
|
|
1387
1421
|
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
1388
|
-
*
|
|
1389
|
-
* <p>When you perform a <code>CopyObject</code> operation, if you want to use a
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1392
|
-
* KMS key, or a customer-provided key. If the encryption setting in
|
|
1393
|
-
*
|
|
1394
|
-
*
|
|
1422
|
+
* <code>AES256</code>).</p>
|
|
1423
|
+
* <p>When you perform a <code>CopyObject</code> operation, if you want to use a different
|
|
1424
|
+
* type of encryption setting for the target object, you can specify appropriate
|
|
1425
|
+
* encryption-related headers to encrypt the target object with an Amazon S3 managed key, a
|
|
1426
|
+
* KMS key, or a customer-provided key. If the encryption setting in your request is
|
|
1427
|
+
* different from the default encryption configuration of the destination bucket, the
|
|
1428
|
+
* encryption setting in your request takes precedence. </p>
|
|
1395
1429
|
* <note>
|
|
1396
1430
|
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
1397
1431
|
* </note>
|
|
@@ -1420,14 +1454,15 @@ export interface CopyObjectRequest {
|
|
|
1420
1454
|
*/
|
|
1421
1455
|
SSECustomerKeyMD5?: string | undefined;
|
|
1422
1456
|
/**
|
|
1423
|
-
* <p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption.
|
|
1424
|
-
* object protected by KMS will fail if they're not made via
|
|
1425
|
-
* information about configuring any of the officially supported Amazon Web Services
|
|
1426
|
-
*
|
|
1457
|
+
* <p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption.
|
|
1458
|
+
* All GET and PUT requests for an object protected by KMS will fail if they're not made via
|
|
1459
|
+
* SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services
|
|
1460
|
+
* SDKs and Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the
|
|
1427
1461
|
* Signature Version in Request Authentication</a> in the
|
|
1428
1462
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
1429
1463
|
* <p>
|
|
1430
|
-
* <b>Directory buckets</b> -
|
|
1464
|
+
* <b>Directory buckets</b> -
|
|
1465
|
+
* If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code>, the <code>
|
|
1431
1466
|
* x-amz-server-side-encryption-aws-kms-key-id</code> header is implicitly assigned the ID of the KMS
|
|
1432
1467
|
* symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting.
|
|
1433
1468
|
* If you want to specify the <code>
|
|
@@ -1439,12 +1474,16 @@ export interface CopyObjectRequest {
|
|
|
1439
1474
|
*/
|
|
1440
1475
|
SSEKMSKeyId?: string | undefined;
|
|
1441
1476
|
/**
|
|
1442
|
-
* <p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use
|
|
1443
|
-
* this header is a base64-encoded UTF-8
|
|
1444
|
-
* key-value pairs.</p>
|
|
1477
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use
|
|
1478
|
+
* for the destination object encryption. The value of this header is a base64-encoded UTF-8
|
|
1479
|
+
* string holding JSON with the encryption context key-value pairs.</p>
|
|
1445
1480
|
* <p>
|
|
1446
|
-
* <b>General purpose buckets</b> - This value must be explicitly
|
|
1447
|
-
*
|
|
1481
|
+
* <b>General purpose buckets</b> - This value must be explicitly
|
|
1482
|
+
* added to specify encryption context for <code>CopyObject</code> requests if you want an
|
|
1483
|
+
* additional encryption context for your destination object. The additional encryption
|
|
1484
|
+
* context of the source object won't be copied to the destination object. For more
|
|
1485
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context">Encryption
|
|
1486
|
+
* context</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1448
1487
|
* <p>
|
|
1449
1488
|
* <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>
|
|
1450
1489
|
* @public
|
|
@@ -1452,17 +1491,17 @@ export interface CopyObjectRequest {
|
|
|
1452
1491
|
SSEKMSEncryptionContext?: string | undefined;
|
|
1453
1492
|
/**
|
|
1454
1493
|
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
1455
|
-
* server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses
|
|
1456
|
-
* object.</p>
|
|
1457
|
-
* <p>Setting this header to
|
|
1458
|
-
*
|
|
1459
|
-
*
|
|
1460
|
-
* Bucket Key.</p>
|
|
1494
|
+
* server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses
|
|
1495
|
+
* SSE-KMS, you can enable an S3 Bucket Key for the object.</p>
|
|
1496
|
+
* <p>Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object
|
|
1497
|
+
* encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect
|
|
1498
|
+
* bucket-level settings for S3 Bucket Key.</p>
|
|
1461
1499
|
* <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
|
|
1462
|
-
*
|
|
1500
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1463
1501
|
* <note>
|
|
1464
1502
|
* <p>
|
|
1465
|
-
* <b>Directory buckets</b> -
|
|
1503
|
+
* <b>Directory buckets</b> -
|
|
1504
|
+
* S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
|
|
1466
1505
|
* to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p>
|
|
1467
1506
|
* </note>
|
|
1468
1507
|
* @public
|
|
@@ -1470,11 +1509,10 @@ export interface CopyObjectRequest {
|
|
|
1470
1509
|
BucketKeyEnabled?: boolean | undefined;
|
|
1471
1510
|
/**
|
|
1472
1511
|
* <p>Specifies the algorithm to use when decrypting the source object (for example,
|
|
1473
|
-
*
|
|
1474
|
-
* <p>If
|
|
1475
|
-
*
|
|
1476
|
-
*
|
|
1477
|
-
* object for copying.</p>
|
|
1512
|
+
* <code>AES256</code>).</p>
|
|
1513
|
+
* <p>If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the
|
|
1514
|
+
* necessary encryption information in your request so that Amazon S3 can decrypt the object for
|
|
1515
|
+
* copying.</p>
|
|
1478
1516
|
* <note>
|
|
1479
1517
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
1480
1518
|
* </note>
|
|
@@ -1483,12 +1521,11 @@ export interface CopyObjectRequest {
|
|
|
1483
1521
|
CopySourceSSECustomerAlgorithm?: string | undefined;
|
|
1484
1522
|
/**
|
|
1485
1523
|
* <p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source
|
|
1486
|
-
* object. The encryption key provided in this header must be the same one that was used when
|
|
1487
|
-
* source object was created.</p>
|
|
1488
|
-
* <p>If
|
|
1489
|
-
*
|
|
1490
|
-
*
|
|
1491
|
-
* object for copying.</p>
|
|
1524
|
+
* object. The encryption key provided in this header must be the same one that was used when
|
|
1525
|
+
* the source object was created.</p>
|
|
1526
|
+
* <p>If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the
|
|
1527
|
+
* necessary encryption information in your request so that Amazon S3 can decrypt the object for
|
|
1528
|
+
* copying.</p>
|
|
1492
1529
|
* <note>
|
|
1493
1530
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
1494
1531
|
* </note>
|
|
@@ -1499,10 +1536,9 @@ export interface CopyObjectRequest {
|
|
|
1499
1536
|
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
1500
1537
|
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
1501
1538
|
* without error.</p>
|
|
1502
|
-
* <p>If
|
|
1503
|
-
*
|
|
1504
|
-
*
|
|
1505
|
-
* object for copying.</p>
|
|
1539
|
+
* <p>If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the
|
|
1540
|
+
* necessary encryption information in your request so that Amazon S3 can decrypt the object for
|
|
1541
|
+
* copying.</p>
|
|
1506
1542
|
* <note>
|
|
1507
1543
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
1508
1544
|
* </note>
|
|
@@ -1512,9 +1548,9 @@ export interface CopyObjectRequest {
|
|
|
1512
1548
|
/**
|
|
1513
1549
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1514
1550
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1515
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1516
|
-
*
|
|
1517
|
-
*
|
|
1551
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1552
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1553
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1518
1554
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1519
1555
|
* <note>
|
|
1520
1556
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -1523,10 +1559,12 @@ export interface CopyObjectRequest {
|
|
|
1523
1559
|
*/
|
|
1524
1560
|
RequestPayer?: RequestPayer | undefined;
|
|
1525
1561
|
/**
|
|
1526
|
-
* <p>The tag-set for the object copy in the destination bucket. This value must be used in
|
|
1527
|
-
* with the <code>x-amz-tagging-directive</code> if you choose
|
|
1528
|
-
*
|
|
1529
|
-
*
|
|
1562
|
+
* <p>The tag-set for the object copy in the destination bucket. This value must be used in
|
|
1563
|
+
* conjunction with the <code>x-amz-tagging-directive</code> if you choose
|
|
1564
|
+
* <code>REPLACE</code> for the <code>x-amz-tagging-directive</code>. If you choose
|
|
1565
|
+
* <code>COPY</code> for the <code>x-amz-tagging-directive</code>, you don't need to set
|
|
1566
|
+
* the <code>x-amz-tagging</code> header, because the tag-set will be copied from the source
|
|
1567
|
+
* object directly. The tag-set must be encoded as URL Query parameters.</p>
|
|
1530
1568
|
* <p>The default value is the empty value.</p>
|
|
1531
1569
|
* <note>
|
|
1532
1570
|
* <p>
|
|
@@ -1685,8 +1723,8 @@ export declare const BucketType: {
|
|
|
1685
1723
|
*/
|
|
1686
1724
|
export type BucketType = (typeof BucketType)[keyof typeof BucketType];
|
|
1687
1725
|
/**
|
|
1688
|
-
* <p>Specifies the information about the bucket that will be created. For more information
|
|
1689
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1726
|
+
* <p>Specifies the information about the bucket that will be created. For more information
|
|
1727
|
+
* about directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1690
1728
|
* <note>
|
|
1691
1729
|
* <p>This functionality is only supported by directory buckets.</p>
|
|
1692
1730
|
* </note>
|
|
@@ -1717,8 +1755,8 @@ export declare const LocationType: {
|
|
|
1717
1755
|
export type LocationType = (typeof LocationType)[keyof typeof LocationType];
|
|
1718
1756
|
/**
|
|
1719
1757
|
* <p>Specifies the location where the bucket will be created.</p>
|
|
1720
|
-
* <p>For directory buckets, the location type is Availability Zone. For more information about
|
|
1721
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1758
|
+
* <p>For directory buckets, the location type is Availability Zone. For more information about
|
|
1759
|
+
* directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1722
1760
|
* <note>
|
|
1723
1761
|
* <p>This functionality is only supported by directory buckets.</p>
|
|
1724
1762
|
* </note>
|
|
@@ -1732,7 +1770,8 @@ export interface LocationInfo {
|
|
|
1732
1770
|
Type?: LocationType | undefined;
|
|
1733
1771
|
/**
|
|
1734
1772
|
* <p>The name of the location where the bucket will be created.</p>
|
|
1735
|
-
* <p>For directory buckets, the name of the location is the AZ ID of the Availability Zone where the
|
|
1773
|
+
* <p>For directory buckets, the name of the location is the AZ ID of the Availability Zone where the
|
|
1774
|
+
* bucket will be created. An example AZ ID value is <code>usw2-az1</code>.</p>
|
|
1736
1775
|
* @public
|
|
1737
1776
|
*/
|
|
1738
1777
|
Name?: string | undefined;
|
|
@@ -1786,8 +1825,8 @@ export interface CreateBucketConfiguration {
|
|
|
1786
1825
|
* reside in Europe, you will probably find it advantageous to create buckets in the Europe
|
|
1787
1826
|
* (Ireland) Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a
|
|
1788
1827
|
* bucket</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1789
|
-
* <p>If you don't specify a Region,
|
|
1790
|
-
*
|
|
1828
|
+
* <p>If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region
|
|
1829
|
+
* (us-east-1) by default.</p>
|
|
1791
1830
|
* <note>
|
|
1792
1831
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1793
1832
|
* </note>
|
|
@@ -1911,22 +1950,25 @@ export interface CreateBucketRequest {
|
|
|
1911
1950
|
/**
|
|
1912
1951
|
* <p>The container element for object ownership for a bucket's ownership controls.</p>
|
|
1913
1952
|
* <p>
|
|
1914
|
-
* <code>BucketOwnerPreferred</code> - Objects uploaded to the bucket change ownership to
|
|
1915
|
-
* owner if the objects are uploaded with the
|
|
1916
|
-
*
|
|
1953
|
+
* <code>BucketOwnerPreferred</code> - Objects uploaded to the bucket change ownership to
|
|
1954
|
+
* the bucket owner if the objects are uploaded with the
|
|
1955
|
+
* <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
1917
1956
|
* <p>
|
|
1918
|
-
* <code>ObjectWriter</code> - The uploading account will own the object if the object is
|
|
1919
|
-
* the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
1957
|
+
* <code>ObjectWriter</code> - The uploading account will own the object if the object is
|
|
1958
|
+
* uploaded with the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
1920
1959
|
* <p>
|
|
1921
|
-
* <code>BucketOwnerEnforced</code> - Access control lists (ACLs) are disabled and no
|
|
1922
|
-
* permissions. The bucket owner automatically owns and has full control over
|
|
1923
|
-
* the bucket. The bucket only accepts PUT requests that don't specify an ACL
|
|
1924
|
-
* full control ACLs (such as the predefined
|
|
1925
|
-
*
|
|
1926
|
-
*
|
|
1927
|
-
*
|
|
1928
|
-
*
|
|
1929
|
-
*
|
|
1960
|
+
* <code>BucketOwnerEnforced</code> - Access control lists (ACLs) are disabled and no
|
|
1961
|
+
* longer affect permissions. The bucket owner automatically owns and has full control over
|
|
1962
|
+
* every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL
|
|
1963
|
+
* or specify bucket owner full control ACLs (such as the predefined
|
|
1964
|
+
* <code>bucket-owner-full-control</code> canned ACL or a custom ACL in XML format that
|
|
1965
|
+
* grants the same permissions).</p>
|
|
1966
|
+
* <p>By default, <code>ObjectOwnership</code> is set to <code>BucketOwnerEnforced</code> and
|
|
1967
|
+
* ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where
|
|
1968
|
+
* you must control access for each object individually. For more information about S3 Object
|
|
1969
|
+
* Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of
|
|
1970
|
+
* objects and disabling ACLs for your bucket</a> in the
|
|
1971
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
1930
1972
|
* <note>
|
|
1931
1973
|
* <p>This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.</p>
|
|
1932
1974
|
* </note>
|
|
@@ -1943,8 +1985,8 @@ export interface CreateMultipartUploadOutput {
|
|
|
1943
1985
|
* multipart uploads and the prefix in the lifecycle rule matches the object name in the
|
|
1944
1986
|
* request, the response includes this header. The header indicates when the initiated
|
|
1945
1987
|
* 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">
|
|
1946
|
-
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
|
1947
|
-
*
|
|
1988
|
+
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a> in
|
|
1989
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
1948
1990
|
* <p>The response also includes the <code>x-amz-abort-rule-id</code> header that provides the
|
|
1949
1991
|
* ID of the lifecycle configuration rule that defines the abort action.</p>
|
|
1950
1992
|
* <note>
|
|
@@ -1983,8 +2025,8 @@ export interface CreateMultipartUploadOutput {
|
|
|
1983
2025
|
*/
|
|
1984
2026
|
UploadId?: string | undefined;
|
|
1985
2027
|
/**
|
|
1986
|
-
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
1987
|
-
*
|
|
2028
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2029
|
+
* example, <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
1988
2030
|
* @public
|
|
1989
2031
|
*/
|
|
1990
2032
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
@@ -1999,8 +2041,8 @@ export interface CreateMultipartUploadOutput {
|
|
|
1999
2041
|
SSECustomerAlgorithm?: string | undefined;
|
|
2000
2042
|
/**
|
|
2001
2043
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
2002
|
-
* response will include this header to provide the round-trip message integrity verification
|
|
2003
|
-
* the customer-provided encryption key.</p>
|
|
2044
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
2045
|
+
* of the customer-provided encryption key.</p>
|
|
2004
2046
|
* <note>
|
|
2005
2047
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2006
2048
|
* </note>
|
|
@@ -2044,17 +2086,16 @@ export interface CreateMultipartUploadOutput {
|
|
|
2044
2086
|
*/
|
|
2045
2087
|
export interface CreateMultipartUploadRequest {
|
|
2046
2088
|
/**
|
|
2047
|
-
* <p>The canned ACL to apply to the object. Amazon S3 supports a set of
|
|
2048
|
-
*
|
|
2049
|
-
*
|
|
2050
|
-
*
|
|
2051
|
-
*
|
|
2052
|
-
*
|
|
2053
|
-
*
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2056
|
-
*
|
|
2057
|
-
* grant the permissions using the request headers is to specify a canned ACL with the <code>x-amz-acl</code> request header.</p>
|
|
2089
|
+
* <p>The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as
|
|
2090
|
+
* <i>canned ACLs</i>. Each canned ACL has a predefined set of grantees and
|
|
2091
|
+
* permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a> in the
|
|
2092
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
2093
|
+
* <p>By default, all objects are private. Only the owner has full access control. When
|
|
2094
|
+
* uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to
|
|
2095
|
+
* predefined groups defined by Amazon S3. These permissions are then added to the access control
|
|
2096
|
+
* list (ACL) on the new object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. One way to grant
|
|
2097
|
+
* the permissions using the request headers is to specify a canned ACL with the
|
|
2098
|
+
* <code>x-amz-acl</code> request header.</p>
|
|
2058
2099
|
* <note>
|
|
2059
2100
|
* <ul>
|
|
2060
2101
|
* <li>
|
|
@@ -2069,9 +2110,11 @@ export interface CreateMultipartUploadRequest {
|
|
|
2069
2110
|
*/
|
|
2070
2111
|
ACL?: ObjectCannedACL | undefined;
|
|
2071
2112
|
/**
|
|
2072
|
-
* <p>The name of the bucket where the multipart upload is initiated and where the object is
|
|
2113
|
+
* <p>The name of the bucket where the multipart upload is initiated and where the object is
|
|
2114
|
+
* uploaded.</p>
|
|
2073
2115
|
* <p>
|
|
2074
|
-
* <b>Directory buckets</b> -
|
|
2116
|
+
* <b>Directory buckets</b> -
|
|
2117
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
2075
2118
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
2076
2119
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
2077
2120
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -2126,30 +2169,29 @@ export interface CreateMultipartUploadRequest {
|
|
|
2126
2169
|
*/
|
|
2127
2170
|
Expires?: Date | undefined;
|
|
2128
2171
|
/**
|
|
2129
|
-
* <p>Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP
|
|
2130
|
-
*
|
|
2131
|
-
*
|
|
2132
|
-
*
|
|
2133
|
-
* This header maps to specific permissions that Amazon S3
|
|
2134
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
2135
|
-
*
|
|
2136
|
-
* <p>You specify each grantee as a type=value pair, where the type is one of
|
|
2137
|
-
*
|
|
2172
|
+
* <p>Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP
|
|
2173
|
+
* permissions on the object.</p>
|
|
2174
|
+
* <p>By default, all objects are private. Only the owner has full access control. When
|
|
2175
|
+
* uploading an object, you can use this header to explicitly grant access permissions to
|
|
2176
|
+
* specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3
|
|
2177
|
+
* supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
|
|
2178
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
2179
|
+
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
2180
|
+
* following:</p>
|
|
2138
2181
|
* <ul>
|
|
2139
2182
|
* <li>
|
|
2140
2183
|
* <p>
|
|
2141
|
-
* <code>id</code> – if the value specified is the canonical user ID
|
|
2142
|
-
*
|
|
2184
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
2185
|
+
* Amazon Web Services account</p>
|
|
2143
2186
|
* </li>
|
|
2144
2187
|
* <li>
|
|
2145
2188
|
* <p>
|
|
2146
|
-
* <code>uri</code> – if you are granting permissions to a predefined
|
|
2147
|
-
* group</p>
|
|
2189
|
+
* <code>uri</code> – if you are granting permissions to a predefined group</p>
|
|
2148
2190
|
* </li>
|
|
2149
2191
|
* <li>
|
|
2150
2192
|
* <p>
|
|
2151
|
-
* <code>emailAddress</code> – if the value specified is the email
|
|
2152
|
-
*
|
|
2193
|
+
* <code>emailAddress</code> – if the value specified is the email address of an
|
|
2194
|
+
* Amazon Web Services account</p>
|
|
2153
2195
|
* <note>
|
|
2154
2196
|
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
2155
2197
|
* <ul>
|
|
@@ -2200,30 +2242,29 @@ export interface CreateMultipartUploadRequest {
|
|
|
2200
2242
|
*/
|
|
2201
2243
|
GrantFullControl?: string | undefined;
|
|
2202
2244
|
/**
|
|
2203
|
-
* <p>Specify access permissions explicitly to allow grantee to read the object data and its
|
|
2204
|
-
*
|
|
2205
|
-
*
|
|
2206
|
-
*
|
|
2207
|
-
* This header maps to specific permissions that Amazon S3
|
|
2208
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
2209
|
-
*
|
|
2210
|
-
* <p>You specify each grantee as a type=value pair, where the type is one of
|
|
2211
|
-
*
|
|
2245
|
+
* <p>Specify access permissions explicitly to allow grantee to read the object data and its
|
|
2246
|
+
* metadata.</p>
|
|
2247
|
+
* <p>By default, all objects are private. Only the owner has full access control. When
|
|
2248
|
+
* uploading an object, you can use this header to explicitly grant access permissions to
|
|
2249
|
+
* specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3
|
|
2250
|
+
* supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
|
|
2251
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
2252
|
+
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
2253
|
+
* following:</p>
|
|
2212
2254
|
* <ul>
|
|
2213
2255
|
* <li>
|
|
2214
2256
|
* <p>
|
|
2215
|
-
* <code>id</code> – if the value specified is the canonical user ID
|
|
2216
|
-
*
|
|
2257
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
2258
|
+
* Amazon Web Services account</p>
|
|
2217
2259
|
* </li>
|
|
2218
2260
|
* <li>
|
|
2219
2261
|
* <p>
|
|
2220
|
-
* <code>uri</code> – if you are granting permissions to a predefined
|
|
2221
|
-
* group</p>
|
|
2262
|
+
* <code>uri</code> – if you are granting permissions to a predefined group</p>
|
|
2222
2263
|
* </li>
|
|
2223
2264
|
* <li>
|
|
2224
2265
|
* <p>
|
|
2225
|
-
* <code>emailAddress</code> – if the value specified is the email
|
|
2226
|
-
*
|
|
2266
|
+
* <code>emailAddress</code> – if the value specified is the email address of an
|
|
2267
|
+
* Amazon Web Services account</p>
|
|
2227
2268
|
* <note>
|
|
2228
2269
|
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
2229
2270
|
* <ul>
|
|
@@ -2275,29 +2316,27 @@ export interface CreateMultipartUploadRequest {
|
|
|
2275
2316
|
GrantRead?: string | undefined;
|
|
2276
2317
|
/**
|
|
2277
2318
|
* <p>Specify access permissions explicitly to allows grantee to read the object ACL.</p>
|
|
2278
|
-
* <p>By default, all objects are private. Only the owner has full access
|
|
2279
|
-
*
|
|
2280
|
-
*
|
|
2281
|
-
*
|
|
2282
|
-
*
|
|
2283
|
-
*
|
|
2284
|
-
*
|
|
2285
|
-
* the following:</p>
|
|
2319
|
+
* <p>By default, all objects are private. Only the owner has full access control. When
|
|
2320
|
+
* uploading an object, you can use this header to explicitly grant access permissions to
|
|
2321
|
+
* specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3
|
|
2322
|
+
* supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
|
|
2323
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
2324
|
+
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
2325
|
+
* following:</p>
|
|
2286
2326
|
* <ul>
|
|
2287
2327
|
* <li>
|
|
2288
2328
|
* <p>
|
|
2289
|
-
* <code>id</code> – if the value specified is the canonical user ID
|
|
2290
|
-
*
|
|
2329
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
2330
|
+
* Amazon Web Services account</p>
|
|
2291
2331
|
* </li>
|
|
2292
2332
|
* <li>
|
|
2293
2333
|
* <p>
|
|
2294
|
-
* <code>uri</code> – if you are granting permissions to a predefined
|
|
2295
|
-
* group</p>
|
|
2334
|
+
* <code>uri</code> – if you are granting permissions to a predefined group</p>
|
|
2296
2335
|
* </li>
|
|
2297
2336
|
* <li>
|
|
2298
2337
|
* <p>
|
|
2299
|
-
* <code>emailAddress</code> – if the value specified is the email
|
|
2300
|
-
*
|
|
2338
|
+
* <code>emailAddress</code> – if the value specified is the email address of an
|
|
2339
|
+
* Amazon Web Services account</p>
|
|
2301
2340
|
* <note>
|
|
2302
2341
|
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
2303
2342
|
* <ul>
|
|
@@ -2348,30 +2387,29 @@ export interface CreateMultipartUploadRequest {
|
|
|
2348
2387
|
*/
|
|
2349
2388
|
GrantReadACP?: string | undefined;
|
|
2350
2389
|
/**
|
|
2351
|
-
* <p>Specify access permissions explicitly to allows grantee to allow grantee to write the
|
|
2352
|
-
*
|
|
2353
|
-
*
|
|
2354
|
-
*
|
|
2355
|
-
* This header maps to specific permissions that Amazon S3
|
|
2356
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
2357
|
-
*
|
|
2358
|
-
* <p>You specify each grantee as a type=value pair, where the type is one of
|
|
2359
|
-
*
|
|
2390
|
+
* <p>Specify access permissions explicitly to allows grantee to allow grantee to write the
|
|
2391
|
+
* ACL for the applicable object.</p>
|
|
2392
|
+
* <p>By default, all objects are private. Only the owner has full access control. When
|
|
2393
|
+
* uploading an object, you can use this header to explicitly grant access permissions to
|
|
2394
|
+
* specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3
|
|
2395
|
+
* supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) Overview</a>
|
|
2396
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
2397
|
+
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
2398
|
+
* following:</p>
|
|
2360
2399
|
* <ul>
|
|
2361
2400
|
* <li>
|
|
2362
2401
|
* <p>
|
|
2363
|
-
* <code>id</code> – if the value specified is the canonical user ID
|
|
2364
|
-
*
|
|
2402
|
+
* <code>id</code> – if the value specified is the canonical user ID of an
|
|
2403
|
+
* Amazon Web Services account</p>
|
|
2365
2404
|
* </li>
|
|
2366
2405
|
* <li>
|
|
2367
2406
|
* <p>
|
|
2368
|
-
* <code>uri</code> – if you are granting permissions to a predefined
|
|
2369
|
-
* group</p>
|
|
2407
|
+
* <code>uri</code> – if you are granting permissions to a predefined group</p>
|
|
2370
2408
|
* </li>
|
|
2371
2409
|
* <li>
|
|
2372
2410
|
* <p>
|
|
2373
|
-
* <code>emailAddress</code> – if the value specified is the email
|
|
2374
|
-
*
|
|
2411
|
+
* <code>emailAddress</code> – if the value specified is the email address of an
|
|
2412
|
+
* Amazon Web Services account</p>
|
|
2375
2413
|
* <note>
|
|
2376
2414
|
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
|
2377
2415
|
* <ul>
|
|
@@ -2432,16 +2470,16 @@ export interface CreateMultipartUploadRequest {
|
|
|
2432
2470
|
*/
|
|
2433
2471
|
Metadata?: Record<string, string> | undefined;
|
|
2434
2472
|
/**
|
|
2435
|
-
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2436
|
-
*
|
|
2473
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2474
|
+
* example, <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
2437
2475
|
* <ul>
|
|
2438
2476
|
* <li>
|
|
2439
2477
|
* <p>
|
|
2440
|
-
* <b>Directory buckets </b> -
|
|
2478
|
+
* <b>Directory buckets </b> -
|
|
2479
|
+
* For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
|
|
2441
2480
|
* <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
|
|
2442
2481
|
* are automatically encrypted with the desired encryption settings. For more
|
|
2443
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>.
|
|
2444
|
-
* </p>
|
|
2482
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html">Specifying server-side encryption with KMS for new object uploads</a>. </p>
|
|
2445
2483
|
* <p>In the Zonal endpoint API calls (except <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request.
|
|
2446
2484
|
* You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request.
|
|
2447
2485
|
* You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and
|
|
@@ -2463,16 +2501,17 @@ export interface CreateMultipartUploadRequest {
|
|
|
2463
2501
|
/**
|
|
2464
2502
|
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The
|
|
2465
2503
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
2466
|
-
* performance needs, you can specify a different Storage Class. For more information, see
|
|
2467
|
-
* <
|
|
2504
|
+
* performance needs, you can specify a different Storage Class. For more information, see
|
|
2505
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
2506
|
+
* Classes</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2468
2507
|
* <note>
|
|
2469
2508
|
* <ul>
|
|
2470
2509
|
* <li>
|
|
2471
|
-
* <p>For directory buckets, only the S3 Express One Zone storage class is supported to store
|
|
2510
|
+
* <p>For directory buckets, only the S3 Express One Zone storage class is supported to store
|
|
2511
|
+
* newly created objects.</p>
|
|
2472
2512
|
* </li>
|
|
2473
2513
|
* <li>
|
|
2474
|
-
* <p>Amazon S3 on Outposts only uses
|
|
2475
|
-
* the OUTPOSTS Storage Class.</p>
|
|
2514
|
+
* <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p>
|
|
2476
2515
|
* </li>
|
|
2477
2516
|
* </ul>
|
|
2478
2517
|
* </note>
|
|
@@ -2490,8 +2529,7 @@ export interface CreateMultipartUploadRequest {
|
|
|
2490
2529
|
*/
|
|
2491
2530
|
WebsiteRedirectLocation?: string | undefined;
|
|
2492
2531
|
/**
|
|
2493
|
-
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
2494
|
-
* AES256).</p>
|
|
2532
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>
|
|
2495
2533
|
* <note>
|
|
2496
2534
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2497
2535
|
* </note>
|
|
@@ -2510,9 +2548,9 @@ export interface CreateMultipartUploadRequest {
|
|
|
2510
2548
|
*/
|
|
2511
2549
|
SSECustomerKey?: string | undefined;
|
|
2512
2550
|
/**
|
|
2513
|
-
* <p>Specifies the 128-bit MD5 digest of the customer-provided encryption key according to
|
|
2514
|
-
* this header for a message integrity check to ensure that the encryption
|
|
2515
|
-
* without error.</p>
|
|
2551
|
+
* <p>Specifies the 128-bit MD5 digest of the customer-provided encryption key according to
|
|
2552
|
+
* RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption
|
|
2553
|
+
* key was transmitted without error.</p>
|
|
2516
2554
|
* <note>
|
|
2517
2555
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2518
2556
|
* </note>
|
|
@@ -2566,9 +2604,9 @@ export interface CreateMultipartUploadRequest {
|
|
|
2566
2604
|
/**
|
|
2567
2605
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
2568
2606
|
* owners need not specify this parameter in their requests. If either the source or
|
|
2569
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
2570
|
-
*
|
|
2571
|
-
*
|
|
2607
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
2608
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
2609
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
2572
2610
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2573
2611
|
* <note>
|
|
2574
2612
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -2625,31 +2663,40 @@ export interface CreateMultipartUploadRequest {
|
|
|
2625
2663
|
* <p>The established temporary security credentials of the session.</p>
|
|
2626
2664
|
* <note>
|
|
2627
2665
|
* <p>
|
|
2628
|
-
* <b>Directory buckets</b> - These session
|
|
2666
|
+
* <b>Directory buckets</b> - These session
|
|
2667
|
+
* credentials are only supported for the authentication and authorization of Zonal endpoint API operations
|
|
2668
|
+
* on directory buckets.</p>
|
|
2629
2669
|
* </note>
|
|
2630
2670
|
* @public
|
|
2631
2671
|
*/
|
|
2632
2672
|
export interface SessionCredentials {
|
|
2633
2673
|
/**
|
|
2634
|
-
* <p>A unique identifier that's associated with a secret access key. The access key ID and
|
|
2674
|
+
* <p>A unique identifier that's associated with a secret access key. The access key ID and
|
|
2675
|
+
* the secret access key are used together to sign programmatic Amazon Web Services requests
|
|
2676
|
+
* cryptographically. </p>
|
|
2635
2677
|
* @public
|
|
2636
2678
|
*/
|
|
2637
2679
|
AccessKeyId: string | undefined;
|
|
2638
2680
|
/**
|
|
2639
|
-
* <p>A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services
|
|
2681
|
+
* <p>A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services
|
|
2682
|
+
* requests. Signing a request identifies the sender and prevents the request from being
|
|
2683
|
+
* altered. </p>
|
|
2640
2684
|
* @public
|
|
2641
2685
|
*/
|
|
2642
2686
|
SecretAccessKey: string | undefined;
|
|
2643
2687
|
/**
|
|
2644
|
-
* <p>A part of the temporary security credentials. The session token is used to validate the
|
|
2688
|
+
* <p>A part of the temporary security credentials. The session token is used to validate the
|
|
2689
|
+
* temporary security credentials.
|
|
2645
2690
|
*
|
|
2646
2691
|
* </p>
|
|
2647
2692
|
* @public
|
|
2648
2693
|
*/
|
|
2649
2694
|
SessionToken: string | undefined;
|
|
2650
2695
|
/**
|
|
2651
|
-
* <p>Temporary security credentials expire after a specified interval. After temporary
|
|
2652
|
-
*
|
|
2696
|
+
* <p>Temporary security credentials expire after a specified interval. After temporary
|
|
2697
|
+
* credentials expire, any calls that you make with those credentials will fail. So you must
|
|
2698
|
+
* generate a new set of temporary credentials. Temporary credentials cannot be extended or
|
|
2699
|
+
* refreshed beyond the original specified interval.</p>
|
|
2653
2700
|
* @public
|
|
2654
2701
|
*/
|
|
2655
2702
|
Expiration: Date | undefined;
|
|
@@ -2922,6 +2969,10 @@ export interface DeleteBucketLifecycleRequest {
|
|
|
2922
2969
|
Bucket: string | undefined;
|
|
2923
2970
|
/**
|
|
2924
2971
|
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
2972
|
+
* <note>
|
|
2973
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
2974
|
+
* directory bucket lifecycle configurations.</p>
|
|
2975
|
+
* </note>
|
|
2925
2976
|
* @public
|
|
2926
2977
|
*/
|
|
2927
2978
|
ExpectedBucketOwner?: string | undefined;
|
|
@@ -3049,9 +3100,10 @@ export interface DeleteBucketWebsiteRequest {
|
|
|
3049
3100
|
*/
|
|
3050
3101
|
export interface DeleteObjectOutput {
|
|
3051
3102
|
/**
|
|
3052
|
-
* <p>Indicates whether the specified object version that was permanently deleted was (true)
|
|
3053
|
-
* not (false) a delete marker before deletion. In a simple DELETE, this header
|
|
3054
|
-
* not (false) the current version of the object is a delete
|
|
3103
|
+
* <p>Indicates whether the specified object version that was permanently deleted was (true)
|
|
3104
|
+
* or was not (false) a delete marker before deletion. In a simple DELETE, this header
|
|
3105
|
+
* indicates whether (true) or not (false) the current version of the object is a delete
|
|
3106
|
+
* marker.</p>
|
|
3055
3107
|
* <note>
|
|
3056
3108
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3057
3109
|
* </note>
|
|
@@ -3084,7 +3136,8 @@ export interface DeleteObjectRequest {
|
|
|
3084
3136
|
/**
|
|
3085
3137
|
* <p>The bucket name of the bucket containing the object. </p>
|
|
3086
3138
|
* <p>
|
|
3087
|
-
* <b>Directory buckets</b> -
|
|
3139
|
+
* <b>Directory buckets</b> -
|
|
3140
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
3088
3141
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
3089
3142
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
3090
3143
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -3129,9 +3182,9 @@ export interface DeleteObjectRequest {
|
|
|
3129
3182
|
/**
|
|
3130
3183
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
3131
3184
|
* owners need not specify this parameter in their requests. If either the source or
|
|
3132
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
3133
|
-
*
|
|
3134
|
-
*
|
|
3185
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
3186
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
3187
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
3135
3188
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3136
3189
|
* <note>
|
|
3137
3190
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -3154,6 +3207,42 @@ export interface DeleteObjectRequest {
|
|
|
3154
3207
|
* @public
|
|
3155
3208
|
*/
|
|
3156
3209
|
ExpectedBucketOwner?: string | undefined;
|
|
3210
|
+
/**
|
|
3211
|
+
* <p>The <code>If-Match</code> header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns
|
|
3212
|
+
* a <code>412 Precondition Failed</code> error. If the ETag matches or if the object doesn't exist, the operation will return a <code>204 Success (No
|
|
3213
|
+
* Content) response</code>.</p>
|
|
3214
|
+
* <p>For more information about conditional requests, see <a href="https://docs.aws.amazon.com/https:/tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
3215
|
+
* <note>
|
|
3216
|
+
* <p>This functionality is only supported for directory buckets.</p>
|
|
3217
|
+
* </note>
|
|
3218
|
+
* @public
|
|
3219
|
+
*/
|
|
3220
|
+
IfMatch?: string | undefined;
|
|
3221
|
+
/**
|
|
3222
|
+
* <p>If present, the object is deleted only if its modification times matches the provided
|
|
3223
|
+
* <code>Timestamp</code>. If the <code>Timestamp</code> values do not match, the operation
|
|
3224
|
+
* returns a <code>412 Precondition Failed</code> error. If the <code>Timestamp</code> matches
|
|
3225
|
+
* or if the object doesn’t exist, the operation returns a <code>204 Success (No
|
|
3226
|
+
* Content)</code> response.</p>
|
|
3227
|
+
* <note>
|
|
3228
|
+
* <p>This functionality is only supported for directory buckets.</p>
|
|
3229
|
+
* </note>
|
|
3230
|
+
* @public
|
|
3231
|
+
*/
|
|
3232
|
+
IfMatchLastModifiedTime?: Date | undefined;
|
|
3233
|
+
/**
|
|
3234
|
+
* <p>If present, the object is deleted only if its size matches the provided size in bytes. If the <code>Size</code> value does not match, the operation returns a <code>412 Precondition Failed</code> error. If the <code>Size</code> matches or if the object doesn’t exist,
|
|
3235
|
+
* the operation returns a <code>204 Success (No Content)</code> response.</p>
|
|
3236
|
+
* <note>
|
|
3237
|
+
* <p>This functionality is only supported for directory buckets.</p>
|
|
3238
|
+
* </note>
|
|
3239
|
+
* <important>
|
|
3240
|
+
* <p>You can use the <code>If-Match</code>, <code>x-amz-if-match-last-modified-time</code> and <code>x-amz-if-match-size</code>
|
|
3241
|
+
* conditional headers in conjunction with each-other or individually.</p>
|
|
3242
|
+
* </important>
|
|
3243
|
+
* @public
|
|
3244
|
+
*/
|
|
3245
|
+
IfMatchSize?: number | undefined;
|
|
3157
3246
|
}
|
|
3158
3247
|
/**
|
|
3159
3248
|
* <p>Information about the deleted object.</p>
|
|
@@ -3174,9 +3263,10 @@ export interface DeletedObject {
|
|
|
3174
3263
|
*/
|
|
3175
3264
|
VersionId?: string | undefined;
|
|
3176
3265
|
/**
|
|
3177
|
-
* <p>Indicates whether the specified object version that was permanently deleted was (true)
|
|
3178
|
-
* not (false) a delete marker before deletion. In a simple DELETE, this header
|
|
3179
|
-
* not (false) the current version of the object is a delete
|
|
3266
|
+
* <p>Indicates whether the specified object version that was permanently deleted was (true)
|
|
3267
|
+
* or was not (false) a delete marker before deletion. In a simple DELETE, this header
|
|
3268
|
+
* indicates whether (true) or not (false) the current version of the object is a delete
|
|
3269
|
+
* marker.</p>
|
|
3180
3270
|
* <note>
|
|
3181
3271
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
3182
3272
|
* </note>
|
|
@@ -5139,6 +5229,32 @@ export interface ObjectIdentifier {
|
|
|
5139
5229
|
* @public
|
|
5140
5230
|
*/
|
|
5141
5231
|
VersionId?: string | undefined;
|
|
5232
|
+
/**
|
|
5233
|
+
* <p>An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL.
|
|
5234
|
+
* This header field makes the request method conditional on <code>ETags</code>. </p>
|
|
5235
|
+
* <note>
|
|
5236
|
+
* <p>Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object. </p>
|
|
5237
|
+
* </note>
|
|
5238
|
+
* @public
|
|
5239
|
+
*/
|
|
5240
|
+
ETag?: string | undefined;
|
|
5241
|
+
/**
|
|
5242
|
+
* <p>If present, the objects are deleted only if its modification times matches the provided <code>Timestamp</code>.
|
|
5243
|
+
* </p>
|
|
5244
|
+
* <note>
|
|
5245
|
+
* <p>This functionality is only supported for directory buckets.</p>
|
|
5246
|
+
* </note>
|
|
5247
|
+
* @public
|
|
5248
|
+
*/
|
|
5249
|
+
LastModifiedTime?: Date | undefined;
|
|
5250
|
+
/**
|
|
5251
|
+
* <p>If present, the objects are deleted only if its size matches the provided size in bytes. </p>
|
|
5252
|
+
* <note>
|
|
5253
|
+
* <p>This functionality is only supported for directory buckets.</p>
|
|
5254
|
+
* </note>
|
|
5255
|
+
* @public
|
|
5256
|
+
*/
|
|
5257
|
+
Size?: number | undefined;
|
|
5142
5258
|
}
|
|
5143
5259
|
/**
|
|
5144
5260
|
* <p>Container for the objects to delete.</p>
|
|
@@ -5149,9 +5265,10 @@ export interface Delete {
|
|
|
5149
5265
|
* <p>The object to delete.</p>
|
|
5150
5266
|
* <note>
|
|
5151
5267
|
* <p>
|
|
5152
|
-
* <b>Directory buckets</b> - For directory buckets,
|
|
5153
|
-
*
|
|
5154
|
-
*
|
|
5268
|
+
* <b>Directory buckets</b> - For directory buckets,
|
|
5269
|
+
* an object that's composed entirely of whitespace characters is not supported by the
|
|
5270
|
+
* <code>DeleteObjects</code> API operation. The request will receive a <code>400 Bad
|
|
5271
|
+
* Request</code> error and none of the objects in the request will be deleted.</p>
|
|
5155
5272
|
* </note>
|
|
5156
5273
|
* @public
|
|
5157
5274
|
*/
|
|
@@ -5170,7 +5287,8 @@ export interface DeleteObjectsRequest {
|
|
|
5170
5287
|
/**
|
|
5171
5288
|
* <p>The bucket name containing the objects to delete. </p>
|
|
5172
5289
|
* <p>
|
|
5173
|
-
* <b>Directory buckets</b> -
|
|
5290
|
+
* <b>Directory buckets</b> -
|
|
5291
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
5174
5292
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
5175
5293
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
5176
5294
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -5198,11 +5316,12 @@ export interface DeleteObjectsRequest {
|
|
|
5198
5316
|
* <p>The concatenation of the authentication device's serial number, a space, and the value
|
|
5199
5317
|
* that is displayed on your authentication device. Required to permanently delete a versioned
|
|
5200
5318
|
* object if versioning is configured with MFA delete enabled.</p>
|
|
5201
|
-
* <p>When performing the <code>DeleteObjects</code> operation on an MFA delete enabled
|
|
5202
|
-
*
|
|
5203
|
-
*
|
|
5204
|
-
*
|
|
5205
|
-
*
|
|
5319
|
+
* <p>When performing the <code>DeleteObjects</code> operation on an MFA delete enabled
|
|
5320
|
+
* bucket, which attempts to delete the specified versioned objects, you must include an MFA
|
|
5321
|
+
* token. If you don't provide an MFA token, the entire request will fail, even if there are
|
|
5322
|
+
* non-versioned objects that you are trying to delete. If you provide an invalid token,
|
|
5323
|
+
* whether there are versioned object keys in the request or not, the entire Multi-Object
|
|
5324
|
+
* Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA
|
|
5206
5325
|
* Delete</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5207
5326
|
* <note>
|
|
5208
5327
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -5213,9 +5332,9 @@ export interface DeleteObjectsRequest {
|
|
|
5213
5332
|
/**
|
|
5214
5333
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
5215
5334
|
* owners need not specify this parameter in their requests. If either the source or
|
|
5216
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
5217
|
-
*
|
|
5218
|
-
*
|
|
5335
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
5336
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
5337
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
5219
5338
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5220
5339
|
* <note>
|
|
5221
5340
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -5380,9 +5499,9 @@ export interface GetBucketAccelerateConfigurationRequest {
|
|
|
5380
5499
|
/**
|
|
5381
5500
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
5382
5501
|
* owners need not specify this parameter in their requests. If either the source or
|
|
5383
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
5384
|
-
*
|
|
5385
|
-
*
|
|
5502
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
5503
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
5504
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
5386
5505
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5387
5506
|
* <note>
|
|
5388
5507
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -5752,25 +5871,28 @@ export interface GetBucketCorsRequest {
|
|
|
5752
5871
|
/**
|
|
5753
5872
|
* <p>Describes the default server-side encryption to apply to new objects in the bucket. If a
|
|
5754
5873
|
* PUT Object request doesn't specify any server-side encryption, this default encryption will
|
|
5755
|
-
* be applied. For more
|
|
5756
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html">PutBucketEncryption</a>.</p>
|
|
5874
|
+
* be applied. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html">PutBucketEncryption</a>.</p>
|
|
5757
5875
|
* <note>
|
|
5758
5876
|
* <ul>
|
|
5759
5877
|
* <li>
|
|
5760
5878
|
* <p>
|
|
5761
|
-
* <b>General purpose buckets</b> - If you don't specify
|
|
5762
|
-
*
|
|
5763
|
-
*
|
|
5879
|
+
* <b>General purpose buckets</b> - If you don't specify
|
|
5880
|
+
* a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key
|
|
5881
|
+
* (<code>aws/s3</code>) in your Amazon Web Services account the first time that you add an
|
|
5882
|
+
* object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key
|
|
5883
|
+
* for SSE-KMS. </p>
|
|
5764
5884
|
* </li>
|
|
5765
5885
|
* <li>
|
|
5766
5886
|
* <p>
|
|
5767
|
-
* <b>Directory buckets</b> -
|
|
5887
|
+
* <b>Directory buckets</b> -
|
|
5888
|
+
* Your SSE-KMS configuration can only support 1 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> per directory bucket for the lifetime of the bucket.
|
|
5768
5889
|
* The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported.
|
|
5769
5890
|
* </p>
|
|
5770
5891
|
* </li>
|
|
5771
5892
|
* <li>
|
|
5772
5893
|
* <p>
|
|
5773
|
-
* <b>Directory buckets</b> -
|
|
5894
|
+
* <b>Directory buckets</b> -
|
|
5895
|
+
* For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.</p>
|
|
5774
5896
|
* </li>
|
|
5775
5897
|
* </ul>
|
|
5776
5898
|
* </note>
|
|
@@ -5792,12 +5914,14 @@ export interface ServerSideEncryptionByDefault {
|
|
|
5792
5914
|
* <ul>
|
|
5793
5915
|
* <li>
|
|
5794
5916
|
* <p>
|
|
5795
|
-
* <b>General purpose buckets</b> - This parameter is
|
|
5796
|
-
* <code>
|
|
5917
|
+
* <b>General purpose buckets</b> - This parameter is
|
|
5918
|
+
* allowed if and only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code> or
|
|
5919
|
+
* <code>aws:kms:dsse</code>.</p>
|
|
5797
5920
|
* </li>
|
|
5798
5921
|
* <li>
|
|
5799
5922
|
* <p>
|
|
5800
|
-
* <b>Directory buckets</b> - This parameter is
|
|
5923
|
+
* <b>Directory buckets</b> - This parameter is
|
|
5924
|
+
* allowed if and only if <code>SSEAlgorithm</code> is set to
|
|
5801
5925
|
* <code>aws:kms</code>.</p>
|
|
5802
5926
|
* </li>
|
|
5803
5927
|
* </ul>
|
|
@@ -5810,7 +5934,8 @@ export interface ServerSideEncryptionByDefault {
|
|
|
5810
5934
|
* </p>
|
|
5811
5935
|
* </li>
|
|
5812
5936
|
* <li>
|
|
5813
|
-
* <p>Key ARN:
|
|
5937
|
+
* <p>Key ARN:
|
|
5938
|
+
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
5814
5939
|
* </p>
|
|
5815
5940
|
* </li>
|
|
5816
5941
|
* <li>
|
|
@@ -5824,16 +5949,18 @@ export interface ServerSideEncryptionByDefault {
|
|
|
5824
5949
|
* <ul>
|
|
5825
5950
|
* <li>
|
|
5826
5951
|
* <p>
|
|
5827
|
-
* <b>General purpose buckets</b> - If you're specifying
|
|
5828
|
-
* KMS key
|
|
5829
|
-
*
|
|
5830
|
-
*
|
|
5831
|
-
*
|
|
5832
|
-
*
|
|
5952
|
+
* <b>General purpose buckets</b> - If you're specifying
|
|
5953
|
+
* a customer managed KMS key, we recommend using a fully qualified KMS key ARN.
|
|
5954
|
+
* If you use a KMS key alias instead, then KMS resolves the key within the
|
|
5955
|
+
* requester’s account. This behavior can result in data that's encrypted with a
|
|
5956
|
+
* KMS key that belongs to the requester, and not the bucket owner. Also, if you
|
|
5957
|
+
* use a key ID, you can run into a LogDestination undeliverable error when creating
|
|
5958
|
+
* a VPC flow log. </p>
|
|
5833
5959
|
* </li>
|
|
5834
5960
|
* <li>
|
|
5835
5961
|
* <p>
|
|
5836
|
-
* <b>Directory buckets</b> -
|
|
5962
|
+
* <b>Directory buckets</b> -
|
|
5963
|
+
* When you specify an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">KMS customer managed key</a> for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.</p>
|
|
5837
5964
|
* </li>
|
|
5838
5965
|
* </ul>
|
|
5839
5966
|
* </note>
|
|
@@ -5851,14 +5978,16 @@ export interface ServerSideEncryptionByDefault {
|
|
|
5851
5978
|
* <ul>
|
|
5852
5979
|
* <li>
|
|
5853
5980
|
* <p>
|
|
5854
|
-
* <b>General purpose buckets</b> - If you're specifying
|
|
5855
|
-
*
|
|
5856
|
-
*
|
|
5857
|
-
*
|
|
5981
|
+
* <b>General purpose buckets</b> - If you're specifying
|
|
5982
|
+
* a customer managed KMS key, we recommend using a fully qualified KMS key ARN.
|
|
5983
|
+
* If you use a KMS key alias instead, then KMS resolves the key within the
|
|
5984
|
+
* requester’s account. This behavior can result in data that's encrypted with a
|
|
5985
|
+
* KMS key that belongs to the requester, and not the bucket owner.</p>
|
|
5858
5986
|
* </li>
|
|
5859
5987
|
* <li>
|
|
5860
5988
|
* <p>
|
|
5861
|
-
* <b>Directory buckets</b> -
|
|
5989
|
+
* <b>Directory buckets</b> -
|
|
5990
|
+
* When you specify an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">KMS customer managed key</a> for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.</p>
|
|
5862
5991
|
* </li>
|
|
5863
5992
|
* </ul>
|
|
5864
5993
|
* </note>
|
|
@@ -5881,12 +6010,14 @@ export interface ServerSideEncryptionRule {
|
|
|
5881
6010
|
* <ul>
|
|
5882
6011
|
* <li>
|
|
5883
6012
|
* <p>
|
|
5884
|
-
* <b>General purpose buckets</b> - By default, S3
|
|
5885
|
-
*
|
|
6013
|
+
* <b>General purpose buckets</b> - By default, S3
|
|
6014
|
+
* Bucket Key is not enabled. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
6015
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
5886
6016
|
* </li>
|
|
5887
6017
|
* <li>
|
|
5888
6018
|
* <p>
|
|
5889
|
-
* <b>Directory buckets</b> -
|
|
6019
|
+
* <b>Directory buckets</b> -
|
|
6020
|
+
* S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
|
|
5890
6021
|
* to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a>, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops">the Copy operation in Batch Operations</a>, or
|
|
5891
6022
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p>
|
|
5892
6023
|
* </li>
|
|
@@ -6361,6 +6492,10 @@ export interface LifecycleExpiration {
|
|
|
6361
6492
|
/**
|
|
6362
6493
|
* <p>Indicates at what date the object is to be moved or deleted. The date value must conform
|
|
6363
6494
|
* to the ISO 8601 format. The time is always midnight UTC.</p>
|
|
6495
|
+
* <note>
|
|
6496
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6497
|
+
* directory bucket lifecycle configurations.</p>
|
|
6498
|
+
* </note>
|
|
6364
6499
|
* @public
|
|
6365
6500
|
*/
|
|
6366
6501
|
Date?: Date | undefined;
|
|
@@ -6374,6 +6509,10 @@ export interface LifecycleExpiration {
|
|
|
6374
6509
|
* <p>Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set
|
|
6375
6510
|
* to true, the delete marker will be expired; if set to false the policy takes no action.
|
|
6376
6511
|
* This cannot be specified with Days or Date in a Lifecycle Expiration Policy.</p>
|
|
6512
|
+
* <note>
|
|
6513
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6514
|
+
* directory bucket lifecycle configurations.</p>
|
|
6515
|
+
* </note>
|
|
6377
6516
|
* @public
|
|
6378
6517
|
*/
|
|
6379
6518
|
ExpiredObjectDeleteMarker?: boolean | undefined;
|
|
@@ -6409,8 +6548,10 @@ export interface LifecycleRuleAndOperator {
|
|
|
6409
6548
|
}
|
|
6410
6549
|
/**
|
|
6411
6550
|
* <p>The <code>Filter</code> is used to identify objects that a Lifecycle Rule applies to. A
|
|
6412
|
-
*
|
|
6413
|
-
*
|
|
6551
|
+
* <code>Filter</code> can have exactly one of <code>Prefix</code>, <code>Tag</code>,
|
|
6552
|
+
* <code>ObjectSizeGreaterThan</code>, <code>ObjectSizeLessThan</code>, or <code>And</code>
|
|
6553
|
+
* specified. If the <code>Filter</code> element is left empty, the Lifecycle Rule applies to
|
|
6554
|
+
* all objects in the bucket.</p>
|
|
6414
6555
|
* @public
|
|
6415
6556
|
*/
|
|
6416
6557
|
export interface LifecycleRuleFilter {
|
|
@@ -6426,6 +6567,10 @@ export interface LifecycleRuleFilter {
|
|
|
6426
6567
|
Prefix?: string | undefined;
|
|
6427
6568
|
/**
|
|
6428
6569
|
* <p>This tag must exist in the object's tag set in order for the rule to apply.</p>
|
|
6570
|
+
* <note>
|
|
6571
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6572
|
+
* directory bucket lifecycle configurations.</p>
|
|
6573
|
+
* </note>
|
|
6429
6574
|
* @public
|
|
6430
6575
|
*/
|
|
6431
6576
|
Tag?: Tag | undefined;
|
|
@@ -6452,6 +6597,10 @@ export interface LifecycleRuleFilter {
|
|
|
6452
6597
|
* deletes the noncurrent object versions. You set this lifecycle configuration action on a
|
|
6453
6598
|
* bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent
|
|
6454
6599
|
* object versions at a specific period in the object's lifetime.</p>
|
|
6600
|
+
* <note>
|
|
6601
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6602
|
+
* directory bucket lifecycle configurations.</p>
|
|
6603
|
+
* </note>
|
|
6455
6604
|
* @public
|
|
6456
6605
|
*/
|
|
6457
6606
|
export interface NoncurrentVersionExpiration {
|
|
@@ -6461,6 +6610,10 @@ export interface NoncurrentVersionExpiration {
|
|
|
6461
6610
|
* noncurrent days calculations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations">How
|
|
6462
6611
|
* Amazon S3 Calculates When an Object Became Noncurrent</a> in the
|
|
6463
6612
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
6613
|
+
* <note>
|
|
6614
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6615
|
+
* directory bucket lifecycle configurations.</p>
|
|
6616
|
+
* </note>
|
|
6464
6617
|
* @public
|
|
6465
6618
|
*/
|
|
6466
6619
|
NoncurrentDays?: number | undefined;
|
|
@@ -6470,6 +6623,10 @@ export interface NoncurrentVersionExpiration {
|
|
|
6470
6623
|
* versions beyond the specified number to retain. For more information about noncurrent
|
|
6471
6624
|
* versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration
|
|
6472
6625
|
* elements</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6626
|
+
* <note>
|
|
6627
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6628
|
+
* directory bucket lifecycle configurations.</p>
|
|
6629
|
+
* </note>
|
|
6473
6630
|
* @public
|
|
6474
6631
|
*/
|
|
6475
6632
|
NewerNoncurrentVersions?: number | undefined;
|
|
@@ -6598,6 +6755,10 @@ export interface LifecycleRule {
|
|
|
6598
6755
|
* <code>Filter</code> must have exactly one of <code>Prefix</code>, <code>Tag</code>, or
|
|
6599
6756
|
* <code>And</code> specified. <code>Filter</code> is required if the
|
|
6600
6757
|
* <code>LifecycleRule</code> does not contain a <code>Prefix</code> element.</p>
|
|
6758
|
+
* <note>
|
|
6759
|
+
* <p>
|
|
6760
|
+
* <code>Tag</code> filters are not supported for directory buckets.</p>
|
|
6761
|
+
* </note>
|
|
6601
6762
|
* @public
|
|
6602
6763
|
*/
|
|
6603
6764
|
Filter?: LifecycleRuleFilter | undefined;
|
|
@@ -6609,15 +6770,23 @@ export interface LifecycleRule {
|
|
|
6609
6770
|
Status: ExpirationStatus | undefined;
|
|
6610
6771
|
/**
|
|
6611
6772
|
* <p>Specifies when an Amazon S3 object transitions to a specified storage class.</p>
|
|
6773
|
+
* <note>
|
|
6774
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6775
|
+
* directory bucket lifecycle configurations.</p>
|
|
6776
|
+
* </note>
|
|
6612
6777
|
* @public
|
|
6613
6778
|
*/
|
|
6614
6779
|
Transitions?: Transition[] | undefined;
|
|
6615
6780
|
/**
|
|
6616
|
-
* <p>
|
|
6781
|
+
* <p>Specifies the transition rule for the lifecycle rule that describes when noncurrent
|
|
6617
6782
|
* objects transition to a specific storage class. If your bucket is versioning-enabled (or
|
|
6618
6783
|
* versioning is suspended), you can set this action to request that Amazon S3 transition
|
|
6619
6784
|
* noncurrent object versions to a specific storage class at a set period in the object's
|
|
6620
|
-
* lifetime
|
|
6785
|
+
* lifetime.</p>
|
|
6786
|
+
* <note>
|
|
6787
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6788
|
+
* directory bucket lifecycle configurations.</p>
|
|
6789
|
+
* </note>
|
|
6621
6790
|
* @public
|
|
6622
6791
|
*/
|
|
6623
6792
|
NoncurrentVersionTransitions?: NoncurrentVersionTransition[] | undefined;
|
|
@@ -6626,6 +6795,10 @@ export interface LifecycleRule {
|
|
|
6626
6795
|
* deletes the noncurrent object versions. You set this lifecycle configuration action on a
|
|
6627
6796
|
* bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent
|
|
6628
6797
|
* object versions at a specific period in the object's lifetime.</p>
|
|
6798
|
+
* <note>
|
|
6799
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6800
|
+
* directory bucket lifecycle configurations.</p>
|
|
6801
|
+
* </note>
|
|
6629
6802
|
* @public
|
|
6630
6803
|
*/
|
|
6631
6804
|
NoncurrentVersionExpiration?: NoncurrentVersionExpiration | undefined;
|
|
@@ -6660,19 +6833,30 @@ export interface GetBucketLifecycleConfigurationOutput {
|
|
|
6660
6833
|
*/
|
|
6661
6834
|
Rules?: LifecycleRule[] | undefined;
|
|
6662
6835
|
/**
|
|
6663
|
-
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
6836
|
+
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
6837
|
+
* configuration.</p>
|
|
6838
|
+
* <note>
|
|
6839
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6840
|
+
* directory bucket lifecycle configurations.</p>
|
|
6841
|
+
* </note>
|
|
6664
6842
|
* <ul>
|
|
6665
6843
|
* <li>
|
|
6666
6844
|
* <p>
|
|
6667
|
-
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
6845
|
+
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
6846
|
+
* transition to any storage class by default.</p>
|
|
6668
6847
|
* </li>
|
|
6669
6848
|
* <li>
|
|
6670
6849
|
* <p>
|
|
6671
|
-
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
6672
|
-
*
|
|
6850
|
+
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
6851
|
+
* transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
|
|
6852
|
+
* default, all other storage classes will prevent transitions smaller than 128 KB.
|
|
6853
|
+
* </p>
|
|
6673
6854
|
* </li>
|
|
6674
6855
|
* </ul>
|
|
6675
|
-
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
6856
|
+
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
6857
|
+
* specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in
|
|
6858
|
+
* the body of your transition rule. Custom filters always take precedence over the default
|
|
6859
|
+
* transition behavior.</p>
|
|
6676
6860
|
* @public
|
|
6677
6861
|
*/
|
|
6678
6862
|
TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
|
|
@@ -6690,6 +6874,10 @@ export interface GetBucketLifecycleConfigurationRequest {
|
|
|
6690
6874
|
Bucket: string | undefined;
|
|
6691
6875
|
/**
|
|
6692
6876
|
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
6877
|
+
* <note>
|
|
6878
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
6879
|
+
* directory bucket lifecycle configurations.</p>
|
|
6880
|
+
* </note>
|
|
6693
6881
|
* @public
|
|
6694
6882
|
*/
|
|
6695
6883
|
ExpectedBucketOwner?: string | undefined;
|
|
@@ -6777,14 +6965,15 @@ export type PartitionDateSource = (typeof PartitionDateSource)[keyof typeof Part
|
|
|
6777
6965
|
* <p>
|
|
6778
6966
|
* <code>[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]</code>
|
|
6779
6967
|
* </p>
|
|
6780
|
-
* <p>PartitionedPrefix defaults to EventTime delivery when server access logs are
|
|
6968
|
+
* <p>PartitionedPrefix defaults to EventTime delivery when server access logs are
|
|
6969
|
+
* delivered.</p>
|
|
6781
6970
|
* @public
|
|
6782
6971
|
*/
|
|
6783
6972
|
export interface PartitionedPrefix {
|
|
6784
6973
|
/**
|
|
6785
6974
|
* <p>Specifies the partition date source for the partitioned prefix.
|
|
6786
|
-
*
|
|
6787
|
-
*
|
|
6975
|
+
* <code>PartitionDateSource</code> can be <code>EventTime</code> or
|
|
6976
|
+
* <code>DeliveryTime</code>.</p>
|
|
6788
6977
|
* <p>For <code>DeliveryTime</code>, the time in the log file names corresponds to the
|
|
6789
6978
|
* delivery time for the log files. </p>
|
|
6790
6979
|
* <p> For <code>EventTime</code>, The logs delivered are for a specific day only. The year,
|
|
@@ -6795,7 +6984,8 @@ export interface PartitionedPrefix {
|
|
|
6795
6984
|
PartitionDateSource?: PartitionDateSource | undefined;
|
|
6796
6985
|
}
|
|
6797
6986
|
/**
|
|
6798
|
-
* <p>To use simple format for S3 keys for log objects, set SimplePrefix to an empty
|
|
6987
|
+
* <p>To use simple format for S3 keys for log objects, set SimplePrefix to an empty
|
|
6988
|
+
* object.</p>
|
|
6799
6989
|
* <p>
|
|
6800
6990
|
* <code>[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]</code>
|
|
6801
6991
|
* </p>
|
|
@@ -6804,12 +6994,14 @@ export interface PartitionedPrefix {
|
|
|
6804
6994
|
export interface SimplePrefix {
|
|
6805
6995
|
}
|
|
6806
6996
|
/**
|
|
6807
|
-
* <p>Amazon S3 key format for log objects. Only one format, PartitionedPrefix or
|
|
6997
|
+
* <p>Amazon S3 key format for log objects. Only one format, PartitionedPrefix or
|
|
6998
|
+
* SimplePrefix, is allowed.</p>
|
|
6808
6999
|
* @public
|
|
6809
7000
|
*/
|
|
6810
7001
|
export interface TargetObjectKeyFormat {
|
|
6811
7002
|
/**
|
|
6812
|
-
* <p>To use the simple format for S3 keys for log objects. To specify SimplePrefix format,
|
|
7003
|
+
* <p>To use the simple format for S3 keys for log objects. To specify SimplePrefix format,
|
|
7004
|
+
* set SimplePrefix to \{\}.</p>
|
|
6813
7005
|
* @public
|
|
6814
7006
|
*/
|
|
6815
7007
|
SimplePrefix?: SimplePrefix | undefined;
|
|
@@ -7118,7 +7310,14 @@ export declare const FilterRuleName: {
|
|
|
7118
7310
|
*/
|
|
7119
7311
|
export type FilterRuleName = (typeof FilterRuleName)[keyof typeof FilterRuleName];
|
|
7120
7312
|
/**
|
|
7121
|
-
* <p>Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned
|
|
7313
|
+
* <p>Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned
|
|
7314
|
+
* to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of
|
|
7315
|
+
* the object key name. A prefix is a specific string of characters at the beginning of an
|
|
7316
|
+
* object key name, which you can use to organize objects. For example, you can start the key
|
|
7317
|
+
* names of related objects with a prefix, such as <code>2023-</code> or
|
|
7318
|
+
* <code>engineering/</code>. Then, you can use <code>FilterRule</code> to find objects in
|
|
7319
|
+
* a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it
|
|
7320
|
+
* is at the end of the object key name instead of at the beginning.</p>
|
|
7122
7321
|
* @public
|
|
7123
7322
|
*/
|
|
7124
7323
|
export interface FilterRule {
|
|
@@ -7299,22 +7498,25 @@ export interface OwnershipControlsRule {
|
|
|
7299
7498
|
/**
|
|
7300
7499
|
* <p>The container element for object ownership for a bucket's ownership controls.</p>
|
|
7301
7500
|
* <p>
|
|
7302
|
-
* <code>BucketOwnerPreferred</code> - Objects uploaded to the bucket change ownership to
|
|
7303
|
-
* owner if the objects are uploaded with the
|
|
7304
|
-
*
|
|
7501
|
+
* <code>BucketOwnerPreferred</code> - Objects uploaded to the bucket change ownership to
|
|
7502
|
+
* the bucket owner if the objects are uploaded with the
|
|
7503
|
+
* <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
7305
7504
|
* <p>
|
|
7306
|
-
* <code>ObjectWriter</code> - The uploading account will own the object if the object is
|
|
7307
|
-
* the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
7505
|
+
* <code>ObjectWriter</code> - The uploading account will own the object if the object is
|
|
7506
|
+
* uploaded with the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
7308
7507
|
* <p>
|
|
7309
|
-
* <code>BucketOwnerEnforced</code> - Access control lists (ACLs) are disabled and no
|
|
7310
|
-
* permissions. The bucket owner automatically owns and has full control over
|
|
7311
|
-
* the bucket. The bucket only accepts PUT requests that don't specify an ACL
|
|
7312
|
-
* full control ACLs (such as the predefined
|
|
7313
|
-
*
|
|
7314
|
-
*
|
|
7315
|
-
*
|
|
7316
|
-
*
|
|
7317
|
-
*
|
|
7508
|
+
* <code>BucketOwnerEnforced</code> - Access control lists (ACLs) are disabled and no
|
|
7509
|
+
* longer affect permissions. The bucket owner automatically owns and has full control over
|
|
7510
|
+
* every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL
|
|
7511
|
+
* or specify bucket owner full control ACLs (such as the predefined
|
|
7512
|
+
* <code>bucket-owner-full-control</code> canned ACL or a custom ACL in XML format that
|
|
7513
|
+
* grants the same permissions).</p>
|
|
7514
|
+
* <p>By default, <code>ObjectOwnership</code> is set to <code>BucketOwnerEnforced</code> and
|
|
7515
|
+
* ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where
|
|
7516
|
+
* you must control access for each object individually. For more information about S3 Object
|
|
7517
|
+
* Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of
|
|
7518
|
+
* objects and disabling ACLs for your bucket</a> in the
|
|
7519
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
7318
7520
|
* <note>
|
|
7319
7521
|
* <p>This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.</p>
|
|
7320
7522
|
* </note>
|
|
@@ -7489,10 +7691,10 @@ export interface DeleteMarkerReplication {
|
|
|
7489
7691
|
* <p>Specifies encryption-related information for an Amazon S3 bucket that is a destination for
|
|
7490
7692
|
* replicated objects.</p>
|
|
7491
7693
|
* <note>
|
|
7492
|
-
* <p>If you're specifying a customer managed KMS key, we recommend using a fully
|
|
7493
|
-
*
|
|
7494
|
-
*
|
|
7495
|
-
*
|
|
7694
|
+
* <p>If you're specifying a customer managed KMS key, we recommend using a fully
|
|
7695
|
+
* qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the
|
|
7696
|
+
* key within the requester’s account. This behavior can result in data that's encrypted
|
|
7697
|
+
* with a KMS key that belongs to the requester, and not the bucket owner.</p>
|
|
7496
7698
|
* </note>
|
|
7497
7699
|
* @public
|
|
7498
7700
|
*/
|
|
@@ -7655,10 +7857,10 @@ export declare const ExistingObjectReplicationStatus: {
|
|
|
7655
7857
|
*/
|
|
7656
7858
|
export type ExistingObjectReplicationStatus = (typeof ExistingObjectReplicationStatus)[keyof typeof ExistingObjectReplicationStatus];
|
|
7657
7859
|
/**
|
|
7658
|
-
* <p>Optional configuration to replicate existing source bucket objects.
|
|
7659
|
-
* </p>
|
|
7860
|
+
* <p>Optional configuration to replicate existing source bucket objects. </p>
|
|
7660
7861
|
* <note>
|
|
7661
|
-
* <p>This parameter is no longer supported. To replicate existing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html">Replicating existing objects with S3 Batch Replication</a> in the
|
|
7862
|
+
* <p>This parameter is no longer supported. To replicate existing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html">Replicating existing objects with S3 Batch Replication</a> in the
|
|
7863
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
7662
7864
|
* </note>
|
|
7663
7865
|
* @public
|
|
7664
7866
|
*/
|
|
@@ -7895,10 +8097,10 @@ export interface ReplicationRule {
|
|
|
7895
8097
|
*/
|
|
7896
8098
|
SourceSelectionCriteria?: SourceSelectionCriteria | undefined;
|
|
7897
8099
|
/**
|
|
7898
|
-
* <p>Optional configuration to replicate existing source bucket objects.
|
|
7899
|
-
* </p>
|
|
8100
|
+
* <p>Optional configuration to replicate existing source bucket objects. </p>
|
|
7900
8101
|
* <note>
|
|
7901
|
-
* <p>This parameter is no longer supported. To replicate existing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html">Replicating existing objects with S3 Batch Replication</a> in the
|
|
8102
|
+
* <p>This parameter is no longer supported. To replicate existing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html">Replicating existing objects with S3 Batch Replication</a> in the
|
|
8103
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
7902
8104
|
* </note>
|
|
7903
8105
|
* @public
|
|
7904
8106
|
*/
|
|
@@ -8347,10 +8549,14 @@ export interface GetObjectOutput {
|
|
|
8347
8549
|
* <note>
|
|
8348
8550
|
* <ul>
|
|
8349
8551
|
* <li>
|
|
8350
|
-
* <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the
|
|
8552
|
+
* <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the
|
|
8553
|
+
* object was deleted and includes <code>x-amz-delete-marker: true</code> in the
|
|
8554
|
+
* response.</p>
|
|
8351
8555
|
* </li>
|
|
8352
8556
|
* <li>
|
|
8353
|
-
* <p>If the specified version in the request is a delete marker, the response
|
|
8557
|
+
* <p>If the specified version in the request is a delete marker, the response
|
|
8558
|
+
* returns a <code>405 Method Not Allowed</code> error and the <code>Last-Modified:
|
|
8559
|
+
* timestamp</code> response header.</p>
|
|
8354
8560
|
* </li>
|
|
8355
8561
|
* </ul>
|
|
8356
8562
|
* </note>
|
|
@@ -8365,9 +8571,9 @@ export interface GetObjectOutput {
|
|
|
8365
8571
|
/**
|
|
8366
8572
|
* <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">
|
|
8367
8573
|
* <code>PutBucketLifecycleConfiguration</code>
|
|
8368
|
-
* </a>), the response includes
|
|
8369
|
-
*
|
|
8370
|
-
*
|
|
8574
|
+
* </a>), the response includes this
|
|
8575
|
+
* header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs
|
|
8576
|
+
* providing object expiration information. The value of the <code>rule-id</code> is
|
|
8371
8577
|
* URL-encoded.</p>
|
|
8372
8578
|
* <note>
|
|
8373
8579
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -8379,7 +8585,8 @@ export interface GetObjectOutput {
|
|
|
8379
8585
|
* <p>Provides information about object restoration action and expiration time of the restored
|
|
8380
8586
|
* object copy.</p>
|
|
8381
8587
|
* <note>
|
|
8382
|
-
* <p>This functionality is not supported for directory buckets.
|
|
8588
|
+
* <p>This functionality is not supported for directory buckets.
|
|
8589
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
8383
8590
|
* </note>
|
|
8384
8591
|
* @public
|
|
8385
8592
|
*/
|
|
@@ -8387,7 +8594,10 @@ export interface GetObjectOutput {
|
|
|
8387
8594
|
/**
|
|
8388
8595
|
* <p>Date and time when the object was last modified.</p>
|
|
8389
8596
|
* <p>
|
|
8390
|
-
* <b>General purpose buckets </b> - When you specify a
|
|
8597
|
+
* <b>General purpose buckets </b> - When you specify a
|
|
8598
|
+
* <code>versionId</code> of the object in your request, if the specified version in the
|
|
8599
|
+
* request is a delete marker, the response returns a <code>405 Method Not Allowed</code>
|
|
8600
|
+
* error and the <code>Last-Modified: timestamp</code> response header.</p>
|
|
8391
8601
|
* @public
|
|
8392
8602
|
*/
|
|
8393
8603
|
LastModified?: Date | undefined;
|
|
@@ -8431,9 +8641,10 @@ export interface GetObjectOutput {
|
|
|
8431
8641
|
*/
|
|
8432
8642
|
ChecksumSHA256?: string | undefined;
|
|
8433
8643
|
/**
|
|
8434
|
-
* <p>This is set to the number of metadata entries not returned in the headers that are
|
|
8435
|
-
*
|
|
8436
|
-
*
|
|
8644
|
+
* <p>This is set to the number of metadata entries not returned in the headers that are
|
|
8645
|
+
* prefixed with <code>x-amz-meta-</code>. This can happen if you create metadata using an API
|
|
8646
|
+
* like SOAP that supports more flexible metadata than the REST API. For example, using SOAP,
|
|
8647
|
+
* you can create metadata whose values are not legal HTTP headers.</p>
|
|
8437
8648
|
* <note>
|
|
8438
8649
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
8439
8650
|
* </note>
|
|
@@ -8523,8 +8734,8 @@ export interface GetObjectOutput {
|
|
|
8523
8734
|
SSECustomerAlgorithm?: string | undefined;
|
|
8524
8735
|
/**
|
|
8525
8736
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
8526
|
-
* response will include this header to provide the round-trip message integrity verification
|
|
8527
|
-
* the customer-provided encryption key.</p>
|
|
8737
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
8738
|
+
* of the customer-provided encryption key.</p>
|
|
8528
8739
|
* <note>
|
|
8529
8740
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
8530
8741
|
* </note>
|
|
@@ -8537,8 +8748,8 @@ export interface GetObjectOutput {
|
|
|
8537
8748
|
*/
|
|
8538
8749
|
SSEKMSKeyId?: string | undefined;
|
|
8539
8750
|
/**
|
|
8540
|
-
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption
|
|
8541
|
-
*
|
|
8751
|
+
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with
|
|
8752
|
+
* Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
8542
8753
|
* @public
|
|
8543
8754
|
*/
|
|
8544
8755
|
BucketKeyEnabled?: boolean | undefined;
|
|
@@ -8547,7 +8758,8 @@ export interface GetObjectOutput {
|
|
|
8547
8758
|
* objects except for S3 Standard storage class objects.</p>
|
|
8548
8759
|
* <note>
|
|
8549
8760
|
* <p>
|
|
8550
|
-
* <b>Directory buckets </b> -
|
|
8761
|
+
* <b>Directory buckets </b> -
|
|
8762
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
8551
8763
|
* </note>
|
|
8552
8764
|
* @public
|
|
8553
8765
|
*/
|
|
@@ -8578,7 +8790,8 @@ export interface GetObjectOutput {
|
|
|
8578
8790
|
*/
|
|
8579
8791
|
PartsCount?: number | undefined;
|
|
8580
8792
|
/**
|
|
8581
|
-
* <p>The number of tags, if any, on the object, when you have the relevant permission to read
|
|
8793
|
+
* <p>The number of tags, if any, on the object, when you have the relevant permission to read
|
|
8794
|
+
* object tags.</p>
|
|
8582
8795
|
* <p>You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve
|
|
8583
8796
|
* the tag set associated with an object.</p>
|
|
8584
8797
|
* <note>
|
|
@@ -8631,7 +8844,8 @@ export interface GetObjectRequest {
|
|
|
8631
8844
|
/**
|
|
8632
8845
|
* <p>The bucket name containing the object. </p>
|
|
8633
8846
|
* <p>
|
|
8634
|
-
* <b>Directory buckets</b> -
|
|
8847
|
+
* <b>Directory buckets</b> -
|
|
8848
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
8635
8849
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
8636
8850
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
8637
8851
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -8653,10 +8867,12 @@ export interface GetObjectRequest {
|
|
|
8653
8867
|
*/
|
|
8654
8868
|
Bucket: string | undefined;
|
|
8655
8869
|
/**
|
|
8656
|
-
* <p>Return the object only if its entity tag (ETag) is the same as the one specified in this
|
|
8657
|
-
* otherwise, return a <code>412 Precondition Failed</code> error.</p>
|
|
8658
|
-
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
8659
|
-
*
|
|
8870
|
+
* <p>Return the object only if its entity tag (ETag) is the same as the one specified in this
|
|
8871
|
+
* header; otherwise, return a <code>412 Precondition Failed</code> error.</p>
|
|
8872
|
+
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
8873
|
+
* present in the request as follows: <code>If-Match</code> condition evaluates to
|
|
8874
|
+
* <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to
|
|
8875
|
+
* <code>false</code>; then, S3 returns <code>200 OK</code> and the data requested. </p>
|
|
8660
8876
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
8661
8877
|
* @public
|
|
8662
8878
|
*/
|
|
@@ -8664,20 +8880,22 @@ export interface GetObjectRequest {
|
|
|
8664
8880
|
/**
|
|
8665
8881
|
* <p>Return the object only if it has been modified since the specified time; otherwise,
|
|
8666
8882
|
* return a <code>304 Not Modified</code> error.</p>
|
|
8667
|
-
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
8668
|
-
*
|
|
8669
|
-
*
|
|
8883
|
+
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
8884
|
+
* present in the request as follows:<code> If-None-Match</code> condition evaluates to
|
|
8885
|
+
* <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to
|
|
8886
|
+
* <code>true</code>; then, S3 returns <code>304 Not Modified</code> status code.</p>
|
|
8670
8887
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
8671
8888
|
* @public
|
|
8672
8889
|
*/
|
|
8673
8890
|
IfModifiedSince?: Date | undefined;
|
|
8674
8891
|
/**
|
|
8675
|
-
* <p>Return the object only if its entity tag (ETag) is different from the one specified in
|
|
8676
|
-
* otherwise, return a <code>304 Not Modified</code> error.</p>
|
|
8677
|
-
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
|
|
8678
|
-
*
|
|
8679
|
-
*
|
|
8680
|
-
*
|
|
8892
|
+
* <p>Return the object only if its entity tag (ETag) is different from the one specified in
|
|
8893
|
+
* this header; otherwise, return a <code>304 Not Modified</code> error.</p>
|
|
8894
|
+
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
8895
|
+
* present in the request as follows:<code> If-None-Match</code> condition evaluates to
|
|
8896
|
+
* <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to
|
|
8897
|
+
* <code>true</code>; then, S3 returns <code>304 Not Modified</code> HTTP status
|
|
8898
|
+
* code.</p>
|
|
8681
8899
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
8682
8900
|
* @public
|
|
8683
8901
|
*/
|
|
@@ -8685,10 +8903,10 @@ export interface GetObjectRequest {
|
|
|
8685
8903
|
/**
|
|
8686
8904
|
* <p>Return the object only if it has not been modified since the specified time; otherwise,
|
|
8687
8905
|
* return a <code>412 Precondition Failed</code> error.</p>
|
|
8688
|
-
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
|
|
8689
|
-
*
|
|
8690
|
-
*
|
|
8691
|
-
*
|
|
8906
|
+
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
8907
|
+
* present in the request as follows: <code>If-Match</code> condition evaluates to
|
|
8908
|
+
* <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to
|
|
8909
|
+
* <code>false</code>; then, S3 returns <code>200 OK</code> and the data requested. </p>
|
|
8692
8910
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
8693
8911
|
* @public
|
|
8694
8912
|
*/
|
|
@@ -8740,19 +8958,28 @@ export interface GetObjectRequest {
|
|
|
8740
8958
|
ResponseExpires?: Date | undefined;
|
|
8741
8959
|
/**
|
|
8742
8960
|
* <p>Version ID used to reference a specific version of the object.</p>
|
|
8743
|
-
* <p>By default, the <code>GetObject</code> operation returns the current version of an
|
|
8961
|
+
* <p>By default, the <code>GetObject</code> operation returns the current version of an
|
|
8962
|
+
* object. To return a different version, use the <code>versionId</code> subresource.</p>
|
|
8744
8963
|
* <note>
|
|
8745
8964
|
* <ul>
|
|
8746
8965
|
* <li>
|
|
8747
|
-
* <p>If you include a <code>versionId</code> in your request header, you must have
|
|
8966
|
+
* <p>If you include a <code>versionId</code> in your request header, you must have
|
|
8967
|
+
* the <code>s3:GetObjectVersion</code> permission to access a specific version of an
|
|
8968
|
+
* object. The <code>s3:GetObject</code> permission is not required in this
|
|
8969
|
+
* scenario.</p>
|
|
8748
8970
|
* </li>
|
|
8749
8971
|
* <li>
|
|
8750
|
-
* <p>If you request the current version of an object without a specific
|
|
8972
|
+
* <p>If you request the current version of an object without a specific
|
|
8973
|
+
* <code>versionId</code> in the request header, only the
|
|
8974
|
+
* <code>s3:GetObject</code> permission is required. The
|
|
8975
|
+
* <code>s3:GetObjectVersion</code> permission is not required in this
|
|
8976
|
+
* scenario.</p>
|
|
8751
8977
|
* </li>
|
|
8752
8978
|
* <li>
|
|
8753
8979
|
* <p>
|
|
8754
|
-
* <b>Directory buckets</b> -
|
|
8755
|
-
*
|
|
8980
|
+
* <b>Directory buckets</b> -
|
|
8981
|
+
* S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the
|
|
8982
|
+
* <code>versionId</code> query parameter in the request.</p>
|
|
8756
8983
|
* </li>
|
|
8757
8984
|
* </ul>
|
|
8758
8985
|
* </note>
|
|
@@ -8762,7 +8989,7 @@ export interface GetObjectRequest {
|
|
|
8762
8989
|
VersionId?: string | undefined;
|
|
8763
8990
|
/**
|
|
8764
8991
|
* <p>Specifies the algorithm to use when decrypting the object (for example,
|
|
8765
|
-
*
|
|
8992
|
+
* <code>AES256</code>).</p>
|
|
8766
8993
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
8767
8994
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
|
|
8768
8995
|
* you must use the following headers:</p>
|
|
@@ -8784,7 +9011,8 @@ export interface GetObjectRequest {
|
|
|
8784
9011
|
* </li>
|
|
8785
9012
|
* </ul>
|
|
8786
9013
|
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
8787
|
-
*
|
|
9014
|
+
* (Using Customer-Provided Encryption Keys)</a> in the
|
|
9015
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
8788
9016
|
* <note>
|
|
8789
9017
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
8790
9018
|
* </note>
|
|
@@ -8792,9 +9020,10 @@ export interface GetObjectRequest {
|
|
|
8792
9020
|
*/
|
|
8793
9021
|
SSECustomerAlgorithm?: string | undefined;
|
|
8794
9022
|
/**
|
|
8795
|
-
* <p>Specifies the customer-provided encryption key that you originally provided for Amazon S3 to
|
|
8796
|
-
*
|
|
8797
|
-
*
|
|
9023
|
+
* <p>Specifies the customer-provided encryption key that you originally provided for Amazon S3 to
|
|
9024
|
+
* encrypt the data before storing it. This value is used to decrypt the object when
|
|
9025
|
+
* recovering it and must match the one used when storing the data. The key must be
|
|
9026
|
+
* appropriate for use with the algorithm specified in the
|
|
8798
9027
|
* <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
|
|
8799
9028
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
8800
9029
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
|
|
@@ -8817,7 +9046,8 @@ export interface GetObjectRequest {
|
|
|
8817
9046
|
* </li>
|
|
8818
9047
|
* </ul>
|
|
8819
9048
|
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
8820
|
-
*
|
|
9049
|
+
* (Using Customer-Provided Encryption Keys)</a> in the
|
|
9050
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
8821
9051
|
* <note>
|
|
8822
9052
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
8823
9053
|
* </note>
|
|
@@ -8825,9 +9055,9 @@ export interface GetObjectRequest {
|
|
|
8825
9055
|
*/
|
|
8826
9056
|
SSECustomerKey?: string | undefined;
|
|
8827
9057
|
/**
|
|
8828
|
-
* <p>Specifies the 128-bit MD5 digest of the customer-provided encryption key according to
|
|
8829
|
-
* this header for a message integrity check to ensure that the encryption
|
|
8830
|
-
* without error.</p>
|
|
9058
|
+
* <p>Specifies the 128-bit MD5 digest of the customer-provided encryption key according to
|
|
9059
|
+
* RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption
|
|
9060
|
+
* key was transmitted without error.</p>
|
|
8831
9061
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
8832
9062
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,
|
|
8833
9063
|
* you must use the following headers:</p>
|
|
@@ -8849,7 +9079,8 @@ export interface GetObjectRequest {
|
|
|
8849
9079
|
* </li>
|
|
8850
9080
|
* </ul>
|
|
8851
9081
|
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
8852
|
-
*
|
|
9082
|
+
* (Using Customer-Provided Encryption Keys)</a> in the
|
|
9083
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
8853
9084
|
* <note>
|
|
8854
9085
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
8855
9086
|
* </note>
|
|
@@ -8859,9 +9090,9 @@ export interface GetObjectRequest {
|
|
|
8859
9090
|
/**
|
|
8860
9091
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
8861
9092
|
* owners need not specify this parameter in their requests. If either the source or
|
|
8862
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
8863
|
-
*
|
|
8864
|
-
*
|
|
9093
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
9094
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
9095
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
8865
9096
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8866
9097
|
* <note>
|
|
8867
9098
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -8884,23 +9115,23 @@ export interface GetObjectRequest {
|
|
|
8884
9115
|
/**
|
|
8885
9116
|
* <p>To retrieve the checksum, this mode must be enabled.</p>
|
|
8886
9117
|
* <p>
|
|
8887
|
-
* <b>General purpose buckets</b> - In addition, if you enable
|
|
8888
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html">checksum</a>
|
|
8889
|
-
*
|
|
8890
|
-
*
|
|
9118
|
+
* <b>General purpose buckets</b> - In addition, if you enable
|
|
9119
|
+
* checksum mode and the object is uploaded with a <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html">checksum</a> and encrypted with an
|
|
9120
|
+
* Key Management Service (KMS) key, you must have permission to use the <code>kms:Decrypt</code> action
|
|
9121
|
+
* to retrieve the checksum.</p>
|
|
8891
9122
|
* @public
|
|
8892
9123
|
*/
|
|
8893
9124
|
ChecksumMode?: ChecksumMode | undefined;
|
|
8894
9125
|
}
|
|
8895
9126
|
/**
|
|
8896
9127
|
* <p>Object is archived and inaccessible until restored.</p>
|
|
8897
|
-
* <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage
|
|
8898
|
-
* S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access
|
|
8899
|
-
* S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you
|
|
8900
|
-
* copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this
|
|
8901
|
-
* <code>InvalidObjectState</code> error. For information about restoring
|
|
8902
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring
|
|
8903
|
-
*
|
|
9128
|
+
* <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage
|
|
9129
|
+
* class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access
|
|
9130
|
+
* tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you
|
|
9131
|
+
* must first restore a copy using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. Otherwise, this
|
|
9132
|
+
* operation returns an <code>InvalidObjectState</code> error. For information about restoring
|
|
9133
|
+
* archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived Objects</a> in
|
|
9134
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
8904
9135
|
* @public
|
|
8905
9136
|
*/
|
|
8906
9137
|
export declare class InvalidObjectState extends __BaseException {
|
|
@@ -8978,9 +9209,9 @@ export interface GetObjectAclRequest {
|
|
|
8978
9209
|
/**
|
|
8979
9210
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
8980
9211
|
* owners need not specify this parameter in their requests. If either the source or
|
|
8981
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
8982
|
-
*
|
|
8983
|
-
*
|
|
9212
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
9213
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
9214
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
8984
9215
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8985
9216
|
* <note>
|
|
8986
9217
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -9122,13 +9353,19 @@ export interface GetObjectAttributesParts {
|
|
|
9122
9353
|
* <ul>
|
|
9123
9354
|
* <li>
|
|
9124
9355
|
* <p>
|
|
9125
|
-
* <b>General purpose buckets</b> - For
|
|
9126
|
-
*
|
|
9127
|
-
*
|
|
9356
|
+
* <b>General purpose buckets</b> - For
|
|
9357
|
+
* <code>GetObjectAttributes</code>, if a additional checksum (including
|
|
9358
|
+
* <code>x-amz-checksum-crc32</code>, <code>x-amz-checksum-crc32c</code>,
|
|
9359
|
+
* <code>x-amz-checksum-sha1</code>, or <code>x-amz-checksum-sha256</code>) isn't
|
|
9360
|
+
* applied to the object specified in the request, the response doesn't return
|
|
9361
|
+
* <code>Part</code>.</p>
|
|
9128
9362
|
* </li>
|
|
9129
9363
|
* <li>
|
|
9130
9364
|
* <p>
|
|
9131
|
-
* <b>Directory buckets</b> - For
|
|
9365
|
+
* <b>Directory buckets</b> - For
|
|
9366
|
+
* <code>GetObjectAttributes</code>, no matter whether a additional checksum is
|
|
9367
|
+
* applied to the object specified in the request, the response returns
|
|
9368
|
+
* <code>Part</code>.</p>
|
|
9132
9369
|
* </li>
|
|
9133
9370
|
* </ul>
|
|
9134
9371
|
* </note>
|
|
@@ -9151,7 +9388,7 @@ export interface GetObjectAttributesOutput {
|
|
|
9151
9388
|
*/
|
|
9152
9389
|
DeleteMarker?: boolean | undefined;
|
|
9153
9390
|
/**
|
|
9154
|
-
* <p>
|
|
9391
|
+
* <p>Date and time when the object was last modified.</p>
|
|
9155
9392
|
* @public
|
|
9156
9393
|
*/
|
|
9157
9394
|
LastModified?: Date | undefined;
|
|
@@ -9194,7 +9431,8 @@ export interface GetObjectAttributesOutput {
|
|
|
9194
9431
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p>
|
|
9195
9432
|
* <note>
|
|
9196
9433
|
* <p>
|
|
9197
|
-
* <b>Directory buckets</b> -
|
|
9434
|
+
* <b>Directory buckets</b> -
|
|
9435
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
9198
9436
|
* </note>
|
|
9199
9437
|
* @public
|
|
9200
9438
|
*/
|
|
@@ -9227,7 +9465,8 @@ export interface GetObjectAttributesRequest {
|
|
|
9227
9465
|
/**
|
|
9228
9466
|
* <p>The name of the bucket that contains the object.</p>
|
|
9229
9467
|
* <p>
|
|
9230
|
-
* <b>Directory buckets</b> -
|
|
9468
|
+
* <b>Directory buckets</b> -
|
|
9469
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
9231
9470
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
9232
9471
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
9233
9472
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -9254,8 +9493,8 @@ export interface GetObjectAttributesRequest {
|
|
|
9254
9493
|
/**
|
|
9255
9494
|
* <p>The version ID used to reference a specific version of the object.</p>
|
|
9256
9495
|
* <note>
|
|
9257
|
-
* <p>S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code>
|
|
9258
|
-
*
|
|
9496
|
+
* <p>S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the
|
|
9497
|
+
* <code>versionId</code> query parameter in the request.</p>
|
|
9259
9498
|
* </note>
|
|
9260
9499
|
* @public
|
|
9261
9500
|
*/
|
|
@@ -9303,9 +9542,9 @@ export interface GetObjectAttributesRequest {
|
|
|
9303
9542
|
/**
|
|
9304
9543
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
9305
9544
|
* owners need not specify this parameter in their requests. If either the source or
|
|
9306
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
9307
|
-
*
|
|
9308
|
-
*
|
|
9545
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
9546
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
9547
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
9309
9548
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9310
9549
|
* <note>
|
|
9311
9550
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -9372,9 +9611,9 @@ export interface GetObjectLegalHoldRequest {
|
|
|
9372
9611
|
/**
|
|
9373
9612
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
9374
9613
|
* owners need not specify this parameter in their requests. If either the source or
|
|
9375
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
9376
|
-
*
|
|
9377
|
-
*
|
|
9614
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
9615
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
9616
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
9378
9617
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9379
9618
|
* <note>
|
|
9380
9619
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -9412,8 +9651,8 @@ export declare const ObjectLockRetentionMode: {
|
|
|
9412
9651
|
*/
|
|
9413
9652
|
export type ObjectLockRetentionMode = (typeof ObjectLockRetentionMode)[keyof typeof ObjectLockRetentionMode];
|
|
9414
9653
|
/**
|
|
9415
|
-
* <p>The container element for optionally specifying the default Object Lock retention
|
|
9416
|
-
* objects placed in the specified bucket.</p>
|
|
9654
|
+
* <p>The container element for optionally specifying the default Object Lock retention
|
|
9655
|
+
* settings for new objects placed in the specified bucket.</p>
|
|
9417
9656
|
* <note>
|
|
9418
9657
|
* <ul>
|
|
9419
9658
|
* <li>
|
|
@@ -9566,9 +9805,9 @@ export interface GetObjectRetentionRequest {
|
|
|
9566
9805
|
/**
|
|
9567
9806
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
9568
9807
|
* owners need not specify this parameter in their requests. If either the source or
|
|
9569
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
9570
|
-
*
|
|
9571
|
-
*
|
|
9808
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
9809
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
9810
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
9572
9811
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9573
9812
|
* <note>
|
|
9574
9813
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -9631,9 +9870,9 @@ export interface GetObjectTaggingRequest {
|
|
|
9631
9870
|
/**
|
|
9632
9871
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
9633
9872
|
* owners need not specify this parameter in their requests. If either the source or
|
|
9634
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
9635
|
-
*
|
|
9636
|
-
*
|
|
9873
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
9874
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
9875
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
9637
9876
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9638
9877
|
* <note>
|
|
9639
9878
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -9680,9 +9919,9 @@ export interface GetObjectTorrentRequest {
|
|
|
9680
9919
|
/**
|
|
9681
9920
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
9682
9921
|
* owners need not specify this parameter in their requests. If either the source or
|
|
9683
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
9684
|
-
*
|
|
9685
|
-
*
|
|
9922
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
9923
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
9924
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
9686
9925
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9687
9926
|
* <note>
|
|
9688
9927
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -9794,7 +10033,8 @@ export interface HeadBucketOutput {
|
|
|
9794
10033
|
BucketLocationType?: LocationType | undefined;
|
|
9795
10034
|
/**
|
|
9796
10035
|
* <p>The name of the location where the bucket will be created.</p>
|
|
9797
|
-
* <p>For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example
|
|
10036
|
+
* <p>For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example
|
|
10037
|
+
* AZ ID value is <code>usw2-az1</code>.</p>
|
|
9798
10038
|
* <note>
|
|
9799
10039
|
* <p>This functionality is only supported by directory buckets.</p>
|
|
9800
10040
|
* </note>
|
|
@@ -9822,7 +10062,8 @@ export interface HeadBucketRequest {
|
|
|
9822
10062
|
/**
|
|
9823
10063
|
* <p>The bucket name.</p>
|
|
9824
10064
|
* <p>
|
|
9825
|
-
* <b>Directory buckets</b> -
|
|
10065
|
+
* <b>Directory buckets</b> -
|
|
10066
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
9826
10067
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
9827
10068
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
9828
10069
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -9897,9 +10138,9 @@ export interface HeadObjectOutput {
|
|
|
9897
10138
|
/**
|
|
9898
10139
|
* <p>If the object expiration is configured (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">
|
|
9899
10140
|
* <code>PutBucketLifecycleConfiguration</code>
|
|
9900
|
-
* </a>), the response includes
|
|
9901
|
-
*
|
|
9902
|
-
*
|
|
10141
|
+
* </a>), the response includes this
|
|
10142
|
+
* header. It includes the <code>expiry-date</code> and <code>rule-id</code> key-value pairs
|
|
10143
|
+
* providing object expiration information. The value of the <code>rule-id</code> is
|
|
9903
10144
|
* URL-encoded.</p>
|
|
9904
10145
|
* <note>
|
|
9905
10146
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -9920,7 +10161,8 @@ export interface HeadObjectOutput {
|
|
|
9920
10161
|
* <code>ongoing-request="true"</code>.</p>
|
|
9921
10162
|
* <p>For more information about archiving objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations">Transitioning Objects: General Considerations</a>.</p>
|
|
9922
10163
|
* <note>
|
|
9923
|
-
* <p>This functionality is not supported for directory buckets.
|
|
10164
|
+
* <p>This functionality is not supported for directory buckets.
|
|
10165
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
9924
10166
|
* </note>
|
|
9925
10167
|
* @public
|
|
9926
10168
|
*/
|
|
@@ -10050,8 +10292,8 @@ export interface HeadObjectOutput {
|
|
|
10050
10292
|
*/
|
|
10051
10293
|
WebsiteRedirectLocation?: string | undefined;
|
|
10052
10294
|
/**
|
|
10053
|
-
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
10054
|
-
*
|
|
10295
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
10296
|
+
* example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
|
|
10055
10297
|
* @public
|
|
10056
10298
|
*/
|
|
10057
10299
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
@@ -10071,8 +10313,8 @@ export interface HeadObjectOutput {
|
|
|
10071
10313
|
SSECustomerAlgorithm?: string | undefined;
|
|
10072
10314
|
/**
|
|
10073
10315
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
10074
|
-
* response will include this header to provide the round-trip message integrity verification
|
|
10075
|
-
* the customer-provided encryption key.</p>
|
|
10316
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
10317
|
+
* of the customer-provided encryption key.</p>
|
|
10076
10318
|
* <note>
|
|
10077
10319
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
10078
10320
|
* </note>
|
|
@@ -10085,8 +10327,8 @@ export interface HeadObjectOutput {
|
|
|
10085
10327
|
*/
|
|
10086
10328
|
SSEKMSKeyId?: string | undefined;
|
|
10087
10329
|
/**
|
|
10088
|
-
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption
|
|
10089
|
-
*
|
|
10330
|
+
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with
|
|
10331
|
+
* Key Management Service (KMS) keys (SSE-KMS).</p>
|
|
10090
10332
|
* @public
|
|
10091
10333
|
*/
|
|
10092
10334
|
BucketKeyEnabled?: boolean | undefined;
|
|
@@ -10096,7 +10338,8 @@ export interface HeadObjectOutput {
|
|
|
10096
10338
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a>.</p>
|
|
10097
10339
|
* <note>
|
|
10098
10340
|
* <p>
|
|
10099
|
-
* <b>Directory buckets </b> -
|
|
10341
|
+
* <b>Directory buckets </b> -
|
|
10342
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
10100
10343
|
* </note>
|
|
10101
10344
|
* @public
|
|
10102
10345
|
*/
|
|
@@ -10201,7 +10444,8 @@ export interface HeadObjectRequest {
|
|
|
10201
10444
|
/**
|
|
10202
10445
|
* <p>The name of the bucket that contains the object.</p>
|
|
10203
10446
|
* <p>
|
|
10204
|
-
* <b>Directory buckets</b> -
|
|
10447
|
+
* <b>Directory buckets</b> -
|
|
10448
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
10205
10449
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
10206
10450
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
10207
10451
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -10223,9 +10467,8 @@ export interface HeadObjectRequest {
|
|
|
10223
10467
|
/**
|
|
10224
10468
|
* <p>Return the object only if its entity tag (ETag) is the same as the one specified;
|
|
10225
10469
|
* otherwise, return a 412 (precondition failed) error.</p>
|
|
10226
|
-
* <p>If both of the <code>If-Match</code> and
|
|
10227
|
-
*
|
|
10228
|
-
* follows:</p>
|
|
10470
|
+
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
10471
|
+
* present in the request as follows:</p>
|
|
10229
10472
|
* <ul>
|
|
10230
10473
|
* <li>
|
|
10231
10474
|
* <p>
|
|
@@ -10233,8 +10476,7 @@ export interface HeadObjectRequest {
|
|
|
10233
10476
|
* </li>
|
|
10234
10477
|
* <li>
|
|
10235
10478
|
* <p>
|
|
10236
|
-
* <code>If-Unmodified-Since</code> condition evaluates to
|
|
10237
|
-
* <code>false</code>;</p>
|
|
10479
|
+
* <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>;</p>
|
|
10238
10480
|
* </li>
|
|
10239
10481
|
* </ul>
|
|
10240
10482
|
* <p>Then Amazon S3 returns <code>200 OK</code> and the data requested.</p>
|
|
@@ -10245,19 +10487,16 @@ export interface HeadObjectRequest {
|
|
|
10245
10487
|
/**
|
|
10246
10488
|
* <p>Return the object only if it has been modified since the specified time; otherwise,
|
|
10247
10489
|
* return a 304 (not modified) error.</p>
|
|
10248
|
-
* <p>If both of the <code>If-None-Match</code> and
|
|
10249
|
-
*
|
|
10250
|
-
* follows:</p>
|
|
10490
|
+
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
10491
|
+
* present in the request as follows:</p>
|
|
10251
10492
|
* <ul>
|
|
10252
10493
|
* <li>
|
|
10253
10494
|
* <p>
|
|
10254
|
-
* <code>If-None-Match</code> condition evaluates to <code>false</code>,
|
|
10255
|
-
* and;</p>
|
|
10495
|
+
* <code>If-None-Match</code> condition evaluates to <code>false</code>, and;</p>
|
|
10256
10496
|
* </li>
|
|
10257
10497
|
* <li>
|
|
10258
10498
|
* <p>
|
|
10259
|
-
* <code>If-Modified-Since</code> condition evaluates to
|
|
10260
|
-
* <code>true</code>;</p>
|
|
10499
|
+
* <code>If-Modified-Since</code> condition evaluates to <code>true</code>;</p>
|
|
10261
10500
|
* </li>
|
|
10262
10501
|
* </ul>
|
|
10263
10502
|
* <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p>
|
|
@@ -10268,19 +10507,16 @@ export interface HeadObjectRequest {
|
|
|
10268
10507
|
/**
|
|
10269
10508
|
* <p>Return the object only if its entity tag (ETag) is different from the one specified;
|
|
10270
10509
|
* otherwise, return a 304 (not modified) error.</p>
|
|
10271
|
-
* <p>If both of the <code>If-None-Match</code> and
|
|
10272
|
-
*
|
|
10273
|
-
* follows:</p>
|
|
10510
|
+
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
10511
|
+
* present in the request as follows:</p>
|
|
10274
10512
|
* <ul>
|
|
10275
10513
|
* <li>
|
|
10276
10514
|
* <p>
|
|
10277
|
-
* <code>If-None-Match</code> condition evaluates to <code>false</code>,
|
|
10278
|
-
* and;</p>
|
|
10515
|
+
* <code>If-None-Match</code> condition evaluates to <code>false</code>, and;</p>
|
|
10279
10516
|
* </li>
|
|
10280
10517
|
* <li>
|
|
10281
10518
|
* <p>
|
|
10282
|
-
* <code>If-Modified-Since</code> condition evaluates to
|
|
10283
|
-
* <code>true</code>;</p>
|
|
10519
|
+
* <code>If-Modified-Since</code> condition evaluates to <code>true</code>;</p>
|
|
10284
10520
|
* </li>
|
|
10285
10521
|
* </ul>
|
|
10286
10522
|
* <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p>
|
|
@@ -10291,9 +10527,8 @@ export interface HeadObjectRequest {
|
|
|
10291
10527
|
/**
|
|
10292
10528
|
* <p>Return the object only if it has not been modified since the specified time; otherwise,
|
|
10293
10529
|
* return a 412 (precondition failed) error.</p>
|
|
10294
|
-
* <p>If both of the <code>If-Match</code> and
|
|
10295
|
-
*
|
|
10296
|
-
* follows:</p>
|
|
10530
|
+
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
10531
|
+
* present in the request as follows:</p>
|
|
10297
10532
|
* <ul>
|
|
10298
10533
|
* <li>
|
|
10299
10534
|
* <p>
|
|
@@ -10301,8 +10536,7 @@ export interface HeadObjectRequest {
|
|
|
10301
10536
|
* </li>
|
|
10302
10537
|
* <li>
|
|
10303
10538
|
* <p>
|
|
10304
|
-
* <code>If-Unmodified-Since</code> condition evaluates to
|
|
10305
|
-
* <code>false</code>;</p>
|
|
10539
|
+
* <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>;</p>
|
|
10306
10540
|
* </li>
|
|
10307
10541
|
* </ul>
|
|
10308
10542
|
* <p>Then Amazon S3 returns <code>200 OK</code> and the data requested.</p>
|
|
@@ -10361,8 +10595,7 @@ export interface HeadObjectRequest {
|
|
|
10361
10595
|
*/
|
|
10362
10596
|
VersionId?: string | undefined;
|
|
10363
10597
|
/**
|
|
10364
|
-
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
10365
|
-
* AES256).</p>
|
|
10598
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>
|
|
10366
10599
|
* <note>
|
|
10367
10600
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
10368
10601
|
* </note>
|
|
@@ -10393,9 +10626,9 @@ export interface HeadObjectRequest {
|
|
|
10393
10626
|
/**
|
|
10394
10627
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
10395
10628
|
* owners need not specify this parameter in their requests. If either the source or
|
|
10396
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
10397
|
-
*
|
|
10398
|
-
*
|
|
10629
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
10630
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
10631
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
10399
10632
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
10400
10633
|
* <note>
|
|
10401
10634
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -10418,14 +10651,17 @@ export interface HeadObjectRequest {
|
|
|
10418
10651
|
/**
|
|
10419
10652
|
* <p>To retrieve the checksum, this parameter must be enabled.</p>
|
|
10420
10653
|
* <p>
|
|
10421
|
-
* <b>General purpose buckets</b> -
|
|
10422
|
-
*
|
|
10654
|
+
* <b>General purpose buckets</b> -
|
|
10655
|
+
* If you enable checksum mode and the object is uploaded with a
|
|
10656
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html">checksum</a>
|
|
10423
10657
|
* and encrypted with an Key Management Service (KMS) key, you must have permission to use the
|
|
10424
|
-
*
|
|
10658
|
+
* <code>kms:Decrypt</code> action to retrieve the checksum.</p>
|
|
10425
10659
|
* <p>
|
|
10426
|
-
* <b>Directory buckets</b> - If you enable
|
|
10427
|
-
*
|
|
10428
|
-
*
|
|
10660
|
+
* <b>Directory buckets</b> - If you enable
|
|
10661
|
+
* <code>ChecksumMode</code> and the object is encrypted with Amazon Web Services Key Management Service
|
|
10662
|
+
* (Amazon Web Services KMS), you must also have the <code>kms:GenerateDataKey</code> and
|
|
10663
|
+
* <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key
|
|
10664
|
+
* policies for the KMS key to retrieve the checksum of the object.</p>
|
|
10429
10665
|
* @public
|
|
10430
10666
|
*/
|
|
10431
10667
|
ChecksumMode?: ChecksumMode | undefined;
|
|
@@ -10645,7 +10881,7 @@ export interface ListBucketMetricsConfigurationsRequest {
|
|
|
10645
10881
|
ExpectedBucketOwner?: string | undefined;
|
|
10646
10882
|
}
|
|
10647
10883
|
/**
|
|
10648
|
-
* <p> In terms of implementation, a Bucket is a resource.
|
|
10884
|
+
* <p> In terms of implementation, a Bucket is a resource. </p>
|
|
10649
10885
|
* @public
|
|
10650
10886
|
*/
|
|
10651
10887
|
export interface Bucket {
|
|
@@ -10662,7 +10898,8 @@ export interface Bucket {
|
|
|
10662
10898
|
CreationDate?: Date | undefined;
|
|
10663
10899
|
/**
|
|
10664
10900
|
* <p>
|
|
10665
|
-
* <code>BucketRegion</code> indicates the Amazon Web Services region where the bucket is located. If the
|
|
10901
|
+
* <code>BucketRegion</code> indicates the Amazon Web Services region where the bucket is located. If the
|
|
10902
|
+
* request contains at least one valid parameter, it is included in the response.</p>
|
|
10666
10903
|
* @public
|
|
10667
10904
|
*/
|
|
10668
10905
|
BucketRegion?: string | undefined;
|
|
@@ -10683,8 +10920,10 @@ export interface ListBucketsOutput {
|
|
|
10683
10920
|
Owner?: Owner | undefined;
|
|
10684
10921
|
/**
|
|
10685
10922
|
* <p>
|
|
10686
|
-
* <code>ContinuationToken</code> is included in the
|
|
10687
|
-
*
|
|
10923
|
+
* <code>ContinuationToken</code> is included in the response when there are more buckets
|
|
10924
|
+
* that can be listed with pagination. The next <code>ListBuckets</code> request to Amazon S3 can
|
|
10925
|
+
* be continued with this <code>ContinuationToken</code>. <code>ContinuationToken</code> is
|
|
10926
|
+
* obfuscated and is not a real bucket.</p>
|
|
10688
10927
|
* @public
|
|
10689
10928
|
*/
|
|
10690
10929
|
ContinuationToken?: string | undefined;
|
|
@@ -10700,7 +10939,9 @@ export interface ListBucketsOutput {
|
|
|
10700
10939
|
*/
|
|
10701
10940
|
export interface ListBucketsRequest {
|
|
10702
10941
|
/**
|
|
10703
|
-
* <p>Maximum number of buckets to be returned in response. When the number is more than the
|
|
10942
|
+
* <p>Maximum number of buckets to be returned in response. When the number is more than the
|
|
10943
|
+
* count of buckets that are owned by an Amazon Web Services account, return all the buckets in
|
|
10944
|
+
* response.</p>
|
|
10704
10945
|
* @public
|
|
10705
10946
|
*/
|
|
10706
10947
|
MaxBuckets?: number | undefined;
|
|
@@ -10708,7 +10949,7 @@ export interface ListBucketsRequest {
|
|
|
10708
10949
|
* <p>
|
|
10709
10950
|
* <code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on
|
|
10710
10951
|
* this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real
|
|
10711
|
-
* key. You can use this <code>ContinuationToken</code> for pagination of the list results.
|
|
10952
|
+
* key. You can use this <code>ContinuationToken</code> for pagination of the list results. </p>
|
|
10712
10953
|
* <p>Length Constraints: Minimum length of 0. Maximum length of 1024.</p>
|
|
10713
10954
|
* <p>Required: No.</p>
|
|
10714
10955
|
* <note>
|
|
@@ -10720,14 +10961,21 @@ export interface ListBucketsRequest {
|
|
|
10720
10961
|
*/
|
|
10721
10962
|
ContinuationToken?: string | undefined;
|
|
10722
10963
|
/**
|
|
10723
|
-
* <p>Limits the response to bucket names that begin with the specified bucket name
|
|
10964
|
+
* <p>Limits the response to bucket names that begin with the specified bucket name
|
|
10965
|
+
* prefix.</p>
|
|
10724
10966
|
* @public
|
|
10725
10967
|
*/
|
|
10726
10968
|
Prefix?: string | undefined;
|
|
10727
10969
|
/**
|
|
10728
|
-
* <p>Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services
|
|
10970
|
+
* <p>Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services
|
|
10971
|
+
* Region must be expressed according to the Amazon Web Services Region code, such as <code>us-west-2</code>
|
|
10972
|
+
* for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services
|
|
10973
|
+
* Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a>.</p>
|
|
10729
10974
|
* <note>
|
|
10730
|
-
* <p>Requests made to a Regional endpoint that is different from the
|
|
10975
|
+
* <p>Requests made to a Regional endpoint that is different from the
|
|
10976
|
+
* <code>bucket-region</code> parameter are not supported. For example, if you want to
|
|
10977
|
+
* limit the response to your buckets in Region <code>us-west-2</code>, the request must be
|
|
10978
|
+
* made to an endpoint in Region <code>us-west-2</code>.</p>
|
|
10731
10979
|
* </note>
|
|
10732
10980
|
* @public
|
|
10733
10981
|
*/
|
|
@@ -10744,7 +10992,8 @@ export interface ListDirectoryBucketsOutput {
|
|
|
10744
10992
|
Buckets?: Bucket[] | undefined;
|
|
10745
10993
|
/**
|
|
10746
10994
|
* <p>If <code>ContinuationToken</code> was sent with the request, it is included in the
|
|
10747
|
-
* response. You can use the returned <code>ContinuationToken</code> for pagination of the
|
|
10995
|
+
* response. You can use the returned <code>ContinuationToken</code> for pagination of the
|
|
10996
|
+
* list response.</p>
|
|
10748
10997
|
* @public
|
|
10749
10998
|
*/
|
|
10750
10999
|
ContinuationToken?: string | undefined;
|
|
@@ -10755,13 +11004,17 @@ export interface ListDirectoryBucketsOutput {
|
|
|
10755
11004
|
export interface ListDirectoryBucketsRequest {
|
|
10756
11005
|
/**
|
|
10757
11006
|
* <p>
|
|
10758
|
-
* <code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on
|
|
10759
|
-
*
|
|
11007
|
+
* <code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on
|
|
11008
|
+
* buckets in this account with a token. <code>ContinuationToken</code> is obfuscated and is
|
|
11009
|
+
* not a real bucket name. You can use this <code>ContinuationToken</code> for the pagination
|
|
11010
|
+
* of the list results. </p>
|
|
10760
11011
|
* @public
|
|
10761
11012
|
*/
|
|
10762
11013
|
ContinuationToken?: string | undefined;
|
|
10763
11014
|
/**
|
|
10764
|
-
* <p>Maximum number of buckets to be returned in response. When the number is more than the
|
|
11015
|
+
* <p>Maximum number of buckets to be returned in response. When the number is more than the
|
|
11016
|
+
* count of buckets that are owned by an Amazon Web Services account, return all the buckets in
|
|
11017
|
+
* response.</p>
|
|
10765
11018
|
* @public
|
|
10766
11019
|
*/
|
|
10767
11020
|
MaxDirectoryBuckets?: number | undefined;
|
|
@@ -10801,8 +11054,9 @@ export interface Initiator {
|
|
|
10801
11054
|
* principal is an IAM User, it provides a user ARN value.</p>
|
|
10802
11055
|
* <note>
|
|
10803
11056
|
* <p>
|
|
10804
|
-
* <b>Directory buckets</b> - If the principal is an
|
|
10805
|
-
*
|
|
11057
|
+
* <b>Directory buckets</b> - If the principal is an
|
|
11058
|
+
* Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it
|
|
11059
|
+
* provides a user ARN value.</p>
|
|
10806
11060
|
* </note>
|
|
10807
11061
|
* @public
|
|
10808
11062
|
*/
|
|
@@ -10840,7 +11094,8 @@ export interface MultipartUpload {
|
|
|
10840
11094
|
* <p>The class of storage used to store the object.</p>
|
|
10841
11095
|
* <note>
|
|
10842
11096
|
* <p>
|
|
10843
|
-
* <b>Directory buckets</b> -
|
|
11097
|
+
* <b>Directory buckets</b> -
|
|
11098
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
10844
11099
|
* </note>
|
|
10845
11100
|
* @public
|
|
10846
11101
|
*/
|
|
@@ -10849,7 +11104,8 @@ export interface MultipartUpload {
|
|
|
10849
11104
|
* <p>Specifies the owner of the object that is part of the multipart upload. </p>
|
|
10850
11105
|
* <note>
|
|
10851
11106
|
* <p>
|
|
10852
|
-
* <b>Directory buckets</b> - The bucket owner is
|
|
11107
|
+
* <b>Directory buckets</b> - The bucket owner is
|
|
11108
|
+
* returned as the object owner for all the objects.</p>
|
|
10853
11109
|
* </note>
|
|
10854
11110
|
* @public
|
|
10855
11111
|
*/
|
|
@@ -10885,7 +11141,7 @@ export interface ListMultipartUploadsOutput {
|
|
|
10885
11141
|
* begin. If key-marker is not specified, the upload-id-marker parameter is ignored.
|
|
10886
11142
|
* Otherwise, any multipart uploads for a key equal to the key-marker might be included in the
|
|
10887
11143
|
* list only if they have an upload ID lexicographically greater than the specified
|
|
10888
|
-
*
|
|
11144
|
+
* <code>upload-id-marker</code>.</p>
|
|
10889
11145
|
* <note>
|
|
10890
11146
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
10891
11147
|
* </note>
|
|
@@ -10985,7 +11241,8 @@ export interface ListMultipartUploadsRequest {
|
|
|
10985
11241
|
/**
|
|
10986
11242
|
* <p>The name of the bucket to which the multipart upload was initiated. </p>
|
|
10987
11243
|
* <p>
|
|
10988
|
-
* <b>Directory buckets</b> -
|
|
11244
|
+
* <b>Directory buckets</b> -
|
|
11245
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
10989
11246
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
10990
11247
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
10991
11248
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -11030,7 +11287,7 @@ export interface ListMultipartUploadsRequest {
|
|
|
11030
11287
|
* <note>
|
|
11031
11288
|
* <p>When using the URL encoding type, non-ASCII characters that are used in an object's
|
|
11032
11289
|
* key name will be percent-encoded according to UTF-8 code values. For example, the object
|
|
11033
|
-
*
|
|
11290
|
+
* <code>test_file(3).png</code> will appear as
|
|
11034
11291
|
* <code>test_file%283%29.png</code>.</p>
|
|
11035
11292
|
* </note>
|
|
11036
11293
|
* @public
|
|
@@ -11042,26 +11299,30 @@ export interface ListMultipartUploadsRequest {
|
|
|
11042
11299
|
* <ul>
|
|
11043
11300
|
* <li>
|
|
11044
11301
|
* <p>
|
|
11045
|
-
* <b>General purpose buckets</b> - For
|
|
11046
|
-
*
|
|
11047
|
-
*
|
|
11048
|
-
*
|
|
11049
|
-
*
|
|
11050
|
-
*
|
|
11051
|
-
*
|
|
11052
|
-
* upload
|
|
11053
|
-
* <code>
|
|
11302
|
+
* <b>General purpose buckets</b> - For
|
|
11303
|
+
* general purpose buckets, <code>key-marker</code> is an object key. Together with
|
|
11304
|
+
* <code>upload-id-marker</code>, this parameter specifies the multipart upload
|
|
11305
|
+
* after which listing should begin.</p>
|
|
11306
|
+
* <p>If <code>upload-id-marker</code> is not specified, only the keys
|
|
11307
|
+
* lexicographically greater than the specified <code>key-marker</code> will be
|
|
11308
|
+
* included in the list.</p>
|
|
11309
|
+
* <p>If <code>upload-id-marker</code> is specified, any multipart uploads for a key
|
|
11310
|
+
* equal to the <code>key-marker</code> might also be included, provided those
|
|
11311
|
+
* multipart uploads have upload IDs lexicographically greater than the specified
|
|
11312
|
+
* <code>upload-id-marker</code>.</p>
|
|
11054
11313
|
* </li>
|
|
11055
11314
|
* <li>
|
|
11056
11315
|
* <p>
|
|
11057
|
-
* <b>Directory buckets</b> - For
|
|
11058
|
-
*
|
|
11059
|
-
*
|
|
11060
|
-
*
|
|
11061
|
-
*
|
|
11062
|
-
*
|
|
11316
|
+
* <b>Directory buckets</b> - For
|
|
11317
|
+
* directory buckets, <code>key-marker</code> is obfuscated and isn't a real object
|
|
11318
|
+
* key. The <code>upload-id-marker</code> parameter isn't supported by
|
|
11319
|
+
* directory buckets. To list the additional multipart uploads, you only need to set
|
|
11320
|
+
* the value of <code>key-marker</code> to the <code>NextKeyMarker</code> value from
|
|
11321
|
+
* the previous response. </p>
|
|
11322
|
+
* <p>In the <code>ListMultipartUploads</code> response, the multipart uploads aren't
|
|
11323
|
+
* sorted lexicographically based on the object keys.
|
|
11063
11324
|
*
|
|
11064
|
-
*
|
|
11325
|
+
* </p>
|
|
11065
11326
|
* </li>
|
|
11066
11327
|
* </ul>
|
|
11067
11328
|
* </note>
|
|
@@ -11106,9 +11367,9 @@ export interface ListMultipartUploadsRequest {
|
|
|
11106
11367
|
/**
|
|
11107
11368
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
11108
11369
|
* owners need not specify this parameter in their requests. If either the source or
|
|
11109
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
11110
|
-
*
|
|
11111
|
-
*
|
|
11370
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
11371
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
11372
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
11112
11373
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
11113
11374
|
* <note>
|
|
11114
11375
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -11123,7 +11384,8 @@ export interface ListMultipartUploadsRequest {
|
|
|
11123
11384
|
* and how to work with archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html"> Working with archived
|
|
11124
11385
|
* objects</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
11125
11386
|
* <note>
|
|
11126
|
-
* <p>This functionality is not supported for directory buckets.
|
|
11387
|
+
* <p>This functionality is not supported for directory buckets.
|
|
11388
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
11127
11389
|
* </note>
|
|
11128
11390
|
* @public
|
|
11129
11391
|
*/
|
|
@@ -11236,7 +11498,8 @@ export interface _Object {
|
|
|
11236
11498
|
* <p>The class of storage used to store the object.</p>
|
|
11237
11499
|
* <note>
|
|
11238
11500
|
* <p>
|
|
11239
|
-
* <b>Directory buckets</b> -
|
|
11501
|
+
* <b>Directory buckets</b> -
|
|
11502
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
11240
11503
|
* </note>
|
|
11241
11504
|
* @public
|
|
11242
11505
|
*/
|
|
@@ -11245,7 +11508,8 @@ export interface _Object {
|
|
|
11245
11508
|
* <p>The owner of the object</p>
|
|
11246
11509
|
* <note>
|
|
11247
11510
|
* <p>
|
|
11248
|
-
* <b>Directory buckets</b> - The bucket owner is
|
|
11511
|
+
* <b>Directory buckets</b> - The bucket owner is
|
|
11512
|
+
* returned as the object owner.</p>
|
|
11249
11513
|
* </note>
|
|
11250
11514
|
* @public
|
|
11251
11515
|
*/
|
|
@@ -11256,7 +11520,8 @@ export interface _Object {
|
|
|
11256
11520
|
* and how to work with archived objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html"> Working with archived
|
|
11257
11521
|
* objects</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
11258
11522
|
* <note>
|
|
11259
|
-
* <p>This functionality is not supported for directory buckets.
|
|
11523
|
+
* <p>This functionality is not supported for directory buckets.
|
|
11524
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
11260
11525
|
* </note>
|
|
11261
11526
|
* @public
|
|
11262
11527
|
*/
|
|
@@ -11386,7 +11651,8 @@ export interface ListObjectsRequest {
|
|
|
11386
11651
|
/**
|
|
11387
11652
|
* <p>The name of the bucket containing the objects.</p>
|
|
11388
11653
|
* <p>
|
|
11389
|
-
* <b>Directory buckets</b> -
|
|
11654
|
+
* <b>Directory buckets</b> -
|
|
11655
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
11390
11656
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
11391
11657
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
11392
11658
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -11421,7 +11687,7 @@ export interface ListObjectsRequest {
|
|
|
11421
11687
|
* <note>
|
|
11422
11688
|
* <p>When using the URL encoding type, non-ASCII characters that are used in an object's
|
|
11423
11689
|
* key name will be percent-encoded according to UTF-8 code values. For example, the object
|
|
11424
|
-
*
|
|
11690
|
+
* <code>test_file(3).png</code> will appear as
|
|
11425
11691
|
* <code>test_file%283%29.png</code>.</p>
|
|
11426
11692
|
* </note>
|
|
11427
11693
|
* @public
|
|
@@ -11514,8 +11780,9 @@ export interface ListObjectsV2Output {
|
|
|
11514
11780
|
*/
|
|
11515
11781
|
MaxKeys?: number | undefined;
|
|
11516
11782
|
/**
|
|
11517
|
-
* <p>All of the keys (up to 1,000) that share the same prefix are grouped together. When
|
|
11518
|
-
* this group of keys is
|
|
11783
|
+
* <p>All of the keys (up to 1,000) that share the same prefix are grouped together. When
|
|
11784
|
+
* counting the total numbers of returns by this API operation, this group of keys is
|
|
11785
|
+
* considered as one item.</p>
|
|
11519
11786
|
* <p>A response can contain <code>CommonPrefixes</code> only if you specify a
|
|
11520
11787
|
* delimiter.</p>
|
|
11521
11788
|
* <p>
|
|
@@ -11537,9 +11804,12 @@ export interface ListObjectsV2Output {
|
|
|
11537
11804
|
* </li>
|
|
11538
11805
|
* <li>
|
|
11539
11806
|
* <p>
|
|
11540
|
-
* <b>Directory buckets </b> - When you query
|
|
11541
|
-
*
|
|
11542
|
-
*
|
|
11807
|
+
* <b>Directory buckets </b> - When you query
|
|
11808
|
+
* <code>ListObjectsV2</code> with a delimiter during in-progress multipart
|
|
11809
|
+
* uploads, the <code>CommonPrefixes</code> response parameter contains the prefixes
|
|
11810
|
+
* that are associated with the in-progress multipart uploads. For more information
|
|
11811
|
+
* about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in
|
|
11812
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
11543
11813
|
* </li>
|
|
11544
11814
|
* </ul>
|
|
11545
11815
|
* </note>
|
|
@@ -11567,7 +11837,9 @@ export interface ListObjectsV2Output {
|
|
|
11567
11837
|
KeyCount?: number | undefined;
|
|
11568
11838
|
/**
|
|
11569
11839
|
* <p> If <code>ContinuationToken</code> was sent with the request, it is included in the
|
|
11570
|
-
* response. You can use the returned <code>ContinuationToken</code> for pagination of the
|
|
11840
|
+
* response. You can use the returned <code>ContinuationToken</code> for pagination of the
|
|
11841
|
+
* list response. You can use this <code>ContinuationToken</code> for pagination of the list
|
|
11842
|
+
* results. </p>
|
|
11571
11843
|
* @public
|
|
11572
11844
|
*/
|
|
11573
11845
|
ContinuationToken?: string | undefined;
|
|
@@ -11604,7 +11876,8 @@ export interface ListObjectsV2Output {
|
|
|
11604
11876
|
export interface ListObjectsV2Request {
|
|
11605
11877
|
/**
|
|
11606
11878
|
* <p>
|
|
11607
|
-
* <b>Directory buckets</b> -
|
|
11879
|
+
* <b>Directory buckets</b> -
|
|
11880
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
11608
11881
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
11609
11882
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
11610
11883
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -11633,9 +11906,12 @@ export interface ListObjectsV2Request {
|
|
|
11633
11906
|
* </li>
|
|
11634
11907
|
* <li>
|
|
11635
11908
|
* <p>
|
|
11636
|
-
* <b>Directory buckets </b> - When you query
|
|
11637
|
-
*
|
|
11638
|
-
*
|
|
11909
|
+
* <b>Directory buckets </b> - When you query
|
|
11910
|
+
* <code>ListObjectsV2</code> with a delimiter during in-progress multipart
|
|
11911
|
+
* uploads, the <code>CommonPrefixes</code> response parameter contains the prefixes
|
|
11912
|
+
* that are associated with the in-progress multipart uploads. For more information
|
|
11913
|
+
* about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in
|
|
11914
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
11639
11915
|
* </li>
|
|
11640
11916
|
* </ul>
|
|
11641
11917
|
* </note>
|
|
@@ -11653,7 +11929,7 @@ export interface ListObjectsV2Request {
|
|
|
11653
11929
|
* <note>
|
|
11654
11930
|
* <p>When using the URL encoding type, non-ASCII characters that are used in an object's
|
|
11655
11931
|
* key name will be percent-encoded according to UTF-8 code values. For example, the object
|
|
11656
|
-
*
|
|
11932
|
+
* <code>test_file(3).png</code> will appear as
|
|
11657
11933
|
* <code>test_file%283%29.png</code>.</p>
|
|
11658
11934
|
* </note>
|
|
11659
11935
|
* @public
|
|
@@ -11679,7 +11955,8 @@ export interface ListObjectsV2Request {
|
|
|
11679
11955
|
* <p>
|
|
11680
11956
|
* <code>ContinuationToken</code> indicates to Amazon S3 that the list is being continued on
|
|
11681
11957
|
* this bucket with a token. <code>ContinuationToken</code> is obfuscated and is not a real
|
|
11682
|
-
* key. You can use this <code>ContinuationToken</code> for pagination of the list results.
|
|
11958
|
+
* key. You can use this <code>ContinuationToken</code> for pagination of the list results.
|
|
11959
|
+
* </p>
|
|
11683
11960
|
* @public
|
|
11684
11961
|
*/
|
|
11685
11962
|
ContinuationToken?: string | undefined;
|
|
@@ -11689,7 +11966,8 @@ export interface ListObjectsV2Request {
|
|
|
11689
11966
|
* field to <code>true</code>.</p>
|
|
11690
11967
|
* <note>
|
|
11691
11968
|
* <p>
|
|
11692
|
-
* <b>Directory buckets</b> - For directory buckets,
|
|
11969
|
+
* <b>Directory buckets</b> - For directory buckets,
|
|
11970
|
+
* the bucket owner is returned as the object owner for all objects.</p>
|
|
11693
11971
|
* </note>
|
|
11694
11972
|
* @public
|
|
11695
11973
|
*/
|
|
@@ -11961,7 +12239,7 @@ export interface ListObjectVersionsRequest {
|
|
|
11961
12239
|
* <note>
|
|
11962
12240
|
* <p>When using the URL encoding type, non-ASCII characters that are used in an object's
|
|
11963
12241
|
* key name will be percent-encoded according to UTF-8 code values. For example, the object
|
|
11964
|
-
*
|
|
12242
|
+
* <code>test_file(3).png</code> will appear as
|
|
11965
12243
|
* <code>test_file%283%29.png</code>.</p>
|
|
11966
12244
|
* </note>
|
|
11967
12245
|
* @public
|
|
@@ -12004,9 +12282,9 @@ export interface ListObjectVersionsRequest {
|
|
|
12004
12282
|
/**
|
|
12005
12283
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
12006
12284
|
* owners need not specify this parameter in their requests. If either the source or
|
|
12007
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
12008
|
-
*
|
|
12009
|
-
*
|
|
12285
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
12286
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
12287
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
12010
12288
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
12011
12289
|
* <note>
|
|
12012
12290
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -12150,8 +12428,8 @@ export interface ListPartsOutput {
|
|
|
12150
12428
|
*/
|
|
12151
12429
|
IsTruncated?: boolean | undefined;
|
|
12152
12430
|
/**
|
|
12153
|
-
* <p>Container for elements related to a particular part. A response can contain zero or
|
|
12154
|
-
*
|
|
12431
|
+
* <p>Container for elements related to a particular part. A response can contain zero or more
|
|
12432
|
+
* <code>Part</code> elements.</p>
|
|
12155
12433
|
* @public
|
|
12156
12434
|
*/
|
|
12157
12435
|
Parts?: Part[] | undefined;
|
|
@@ -12169,17 +12447,18 @@ export interface ListPartsOutput {
|
|
|
12169
12447
|
* and display name.</p>
|
|
12170
12448
|
* <note>
|
|
12171
12449
|
* <p>
|
|
12172
|
-
* <b>Directory buckets</b> - The bucket owner is
|
|
12450
|
+
* <b>Directory buckets</b> - The bucket owner is
|
|
12451
|
+
* returned as the object owner for all the parts.</p>
|
|
12173
12452
|
* </note>
|
|
12174
12453
|
* @public
|
|
12175
12454
|
*/
|
|
12176
12455
|
Owner?: Owner | undefined;
|
|
12177
12456
|
/**
|
|
12178
|
-
* <p>The class of storage used to store the uploaded
|
|
12179
|
-
* object.</p>
|
|
12457
|
+
* <p>The class of storage used to store the uploaded object.</p>
|
|
12180
12458
|
* <note>
|
|
12181
12459
|
* <p>
|
|
12182
|
-
* <b>Directory buckets</b> -
|
|
12460
|
+
* <b>Directory buckets</b> -
|
|
12461
|
+
* Only the S3 Express One Zone storage class is supported by directory buckets to store objects.</p>
|
|
12183
12462
|
* </note>
|
|
12184
12463
|
* @public
|
|
12185
12464
|
*/
|
|
@@ -12206,7 +12485,8 @@ export interface ListPartsRequest {
|
|
|
12206
12485
|
/**
|
|
12207
12486
|
* <p>The name of the bucket to which the parts are being uploaded. </p>
|
|
12208
12487
|
* <p>
|
|
12209
|
-
* <b>Directory buckets</b> -
|
|
12488
|
+
* <b>Directory buckets</b> -
|
|
12489
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
12210
12490
|
* <i>Bucket_name</i>.s3express-<i>az_id</i>.<i>region</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format <code>
|
|
12211
12491
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
12212
12492
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -12249,9 +12529,9 @@ export interface ListPartsRequest {
|
|
|
12249
12529
|
/**
|
|
12250
12530
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
12251
12531
|
* owners need not specify this parameter in their requests. If either the source or
|
|
12252
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
12253
|
-
*
|
|
12254
|
-
*
|
|
12532
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
12533
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
12534
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
12255
12535
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
12256
12536
|
* <note>
|
|
12257
12537
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -12606,19 +12886,30 @@ export interface PutBucketInventoryConfigurationRequest {
|
|
|
12606
12886
|
*/
|
|
12607
12887
|
export interface PutBucketLifecycleConfigurationOutput {
|
|
12608
12888
|
/**
|
|
12609
|
-
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
12889
|
+
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
12890
|
+
* configuration.</p>
|
|
12891
|
+
* <note>
|
|
12892
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
12893
|
+
* directory bucket lifecycle configurations.</p>
|
|
12894
|
+
* </note>
|
|
12610
12895
|
* <ul>
|
|
12611
12896
|
* <li>
|
|
12612
12897
|
* <p>
|
|
12613
|
-
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
12898
|
+
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
12899
|
+
* transition to any storage class by default. </p>
|
|
12614
12900
|
* </li>
|
|
12615
12901
|
* <li>
|
|
12616
12902
|
* <p>
|
|
12617
|
-
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
12618
|
-
*
|
|
12903
|
+
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
12904
|
+
* transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
|
|
12905
|
+
* default, all other storage classes will prevent transitions smaller than 128 KB.
|
|
12906
|
+
* </p>
|
|
12619
12907
|
* </li>
|
|
12620
12908
|
* </ul>
|
|
12621
|
-
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
12909
|
+
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
12910
|
+
* specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in
|
|
12911
|
+
* the body of your transition rule. Custom filters always take precedence over the default
|
|
12912
|
+
* transition behavior.</p>
|
|
12622
12913
|
* @public
|
|
12623
12914
|
*/
|
|
12624
12915
|
TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
|
|
@@ -12665,23 +12956,38 @@ export interface PutBucketLifecycleConfigurationRequest {
|
|
|
12665
12956
|
LifecycleConfiguration?: BucketLifecycleConfiguration | undefined;
|
|
12666
12957
|
/**
|
|
12667
12958
|
* <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
|
|
12959
|
+
* <note>
|
|
12960
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
12961
|
+
* directory bucket lifecycle configurations.</p>
|
|
12962
|
+
* </note>
|
|
12668
12963
|
* @public
|
|
12669
12964
|
*/
|
|
12670
12965
|
ExpectedBucketOwner?: string | undefined;
|
|
12671
12966
|
/**
|
|
12672
|
-
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
12967
|
+
* <p>Indicates which default minimum object size behavior is applied to the lifecycle
|
|
12968
|
+
* configuration.</p>
|
|
12969
|
+
* <note>
|
|
12970
|
+
* <p>This parameter applies to general purpose buckets only. It is not supported for
|
|
12971
|
+
* directory bucket lifecycle configurations.</p>
|
|
12972
|
+
* </note>
|
|
12673
12973
|
* <ul>
|
|
12674
12974
|
* <li>
|
|
12675
12975
|
* <p>
|
|
12676
|
-
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
12976
|
+
* <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not
|
|
12977
|
+
* transition to any storage class by default. </p>
|
|
12677
12978
|
* </li>
|
|
12678
12979
|
* <li>
|
|
12679
12980
|
* <p>
|
|
12680
|
-
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
12681
|
-
*
|
|
12981
|
+
* <code>varies_by_storage_class</code> - Objects smaller than 128 KB will
|
|
12982
|
+
* transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
|
|
12983
|
+
* default, all other storage classes will prevent transitions smaller than 128 KB.
|
|
12984
|
+
* </p>
|
|
12682
12985
|
* </li>
|
|
12683
12986
|
* </ul>
|
|
12684
|
-
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
12987
|
+
* <p>To customize the minimum object size for any transition you can add a filter that
|
|
12988
|
+
* specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in
|
|
12989
|
+
* the body of your transition rule. Custom filters always take precedence over the default
|
|
12990
|
+
* transition behavior.</p>
|
|
12685
12991
|
* @public
|
|
12686
12992
|
*/
|
|
12687
12993
|
TransitionDefaultMinimumObjectSize?: TransitionDefaultMinimumObjectSize | undefined;
|