@aws-sdk/client-s3 3.697.0 → 3.699.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 +4 -4
|
@@ -141,7 +141,8 @@ export interface PutBucketPolicyRequest {
|
|
|
141
141
|
ConfirmRemoveSelfBucketAccess?: boolean | undefined;
|
|
142
142
|
/**
|
|
143
143
|
* <p>The bucket policy as a JSON document.</p>
|
|
144
|
-
* <p>For directory buckets, the only IAM action supported in the bucket policy is
|
|
144
|
+
* <p>For directory buckets, the only IAM action supported in the bucket policy is
|
|
145
|
+
* <code>s3express:CreateSession</code>.</p>
|
|
145
146
|
* @public
|
|
146
147
|
*/
|
|
147
148
|
Policy: string | undefined;
|
|
@@ -455,15 +456,68 @@ export interface PutBucketWebsiteRequest {
|
|
|
455
456
|
*/
|
|
456
457
|
ExpectedBucketOwner?: string | undefined;
|
|
457
458
|
}
|
|
459
|
+
/**
|
|
460
|
+
* <p>
|
|
461
|
+
* The existing object was created with a different encryption type.
|
|
462
|
+
* Subsequent write requests must include the appropriate encryption
|
|
463
|
+
* parameters in the request or while creating the session.
|
|
464
|
+
* </p>
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
export declare class EncryptionTypeMismatch extends __BaseException {
|
|
468
|
+
readonly name: "EncryptionTypeMismatch";
|
|
469
|
+
readonly $fault: "client";
|
|
470
|
+
/**
|
|
471
|
+
* @internal
|
|
472
|
+
*/
|
|
473
|
+
constructor(opts: __ExceptionOptionType<EncryptionTypeMismatch, __BaseException>);
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* <p>You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:</p>
|
|
477
|
+
* <ul>
|
|
478
|
+
* <li>
|
|
479
|
+
* <p>Cannot specify both a write offset value and user-defined object metadata for existing objects.</p>
|
|
480
|
+
* </li>
|
|
481
|
+
* <li>
|
|
482
|
+
* <p>Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.</p>
|
|
483
|
+
* </li>
|
|
484
|
+
* <li>
|
|
485
|
+
* <p>Request body cannot be empty when 'write offset' is specified.</p>
|
|
486
|
+
* </li>
|
|
487
|
+
* </ul>
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
export declare class InvalidRequest extends __BaseException {
|
|
491
|
+
readonly name: "InvalidRequest";
|
|
492
|
+
readonly $fault: "client";
|
|
493
|
+
/**
|
|
494
|
+
* @internal
|
|
495
|
+
*/
|
|
496
|
+
constructor(opts: __ExceptionOptionType<InvalidRequest, __BaseException>);
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* <p>
|
|
500
|
+
* The write offset value that you specified does not match the current object size.
|
|
501
|
+
* </p>
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
export declare class InvalidWriteOffset extends __BaseException {
|
|
505
|
+
readonly name: "InvalidWriteOffset";
|
|
506
|
+
readonly $fault: "client";
|
|
507
|
+
/**
|
|
508
|
+
* @internal
|
|
509
|
+
*/
|
|
510
|
+
constructor(opts: __ExceptionOptionType<InvalidWriteOffset, __BaseException>);
|
|
511
|
+
}
|
|
458
512
|
/**
|
|
459
513
|
* @public
|
|
460
514
|
*/
|
|
461
515
|
export interface PutObjectOutput {
|
|
462
516
|
/**
|
|
463
|
-
* <p>If the expiration is configured for the object (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>) in the <i>Amazon S3 User Guide</i>,
|
|
464
|
-
* includes the <code>expiry-date</code> and
|
|
465
|
-
*
|
|
466
|
-
* URL-encoded.</p>
|
|
517
|
+
* <p>If the expiration is configured for the object (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a>) in the <i>Amazon S3 User Guide</i>,
|
|
518
|
+
* the response includes this header. It includes the <code>expiry-date</code> and
|
|
519
|
+
* <code>rule-id</code> key-value pairs that provide information about object expiration.
|
|
520
|
+
* The value of the <code>rule-id</code> is URL-encoded.</p>
|
|
467
521
|
* <note>
|
|
468
522
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
469
523
|
* </note>
|
|
@@ -473,12 +527,13 @@ export interface PutObjectOutput {
|
|
|
473
527
|
/**
|
|
474
528
|
* <p>Entity tag for the uploaded object.</p>
|
|
475
529
|
* <p>
|
|
476
|
-
* <b>General purpose buckets </b> - To ensure that data is not
|
|
477
|
-
* for objects where the
|
|
478
|
-
*
|
|
479
|
-
*
|
|
530
|
+
* <b>General purpose buckets </b> - To ensure that data is not
|
|
531
|
+
* corrupted traversing the network, for objects where the ETag is the MD5 digest of the
|
|
532
|
+
* object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned
|
|
533
|
+
* ETag to the calculated MD5 value.</p>
|
|
480
534
|
* <p>
|
|
481
|
-
* <b>Directory buckets </b> - The ETag for the object in
|
|
535
|
+
* <b>Directory buckets </b> - The ETag for the object in
|
|
536
|
+
* a directory bucket isn't the MD5 digest of the object.</p>
|
|
482
537
|
* @public
|
|
483
538
|
*/
|
|
484
539
|
ETag?: string | undefined;
|
|
@@ -525,10 +580,9 @@ export interface PutObjectOutput {
|
|
|
525
580
|
* for the object being stored. Amazon S3 returns this ID in the response. When you enable
|
|
526
581
|
* versioning for a bucket, if Amazon S3 receives multiple write requests for the same object
|
|
527
582
|
* simultaneously, it stores all of the objects. For more information about versioning, see
|
|
528
|
-
*
|
|
529
|
-
* Versioning-Enabled Buckets</a> in the <i>Amazon S3
|
|
530
|
-
*
|
|
531
|
-
* of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
583
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to
|
|
584
|
+
* Versioning-Enabled Buckets</a> in the <i>Amazon S3 User Guide</i>. For
|
|
585
|
+
* information about returning the versioning state of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
532
586
|
* <note>
|
|
533
587
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
534
588
|
* </note>
|
|
@@ -546,8 +600,8 @@ export interface PutObjectOutput {
|
|
|
546
600
|
SSECustomerAlgorithm?: string | undefined;
|
|
547
601
|
/**
|
|
548
602
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
549
|
-
* response will include this header to provide the round-trip message integrity verification
|
|
550
|
-
* the customer-provided encryption key.</p>
|
|
603
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
604
|
+
* of the customer-provided encryption key.</p>
|
|
551
605
|
* <note>
|
|
552
606
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
553
607
|
* </note>
|
|
@@ -574,6 +628,16 @@ export interface PutObjectOutput {
|
|
|
574
628
|
* @public
|
|
575
629
|
*/
|
|
576
630
|
BucketKeyEnabled?: boolean | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* <p>
|
|
633
|
+
* The size of the object in bytes. This will only be present if you append to an object.
|
|
634
|
+
* </p>
|
|
635
|
+
* <note>
|
|
636
|
+
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
|
|
637
|
+
* </note>
|
|
638
|
+
* @public
|
|
639
|
+
*/
|
|
640
|
+
Size?: number | undefined;
|
|
577
641
|
/**
|
|
578
642
|
* <p>If present, indicates that the requester was successfully charged for the
|
|
579
643
|
* request.</p>
|
|
@@ -590,7 +654,7 @@ export interface PutObjectOutput {
|
|
|
590
654
|
export interface PutObjectRequest {
|
|
591
655
|
/**
|
|
592
656
|
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
593
|
-
*
|
|
657
|
+
* ACL</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
594
658
|
* <p>When adding a new object, you can use headers to grant ACL-based permissions to
|
|
595
659
|
* individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are
|
|
596
660
|
* then added to the ACL on the object. By default, all objects are private. Only the owner
|
|
@@ -603,7 +667,7 @@ export interface PutObjectRequest {
|
|
|
603
667
|
* specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code>
|
|
604
668
|
* canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that
|
|
605
669
|
* contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a
|
|
606
|
-
*
|
|
670
|
+
* <code>400</code> error with the error code <code>AccessControlListNotSupported</code>.
|
|
607
671
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of
|
|
608
672
|
* objects and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
609
673
|
* <note>
|
|
@@ -627,7 +691,8 @@ export interface PutObjectRequest {
|
|
|
627
691
|
/**
|
|
628
692
|
* <p>The bucket name to which the PUT action was initiated. </p>
|
|
629
693
|
* <p>
|
|
630
|
-
* <b>Directory buckets</b> -
|
|
694
|
+
* <b>Directory buckets</b> -
|
|
695
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
631
696
|
* <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>
|
|
632
697
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
633
698
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -682,10 +747,10 @@ export interface PutObjectRequest {
|
|
|
682
747
|
* Content-MD5 mechanism as an end-to-end integrity check. For more information about REST
|
|
683
748
|
* request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a>.</p>
|
|
684
749
|
* <note>
|
|
685
|
-
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
*
|
|
750
|
+
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
751
|
+
* required for any request to upload an object with a retention period configured using
|
|
752
|
+
* Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the
|
|
753
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
689
754
|
* </note>
|
|
690
755
|
* <note>
|
|
691
756
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -738,10 +803,10 @@ export interface PutObjectRequest {
|
|
|
738
803
|
* <code>ChecksumAlgorithm</code> parameter and uses the checksum algorithm that matches the provided value in <code>x-amz-checksum-<i>algorithm</i>
|
|
739
804
|
* </code>.</p>
|
|
740
805
|
* <note>
|
|
741
|
-
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
742
|
-
*
|
|
743
|
-
*
|
|
744
|
-
*
|
|
806
|
+
* <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is
|
|
807
|
+
* required for any request to upload an object with a retention period configured using
|
|
808
|
+
* Amazon S3 Object Lock. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object">Uploading objects to an Object Lock enabled bucket </a> in the
|
|
809
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
745
810
|
* </note>
|
|
746
811
|
* <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>
|
|
747
812
|
* @public
|
|
@@ -786,8 +851,11 @@ export interface PutObjectRequest {
|
|
|
786
851
|
*/
|
|
787
852
|
Expires?: Date | undefined;
|
|
788
853
|
/**
|
|
789
|
-
* <p>Uploads the object only if the object key name does not already exist in the bucket
|
|
790
|
-
*
|
|
854
|
+
* <p>Uploads the object only if the object key name does not already exist in the bucket
|
|
855
|
+
* specified. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error.</p>
|
|
856
|
+
* <p>If a conflicting operation occurs during the upload S3 returns a <code>409
|
|
857
|
+
* ConditionalRequestConflict</code> response. On a 409 failure you should retry the
|
|
858
|
+
* upload.</p>
|
|
791
859
|
* <p>Expects the '*' (asterisk) character.</p>
|
|
792
860
|
* <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>
|
|
793
861
|
* @public
|
|
@@ -858,33 +926,46 @@ export interface PutObjectRequest {
|
|
|
858
926
|
* @public
|
|
859
927
|
*/
|
|
860
928
|
Key: string | undefined;
|
|
929
|
+
/**
|
|
930
|
+
* <p>
|
|
931
|
+
* Specifies the offset for appending data to existing objects in bytes.
|
|
932
|
+
* The offset must be equal to the size of the existing object being appended to.
|
|
933
|
+
* If no object exists, setting this header to 0 will create a new object.
|
|
934
|
+
* </p>
|
|
935
|
+
* <note>
|
|
936
|
+
* <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p>
|
|
937
|
+
* </note>
|
|
938
|
+
* @public
|
|
939
|
+
*/
|
|
940
|
+
WriteOffsetBytes?: number | undefined;
|
|
861
941
|
/**
|
|
862
942
|
* <p>A map of metadata to store with the object in S3.</p>
|
|
863
943
|
* @public
|
|
864
944
|
*/
|
|
865
945
|
Metadata?: Record<string, string> | undefined;
|
|
866
946
|
/**
|
|
867
|
-
* <p>The server-side encryption algorithm that was used when you store this object in Amazon S3
|
|
868
|
-
*
|
|
947
|
+
* <p>The server-side encryption algorithm that was used when you store this object in Amazon S3
|
|
948
|
+
* (for example, <code>AES256</code>, <code>aws:kms</code>, <code>aws:kms:dsse</code>).</p>
|
|
869
949
|
* <ul>
|
|
870
950
|
* <li>
|
|
871
951
|
* <p>
|
|
872
|
-
* <b>General purpose buckets </b> - You have four mutually
|
|
873
|
-
*
|
|
874
|
-
*
|
|
875
|
-
*
|
|
876
|
-
*
|
|
877
|
-
*
|
|
878
|
-
*
|
|
879
|
-
*
|
|
952
|
+
* <b>General purpose buckets </b> - You have four mutually
|
|
953
|
+
* exclusive options to protect data using server-side encryption in Amazon S3, depending on
|
|
954
|
+
* how you choose to manage the encryption keys. Specifically, the encryption key
|
|
955
|
+
* options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and
|
|
956
|
+
* customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by
|
|
957
|
+
* using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt
|
|
958
|
+
* data at rest by using server-side encryption with other key options. For more
|
|
959
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side
|
|
960
|
+
* Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
880
961
|
* </li>
|
|
881
962
|
* <li>
|
|
882
963
|
* <p>
|
|
883
|
-
* <b>Directory buckets </b> -
|
|
964
|
+
* <b>Directory buckets </b> -
|
|
965
|
+
* 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
|
|
884
966
|
* <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects
|
|
885
967
|
* are automatically encrypted with the desired encryption settings. For more
|
|
886
|
-
* 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>.
|
|
887
|
-
* </p>
|
|
968
|
+
* 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>
|
|
888
969
|
* <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.
|
|
889
970
|
* 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.
|
|
890
971
|
* You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and
|
|
@@ -906,16 +987,17 @@ export interface PutObjectRequest {
|
|
|
906
987
|
/**
|
|
907
988
|
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The
|
|
908
989
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
909
|
-
* performance needs, you can specify a different Storage Class. For more information, see
|
|
910
|
-
* <
|
|
990
|
+
* performance needs, you can specify a different Storage Class. For more information, see
|
|
991
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
992
|
+
* Classes</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
911
993
|
* <note>
|
|
912
994
|
* <ul>
|
|
913
995
|
* <li>
|
|
914
|
-
* <p>For directory buckets, only the S3 Express One Zone storage class is supported to store
|
|
996
|
+
* <p>For directory buckets, only the S3 Express One Zone storage class is supported to store
|
|
997
|
+
* newly created objects.</p>
|
|
915
998
|
* </li>
|
|
916
999
|
* <li>
|
|
917
|
-
* <p>Amazon S3 on Outposts only uses
|
|
918
|
-
* the OUTPOSTS Storage Class.</p>
|
|
1000
|
+
* <p>Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.</p>
|
|
919
1001
|
* </li>
|
|
920
1002
|
* </ul>
|
|
921
1003
|
* </note>
|
|
@@ -925,8 +1007,8 @@ export interface PutObjectRequest {
|
|
|
925
1007
|
/**
|
|
926
1008
|
* <p>If the bucket is configured as a website, redirects requests for this object to another
|
|
927
1009
|
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
|
|
928
|
-
* the object metadata. For information about object metadata, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the
|
|
929
|
-
*
|
|
1010
|
+
* the object metadata. For information about object metadata, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html">Object Key and Metadata</a> in the
|
|
1011
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
930
1012
|
* <p>In the following example, the request header sets the redirect to an object
|
|
931
1013
|
* (anotherPage.html) in the same bucket:</p>
|
|
932
1014
|
* <p>
|
|
@@ -939,8 +1021,7 @@ export interface PutObjectRequest {
|
|
|
939
1021
|
* </p>
|
|
940
1022
|
* <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and
|
|
941
1023
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to
|
|
942
|
-
*
|
|
943
|
-
* User Guide</i>. </p>
|
|
1024
|
+
* Configure Website Page Redirects</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
944
1025
|
* <note>
|
|
945
1026
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
946
1027
|
* </note>
|
|
@@ -949,7 +1030,7 @@ export interface PutObjectRequest {
|
|
|
949
1030
|
WebsiteRedirectLocation?: string | undefined;
|
|
950
1031
|
/**
|
|
951
1032
|
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
952
|
-
*
|
|
1033
|
+
* <code>AES256</code>).</p>
|
|
953
1034
|
* <note>
|
|
954
1035
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
955
1036
|
* </note>
|
|
@@ -1029,9 +1110,9 @@ export interface PutObjectRequest {
|
|
|
1029
1110
|
/**
|
|
1030
1111
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1031
1112
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1032
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1033
|
-
*
|
|
1034
|
-
*
|
|
1113
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1114
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1115
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1035
1116
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1036
1117
|
* <note>
|
|
1037
1118
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -1067,7 +1148,8 @@ export interface PutObjectRequest {
|
|
|
1067
1148
|
ObjectLockRetainUntilDate?: Date | undefined;
|
|
1068
1149
|
/**
|
|
1069
1150
|
* <p>Specifies whether a legal hold will be applied to this object. For more information
|
|
1070
|
-
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in the
|
|
1151
|
+
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object Lock</a> in the
|
|
1152
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1071
1153
|
* <note>
|
|
1072
1154
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
1073
1155
|
* </note>
|
|
@@ -1080,6 +1162,22 @@ export interface PutObjectRequest {
|
|
|
1080
1162
|
*/
|
|
1081
1163
|
ExpectedBucketOwner?: string | undefined;
|
|
1082
1164
|
}
|
|
1165
|
+
/**
|
|
1166
|
+
* <p>
|
|
1167
|
+
* You have attempted to add more parts than the maximum of 10000
|
|
1168
|
+
* that are allowed for this object. You can use the CopyObject operation
|
|
1169
|
+
* to copy this object to another and then add more data to the newly copied object.
|
|
1170
|
+
* </p>
|
|
1171
|
+
* @public
|
|
1172
|
+
*/
|
|
1173
|
+
export declare class TooManyParts extends __BaseException {
|
|
1174
|
+
readonly name: "TooManyParts";
|
|
1175
|
+
readonly $fault: "client";
|
|
1176
|
+
/**
|
|
1177
|
+
* @internal
|
|
1178
|
+
*/
|
|
1179
|
+
constructor(opts: __ExceptionOptionType<TooManyParts, __BaseException>);
|
|
1180
|
+
}
|
|
1083
1181
|
/**
|
|
1084
1182
|
* @public
|
|
1085
1183
|
*/
|
|
@@ -1182,9 +1280,9 @@ export interface PutObjectAclRequest {
|
|
|
1182
1280
|
/**
|
|
1183
1281
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1184
1282
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1185
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1186
|
-
*
|
|
1187
|
-
*
|
|
1283
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1284
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1285
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1188
1286
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1189
1287
|
* <note>
|
|
1190
1288
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -1247,9 +1345,9 @@ export interface PutObjectLegalHoldRequest {
|
|
|
1247
1345
|
/**
|
|
1248
1346
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1249
1347
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1250
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1348
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1349
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1350
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1253
1351
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1254
1352
|
* <note>
|
|
1255
1353
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -1318,9 +1416,9 @@ export interface PutObjectLockConfigurationRequest {
|
|
|
1318
1416
|
/**
|
|
1319
1417
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1320
1418
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1321
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1419
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1420
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1421
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1324
1422
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1325
1423
|
* <note>
|
|
1326
1424
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -1398,9 +1496,9 @@ export interface PutObjectRetentionRequest {
|
|
|
1398
1496
|
/**
|
|
1399
1497
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1400
1498
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1401
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1402
|
-
*
|
|
1403
|
-
*
|
|
1499
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1500
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1501
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1404
1502
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1405
1503
|
* <note>
|
|
1406
1504
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -1508,9 +1606,9 @@ export interface PutObjectTaggingRequest {
|
|
|
1508
1606
|
/**
|
|
1509
1607
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
1510
1608
|
* owners need not specify this parameter in their requests. If either the source or
|
|
1511
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
1512
|
-
*
|
|
1513
|
-
*
|
|
1609
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
1610
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
1611
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
1514
1612
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1515
1613
|
* <note>
|
|
1516
1614
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -2088,9 +2186,9 @@ export interface RestoreObjectRequest {
|
|
|
2088
2186
|
/**
|
|
2089
2187
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
2090
2188
|
* owners need not specify this parameter in their requests. If either the source or
|
|
2091
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
2092
|
-
*
|
|
2093
|
-
*
|
|
2189
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
2190
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
2191
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
2094
2192
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2095
2193
|
* <note>
|
|
2096
2194
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -2460,8 +2558,8 @@ export interface SelectObjectContentRequest {
|
|
|
2460
2558
|
*/
|
|
2461
2559
|
export interface UploadPartOutput {
|
|
2462
2560
|
/**
|
|
2463
|
-
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2464
|
-
*
|
|
2561
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2562
|
+
* example, <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
2465
2563
|
* @public
|
|
2466
2564
|
*/
|
|
2467
2565
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
@@ -2513,8 +2611,8 @@ export interface UploadPartOutput {
|
|
|
2513
2611
|
SSECustomerAlgorithm?: string | undefined;
|
|
2514
2612
|
/**
|
|
2515
2613
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
2516
|
-
* response will include this header to provide the round-trip message integrity verification
|
|
2517
|
-
* the customer-provided encryption key.</p>
|
|
2614
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
2615
|
+
* of the customer-provided encryption key.</p>
|
|
2518
2616
|
* <note>
|
|
2519
2617
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2520
2618
|
* </note>
|
|
@@ -2554,7 +2652,8 @@ export interface UploadPartRequest {
|
|
|
2554
2652
|
/**
|
|
2555
2653
|
* <p>The name of the bucket to which the multipart upload was initiated.</p>
|
|
2556
2654
|
* <p>
|
|
2557
|
-
* <b>Directory buckets</b> -
|
|
2655
|
+
* <b>Directory buckets</b> -
|
|
2656
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
2558
2657
|
* <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>
|
|
2559
2658
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
2560
2659
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -2651,8 +2750,7 @@ export interface UploadPartRequest {
|
|
|
2651
2750
|
*/
|
|
2652
2751
|
UploadId: string | undefined;
|
|
2653
2752
|
/**
|
|
2654
|
-
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
2655
|
-
* AES256).</p>
|
|
2753
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>
|
|
2656
2754
|
* <note>
|
|
2657
2755
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2658
2756
|
* </note>
|
|
@@ -2684,9 +2782,9 @@ export interface UploadPartRequest {
|
|
|
2684
2782
|
/**
|
|
2685
2783
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
2686
2784
|
* owners need not specify this parameter in their requests. If either the source or
|
|
2687
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
2688
|
-
*
|
|
2689
|
-
*
|
|
2785
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
2786
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
2787
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
2690
2788
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
2691
2789
|
* <note>
|
|
2692
2790
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -2767,8 +2865,8 @@ export interface UploadPartCopyOutput {
|
|
|
2767
2865
|
*/
|
|
2768
2866
|
CopyPartResult?: CopyPartResult | undefined;
|
|
2769
2867
|
/**
|
|
2770
|
-
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2771
|
-
*
|
|
2868
|
+
* <p>The server-side encryption algorithm used when you store this object in Amazon S3 (for
|
|
2869
|
+
* example, <code>AES256</code>, <code>aws:kms</code>).</p>
|
|
2772
2870
|
* @public
|
|
2773
2871
|
*/
|
|
2774
2872
|
ServerSideEncryption?: ServerSideEncryption | undefined;
|
|
@@ -2783,8 +2881,8 @@ export interface UploadPartCopyOutput {
|
|
|
2783
2881
|
SSECustomerAlgorithm?: string | undefined;
|
|
2784
2882
|
/**
|
|
2785
2883
|
* <p>If server-side encryption with a customer-provided encryption key was requested, the
|
|
2786
|
-
* response will include this header to provide the round-trip message integrity verification
|
|
2787
|
-
* the customer-provided encryption key.</p>
|
|
2884
|
+
* response will include this header to provide the round-trip message integrity verification
|
|
2885
|
+
* of the customer-provided encryption key.</p>
|
|
2788
2886
|
* <note>
|
|
2789
2887
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
2790
2888
|
* </note>
|
|
@@ -2819,7 +2917,8 @@ export interface UploadPartCopyRequest {
|
|
|
2819
2917
|
/**
|
|
2820
2918
|
* <p>The bucket name.</p>
|
|
2821
2919
|
* <p>
|
|
2822
|
-
* <b>Directory buckets</b> -
|
|
2920
|
+
* <b>Directory buckets</b> -
|
|
2921
|
+
* When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code>
|
|
2823
2922
|
* <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>
|
|
2824
2923
|
* <i>bucket_base_name</i>--<i>az-id</i>--x-s3</code> (for example, <code>
|
|
2825
2924
|
* <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming
|
|
@@ -2864,38 +2963,37 @@ export interface UploadPartCopyRequest {
|
|
|
2864
2963
|
* <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>
|
|
2865
2964
|
* </li>
|
|
2866
2965
|
* </ul>
|
|
2867
|
-
* <p>If your bucket has versioning enabled, you could have multiple versions of the
|
|
2868
|
-
*
|
|
2869
|
-
* version of the source object to copy
|
|
2870
|
-
*
|
|
2871
|
-
*
|
|
2872
|
-
*
|
|
2873
|
-
*
|
|
2874
|
-
*
|
|
2875
|
-
*
|
|
2876
|
-
*
|
|
2877
|
-
* <code>
|
|
2878
|
-
*
|
|
2879
|
-
* as a version for the <code>x-amz-copy-source</code>. </p>
|
|
2966
|
+
* <p>If your bucket has versioning enabled, you could have multiple versions of the same
|
|
2967
|
+
* object. By default, <code>x-amz-copy-source</code> identifies the current version of the
|
|
2968
|
+
* source object to copy. To copy a specific version of the source object to copy, append
|
|
2969
|
+
* <code>?versionId=<version-id></code> to the <code>x-amz-copy-source</code> request
|
|
2970
|
+
* header (for example, <code>x-amz-copy-source:
|
|
2971
|
+
* /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>). </p>
|
|
2972
|
+
* <p>If the current version is a delete marker and you don't specify a versionId in the
|
|
2973
|
+
* <code>x-amz-copy-source</code> request header, Amazon S3 returns a <code>404 Not Found</code>
|
|
2974
|
+
* error, because the object does not exist. If you specify versionId in the
|
|
2975
|
+
* <code>x-amz-copy-source</code> and the versionId is a delete marker, Amazon S3 returns an
|
|
2976
|
+
* HTTP <code>400 Bad Request</code> error, because you are not allowed to specify a delete
|
|
2977
|
+
* marker as a version for the <code>x-amz-copy-source</code>. </p>
|
|
2880
2978
|
* <note>
|
|
2881
2979
|
* <p>
|
|
2882
|
-
* <b>Directory buckets</b> -
|
|
2980
|
+
* <b>Directory buckets</b> -
|
|
2981
|
+
* S3 Versioning isn't enabled and supported for directory buckets.</p>
|
|
2883
2982
|
* </note>
|
|
2884
2983
|
* @public
|
|
2885
2984
|
*/
|
|
2886
2985
|
CopySource: string | undefined;
|
|
2887
2986
|
/**
|
|
2888
2987
|
* <p>Copies the object if its entity tag (ETag) matches the specified tag.</p>
|
|
2889
|
-
* <p>If both of the
|
|
2890
|
-
*
|
|
2891
|
-
*
|
|
2892
|
-
* request as follows:</p>
|
|
2988
|
+
* <p>If both of the <code>x-amz-copy-source-if-match</code> and
|
|
2989
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as
|
|
2990
|
+
* follows:</p>
|
|
2893
2991
|
* <p>
|
|
2894
2992
|
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
2895
2993
|
* and;</p>
|
|
2896
2994
|
* <p>
|
|
2897
2995
|
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
2898
|
-
*
|
|
2996
|
+
* <code>false</code>;</p>
|
|
2899
2997
|
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
2900
2998
|
* </p>
|
|
2901
2999
|
* @public
|
|
@@ -2903,16 +3001,15 @@ export interface UploadPartCopyRequest {
|
|
|
2903
3001
|
CopySourceIfMatch?: string | undefined;
|
|
2904
3002
|
/**
|
|
2905
3003
|
* <p>Copies the object if it has been modified since the specified time.</p>
|
|
2906
|
-
* <p>If both of the
|
|
2907
|
-
*
|
|
2908
|
-
*
|
|
2909
|
-
* request as follows:</p>
|
|
3004
|
+
* <p>If both of the <code>x-amz-copy-source-if-none-match</code> and
|
|
3005
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as
|
|
3006
|
+
* follows:</p>
|
|
2910
3007
|
* <p>
|
|
2911
|
-
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
2912
|
-
*
|
|
3008
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>,
|
|
3009
|
+
* and;</p>
|
|
2913
3010
|
* <p>
|
|
2914
3011
|
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
2915
|
-
*
|
|
3012
|
+
* <code>true</code>;</p>
|
|
2916
3013
|
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
2917
3014
|
* </p>
|
|
2918
3015
|
* @public
|
|
@@ -2920,16 +3017,15 @@ export interface UploadPartCopyRequest {
|
|
|
2920
3017
|
CopySourceIfModifiedSince?: Date | undefined;
|
|
2921
3018
|
/**
|
|
2922
3019
|
* <p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>
|
|
2923
|
-
* <p>If both of the
|
|
2924
|
-
*
|
|
2925
|
-
*
|
|
2926
|
-
* request as follows:</p>
|
|
3020
|
+
* <p>If both of the <code>x-amz-copy-source-if-none-match</code> and
|
|
3021
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request as
|
|
3022
|
+
* follows:</p>
|
|
2927
3023
|
* <p>
|
|
2928
|
-
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
2929
|
-
*
|
|
3024
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to <code>false</code>,
|
|
3025
|
+
* and;</p>
|
|
2930
3026
|
* <p>
|
|
2931
3027
|
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
|
|
2932
|
-
*
|
|
3028
|
+
* <code>true</code>;</p>
|
|
2933
3029
|
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
|
|
2934
3030
|
* </p>
|
|
2935
3031
|
* @public
|
|
@@ -2937,16 +3033,15 @@ export interface UploadPartCopyRequest {
|
|
|
2937
3033
|
CopySourceIfNoneMatch?: string | undefined;
|
|
2938
3034
|
/**
|
|
2939
3035
|
* <p>Copies the object if it hasn't been modified since the specified time.</p>
|
|
2940
|
-
* <p>If both of the
|
|
2941
|
-
*
|
|
2942
|
-
*
|
|
2943
|
-
* request as follows:</p>
|
|
3036
|
+
* <p>If both of the <code>x-amz-copy-source-if-match</code> and
|
|
3037
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the request as
|
|
3038
|
+
* follows:</p>
|
|
2944
3039
|
* <p>
|
|
2945
3040
|
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
|
|
2946
3041
|
* and;</p>
|
|
2947
3042
|
* <p>
|
|
2948
3043
|
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
|
|
2949
|
-
*
|
|
3044
|
+
* <code>false</code>;</p>
|
|
2950
3045
|
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
2951
3046
|
* </p>
|
|
2952
3047
|
* @public
|
|
@@ -2977,8 +3072,7 @@ export interface UploadPartCopyRequest {
|
|
|
2977
3072
|
*/
|
|
2978
3073
|
UploadId: string | undefined;
|
|
2979
3074
|
/**
|
|
2980
|
-
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
2981
|
-
* AES256).</p>
|
|
3075
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example, AES256).</p>
|
|
2982
3076
|
* <note>
|
|
2983
3077
|
* <p>This functionality is not supported when the destination bucket is a directory bucket.</p>
|
|
2984
3078
|
* </note>
|
|
@@ -3009,7 +3103,7 @@ export interface UploadPartCopyRequest {
|
|
|
3009
3103
|
SSECustomerKeyMD5?: string | undefined;
|
|
3010
3104
|
/**
|
|
3011
3105
|
* <p>Specifies the algorithm to use when decrypting the source object (for example,
|
|
3012
|
-
*
|
|
3106
|
+
* <code>AES256</code>).</p>
|
|
3013
3107
|
* <note>
|
|
3014
3108
|
* <p>This functionality is not supported when the source object is in a directory bucket.</p>
|
|
3015
3109
|
* </note>
|
|
@@ -3039,9 +3133,9 @@ export interface UploadPartCopyRequest {
|
|
|
3039
3133
|
/**
|
|
3040
3134
|
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
|
|
3041
3135
|
* owners need not specify this parameter in their requests. If either the source or
|
|
3042
|
-
* destination S3 bucket has Requester Pays enabled, the requester will pay for
|
|
3043
|
-
*
|
|
3044
|
-
*
|
|
3136
|
+
* destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
|
|
3137
|
+
* charges to copy the object. For information about downloading objects from Requester Pays
|
|
3138
|
+
* buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
|
|
3045
3139
|
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3046
3140
|
* <note>
|
|
3047
3141
|
* <p>This functionality is not supported for directory buckets.</p>
|
|
@@ -3368,8 +3462,9 @@ export interface WriteGetObjectResponseRequest {
|
|
|
3368
3462
|
*/
|
|
3369
3463
|
SSECustomerAlgorithm?: string | undefined;
|
|
3370
3464
|
/**
|
|
3371
|
-
* <p> If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key
|
|
3372
|
-
* encryption customer managed key that was used for stored in
|
|
3465
|
+
* <p> If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key
|
|
3466
|
+
* Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in
|
|
3467
|
+
* Amazon S3 object. </p>
|
|
3373
3468
|
* @public
|
|
3374
3469
|
*/
|
|
3375
3470
|
SSEKMSKeyId?: string | undefined;
|