@aws-sdk/client-s3 3.258.0 → 3.261.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restXml.js +1 -1
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restXml.js +1 -1
- package/dist-types/S3.d.ts +41 -356
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +0 -3
- package/dist-types/commands/CopyObjectCommand.d.ts +0 -2
- package/dist-types/commands/CreateBucketCommand.d.ts +0 -1
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +0 -12
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +0 -3
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +0 -2
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +0 -1
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +0 -3
- package/dist-types/commands/DeleteObjectCommand.d.ts +0 -5
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +0 -3
- package/dist-types/commands/DeleteObjectsCommand.d.ts +0 -5
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketAclCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketCorsCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/GetBucketLocationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +0 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +0 -4
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +0 -2
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +0 -5
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +0 -2
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +0 -2
- package/dist-types/commands/GetObjectAclCommand.d.ts +1 -1
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +40 -46
- package/dist-types/commands/GetObjectCommand.d.ts +0 -20
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +0 -1
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +0 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +0 -4
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +0 -3
- package/dist-types/commands/HeadBucketCommand.d.ts +0 -5
- package/dist-types/commands/HeadObjectCommand.d.ts +0 -7
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +0 -4
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +0 -4
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +0 -4
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +0 -5
- package/dist-types/commands/ListObjectsCommand.d.ts +0 -2
- package/dist-types/commands/ListObjectsV2Command.d.ts +0 -4
- package/dist-types/commands/ListPartsCommand.d.ts +0 -3
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +0 -8
- package/dist-types/commands/PutBucketAclCommand.d.ts +0 -7
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +0 -11
- package/dist-types/commands/PutBucketCorsCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +0 -2
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +0 -15
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +0 -9
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +0 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +0 -8
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +0 -3
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +0 -8
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +0 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +0 -4
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +0 -6
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +0 -4
- package/dist-types/commands/PutObjectAclCommand.d.ts +0 -3
- package/dist-types/commands/PutObjectCommand.d.ts +0 -8
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +0 -12
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +0 -6
- package/dist-types/commands/RestoreObjectCommand.d.ts +0 -1
- package/dist-types/commands/SelectObjectContentCommand.d.ts +0 -3
- package/dist-types/commands/UploadPartCommand.d.ts +0 -18
- package/dist-types/commands/UploadPartCopyCommand.d.ts +0 -10
- package/dist-types/models/models_0.d.ts +21 -50
- package/dist-types/models/models_1.d.ts +52 -53
- package/package.json +12 -12
package/dist-types/S3.d.ts
CHANGED
|
@@ -167,8 +167,6 @@ export declare class S3 extends S3Client {
|
|
|
167
167
|
* Upload</a>.</p>
|
|
168
168
|
* <p>For information about permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
169
169
|
* Permissions</a>.</p>
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
170
|
* <p>
|
|
173
171
|
* <code>CompleteMultipartUpload</code> has the following special errors:</p>
|
|
174
172
|
* <ul>
|
|
@@ -227,7 +225,6 @@ export declare class S3 extends S3Client {
|
|
|
227
225
|
* </ul>
|
|
228
226
|
* </li>
|
|
229
227
|
* </ul>
|
|
230
|
-
*
|
|
231
228
|
* <p>The following operations are related to <code>CompleteMultipartUpload</code>:</p>
|
|
232
229
|
* <ul>
|
|
233
230
|
* <li>
|
|
@@ -351,7 +348,6 @@ export declare class S3 extends S3Client {
|
|
|
351
348
|
* false</p>
|
|
352
349
|
* </li>
|
|
353
350
|
* </ul>
|
|
354
|
-
*
|
|
355
351
|
* <p>If both the <code>x-amz-copy-source-if-none-match</code> and
|
|
356
352
|
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the request and
|
|
357
353
|
* evaluate as follows, Amazon S3 returns the <code>412 Precondition Failed</code> response
|
|
@@ -367,7 +363,6 @@ export declare class S3 extends S3Client {
|
|
|
367
363
|
* true</p>
|
|
368
364
|
* </li>
|
|
369
365
|
* </ul>
|
|
370
|
-
*
|
|
371
366
|
* <note>
|
|
372
367
|
* <p>All headers with the <code>x-amz-</code> prefix, including
|
|
373
368
|
* <code>x-amz-copy-source</code>, must be signed.</p>
|
|
@@ -558,7 +553,6 @@ export declare class S3 extends S3Client {
|
|
|
558
553
|
* <p>You can use either a canned ACL or specify access permissions explicitly. You cannot
|
|
559
554
|
* do both.</p>
|
|
560
555
|
* </note>
|
|
561
|
-
*
|
|
562
556
|
* <p>
|
|
563
557
|
* <b>Permissions</b>
|
|
564
558
|
* </p>
|
|
@@ -609,32 +603,26 @@ export declare class S3 extends S3Client {
|
|
|
609
603
|
* upload ID in each of your subsequent upload part requests (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>). You also include this
|
|
610
604
|
* upload ID in the final request to either complete or abort the multipart upload
|
|
611
605
|
* request.</p>
|
|
612
|
-
*
|
|
613
606
|
* <p>For more information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a>.</p>
|
|
614
|
-
*
|
|
615
607
|
* <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the
|
|
616
608
|
* upload must complete within the number of days specified in the bucket lifecycle
|
|
617
609
|
* configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort
|
|
618
610
|
* action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting
|
|
619
611
|
* Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p>
|
|
620
|
-
*
|
|
621
612
|
* <p>For information about the permissions required to use the multipart upload API, see
|
|
622
613
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
623
614
|
* Permissions</a>.</p>
|
|
624
|
-
*
|
|
625
615
|
* <p>For request signing, multipart upload is just a series of regular requests. You initiate
|
|
626
616
|
* a multipart upload, send one or more requests to upload parts, and then complete the
|
|
627
617
|
* multipart upload process. You sign each request individually. There is nothing special
|
|
628
618
|
* about signing multipart upload requests. For more information about signing, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating
|
|
629
619
|
* Requests (Amazon Web Services Signature Version 4)</a>.</p>
|
|
630
|
-
*
|
|
631
620
|
* <note>
|
|
632
621
|
* <p> After you initiate a multipart upload and upload one or more parts, to stop being
|
|
633
622
|
* charged for storing the uploaded parts, you must either complete or abort the multipart
|
|
634
623
|
* upload. Amazon S3 frees up the space used to store the parts and stop charging you for
|
|
635
624
|
* storing them only after you either complete or abort a multipart upload. </p>
|
|
636
625
|
* </note>
|
|
637
|
-
*
|
|
638
626
|
* <p>You can optionally request server-side encryption. For server-side encryption, Amazon S3
|
|
639
627
|
* encrypts your data as it writes it to disks in its data centers and decrypts it when you
|
|
640
628
|
* access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide
|
|
@@ -646,16 +634,12 @@ export declare class S3 extends S3Client {
|
|
|
646
634
|
* from the encrypted file parts before it completes the multipart upload. For more
|
|
647
635
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions">Multipart upload API
|
|
648
636
|
* and permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
649
|
-
*
|
|
650
637
|
* <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account
|
|
651
638
|
* as the KMS key, then you must have these permissions on the key policy. If your IAM
|
|
652
639
|
* user or role belongs to a different account than the key, then you must have the
|
|
653
640
|
* permissions on both the key policy and your IAM user or role.</p>
|
|
654
|
-
*
|
|
655
|
-
*
|
|
656
641
|
* <p> For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting
|
|
657
642
|
* Data Using Server-Side Encryption</a>.</p>
|
|
658
|
-
*
|
|
659
643
|
* <dl>
|
|
660
644
|
* <dt>Access Permissions</dt>
|
|
661
645
|
* <dd>
|
|
@@ -852,10 +836,8 @@ export declare class S3 extends S3Client {
|
|
|
852
836
|
* </p>
|
|
853
837
|
* </li>
|
|
854
838
|
* </ul>
|
|
855
|
-
*
|
|
856
839
|
* </dd>
|
|
857
840
|
* </dl>
|
|
858
|
-
*
|
|
859
841
|
* <p>The following operations are related to <code>CreateMultipartUpload</code>:</p>
|
|
860
842
|
* <ul>
|
|
861
843
|
* <li>
|
|
@@ -891,7 +873,6 @@ export declare class S3 extends S3Client {
|
|
|
891
873
|
/**
|
|
892
874
|
* <p>Deletes the S3 bucket. All objects (including all object versions and delete markers) in
|
|
893
875
|
* the bucket must be deleted before the bucket itself can be deleted.</p>
|
|
894
|
-
*
|
|
895
876
|
* <p class="title">
|
|
896
877
|
* <b>Related Resources</b>
|
|
897
878
|
* </p>
|
|
@@ -919,10 +900,8 @@ export declare class S3 extends S3Client {
|
|
|
919
900
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
920
901
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
921
902
|
* Resources</a>.</p>
|
|
922
|
-
*
|
|
923
903
|
* <p>For information about the Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
924
904
|
* Analysis</a>. </p>
|
|
925
|
-
*
|
|
926
905
|
* <p>The following operations are related to
|
|
927
906
|
* <code>DeleteBucketAnalyticsConfiguration</code>:</p>
|
|
928
907
|
* <ul>
|
|
@@ -953,7 +932,6 @@ export declare class S3 extends S3Client {
|
|
|
953
932
|
* and can grant this permission to others. </p>
|
|
954
933
|
* <p>For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
955
934
|
* Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
956
|
-
*
|
|
957
935
|
* <p class="title">
|
|
958
936
|
* <b>Related Resources:</b>
|
|
959
937
|
* </p>
|
|
@@ -982,7 +960,6 @@ export declare class S3 extends S3Client {
|
|
|
982
960
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
983
961
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to your Amazon S3
|
|
984
962
|
* Resources</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
985
|
-
*
|
|
986
963
|
* <p class="title">
|
|
987
964
|
* <b>Related Resources</b>
|
|
988
965
|
* </p>
|
|
@@ -1069,10 +1046,8 @@ export declare class S3 extends S3Client {
|
|
|
1069
1046
|
* <p>To use this operation, you must have permission to perform the
|
|
1070
1047
|
* <code>s3:PutLifecycleConfiguration</code> action. By default, the bucket owner has this
|
|
1071
1048
|
* permission and the bucket owner can grant this permission to others.</p>
|
|
1072
|
-
*
|
|
1073
1049
|
* <p>There is usually some time lag before lifecycle configuration deletion is fully
|
|
1074
1050
|
* propagated to all the Amazon S3 systems.</p>
|
|
1075
|
-
*
|
|
1076
1051
|
* <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to
|
|
1077
1052
|
* Describe Lifecycle Actions</a>.</p>
|
|
1078
1053
|
* <p>Related actions include:</p>
|
|
@@ -1096,13 +1071,11 @@ export declare class S3 extends S3Client {
|
|
|
1096
1071
|
* <p>Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the
|
|
1097
1072
|
* metrics configuration ID) from the bucket. Note that this doesn't include the daily storage
|
|
1098
1073
|
* metrics.</p>
|
|
1099
|
-
*
|
|
1100
1074
|
* <p> To use this operation, you must have permissions to perform the
|
|
1101
1075
|
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
1102
1076
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
1103
1077
|
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
1104
1078
|
* Resources</a>.</p>
|
|
1105
|
-
*
|
|
1106
1079
|
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>. </p>
|
|
1107
1080
|
* <p>The following operations are related to
|
|
1108
1081
|
* <code>DeleteBucketMetricsConfiguration</code>:</p>
|
|
@@ -1163,18 +1136,15 @@ export declare class S3 extends S3Client {
|
|
|
1163
1136
|
* Amazon Web Services account that owns the bucket, the calling identity must have the
|
|
1164
1137
|
* <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong to the
|
|
1165
1138
|
* bucket owner's account to use this operation. </p>
|
|
1166
|
-
*
|
|
1167
1139
|
* <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403
|
|
1168
1140
|
* Access Denied</code> error. If you have the correct permissions, but you're not using an
|
|
1169
1141
|
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
|
|
1170
1142
|
* Allowed</code> error. </p>
|
|
1171
|
-
*
|
|
1172
1143
|
* <important>
|
|
1173
1144
|
* <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can
|
|
1174
1145
|
* always use this operation, even if the policy explicitly denies the root user the
|
|
1175
1146
|
* ability to perform this action.</p>
|
|
1176
1147
|
* </important>
|
|
1177
|
-
*
|
|
1178
1148
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and
|
|
1179
1149
|
* UserPolicies</a>. </p>
|
|
1180
1150
|
* <p>The following operations are related to <code>DeleteBucketPolicy</code>
|
|
@@ -1206,9 +1176,7 @@ export declare class S3 extends S3Client {
|
|
|
1206
1176
|
* <p>It can take a while for the deletion of a replication configuration to fully
|
|
1207
1177
|
* propagate.</p>
|
|
1208
1178
|
* </note>
|
|
1209
|
-
*
|
|
1210
1179
|
* <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1211
|
-
*
|
|
1212
1180
|
* <p>The following operations are related to <code>DeleteBucketReplication</code>:</p>
|
|
1213
1181
|
* <ul>
|
|
1214
1182
|
* <li>
|
|
@@ -1228,7 +1196,6 @@ export declare class S3 extends S3Client {
|
|
|
1228
1196
|
deleteBucketReplication(args: DeleteBucketReplicationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBucketReplicationCommandOutput) => void): void;
|
|
1229
1197
|
/**
|
|
1230
1198
|
* <p>Deletes the tags from the bucket.</p>
|
|
1231
|
-
*
|
|
1232
1199
|
* <p>To use this operation, you must have permission to perform the
|
|
1233
1200
|
* <code>s3:PutBucketTagging</code> action. By default, the bucket owner has this
|
|
1234
1201
|
* permission and can grant this permission to others. </p>
|
|
@@ -1255,15 +1222,12 @@ export declare class S3 extends S3Client {
|
|
|
1255
1222
|
* bucket. You will get a <code>200 OK</code> response if the website configuration you are
|
|
1256
1223
|
* trying to delete does not exist on the bucket. Amazon S3 returns a <code>404</code> response if
|
|
1257
1224
|
* the bucket specified in the request does not exist.</p>
|
|
1258
|
-
*
|
|
1259
1225
|
* <p>This DELETE action requires the <code>S3:DeleteBucketWebsite</code> permission. By
|
|
1260
1226
|
* default, only the bucket owner can delete the website configuration attached to a bucket.
|
|
1261
1227
|
* However, bucket owners can grant other users permission to delete the website configuration
|
|
1262
1228
|
* by writing a bucket policy granting them the <code>S3:DeleteBucketWebsite</code>
|
|
1263
1229
|
* permission. </p>
|
|
1264
|
-
*
|
|
1265
1230
|
* <p>For more information about hosting websites, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>. </p>
|
|
1266
|
-
*
|
|
1267
1231
|
* <p>The following operations are related to <code>DeleteBucketWebsite</code>:</p>
|
|
1268
1232
|
* <ul>
|
|
1269
1233
|
* <li>
|
|
@@ -1285,26 +1249,21 @@ export declare class S3 extends S3Client {
|
|
|
1285
1249
|
* <p>Removes the null version (if there is one) of an object and inserts a delete marker,
|
|
1286
1250
|
* which becomes the latest version of the object. If there isn't a null version, Amazon S3 does
|
|
1287
1251
|
* not remove any objects but will still respond that the command was successful.</p>
|
|
1288
|
-
*
|
|
1289
1252
|
* <p>To remove a specific version, you must be the bucket owner and you must use the version
|
|
1290
1253
|
* Id subresource. Using this subresource permanently deletes the version. If the object
|
|
1291
1254
|
* deleted is a delete marker, Amazon S3 sets the response header,
|
|
1292
1255
|
* <code>x-amz-delete-marker</code>, to true. </p>
|
|
1293
|
-
*
|
|
1294
1256
|
* <p>If the object you want to delete is in a bucket where the bucket versioning
|
|
1295
1257
|
* configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request
|
|
1296
1258
|
* header in the DELETE <code>versionId</code> request. Requests that include
|
|
1297
1259
|
* <code>x-amz-mfa</code> must use HTTPS. </p>
|
|
1298
|
-
*
|
|
1299
1260
|
* <p> For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a>. To see sample requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample Request</a>. </p>
|
|
1300
|
-
*
|
|
1301
1261
|
* <p>You can delete objects by explicitly calling DELETE Object or configure its
|
|
1302
1262
|
* lifecycle (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) to
|
|
1303
1263
|
* enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or
|
|
1304
1264
|
* deleting objects from your bucket, you must deny them the <code>s3:DeleteObject</code>,
|
|
1305
1265
|
* <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code>
|
|
1306
1266
|
* actions. </p>
|
|
1307
|
-
*
|
|
1308
1267
|
* <p>The following action is related to <code>DeleteObject</code>:</p>
|
|
1309
1268
|
* <ul>
|
|
1310
1269
|
* <li>
|
|
@@ -1322,31 +1281,26 @@ export declare class S3 extends S3Client {
|
|
|
1322
1281
|
* request. If you know the object keys that you want to delete, then this action provides
|
|
1323
1282
|
* a suitable alternative to sending individual delete requests, reducing per-request
|
|
1324
1283
|
* overhead.</p>
|
|
1325
|
-
*
|
|
1326
1284
|
* <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you
|
|
1327
1285
|
* provide the object key names, and optionally, version IDs if you want to delete a specific
|
|
1328
1286
|
* version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
|
1329
1287
|
* delete action and returns the result of that delete, success, or failure, in the
|
|
1330
1288
|
* response. Note that if the object specified in the request is not found, Amazon S3 returns the
|
|
1331
1289
|
* result as deleted.</p>
|
|
1332
|
-
*
|
|
1333
1290
|
* <p> The action supports two modes for the response: verbose and quiet. By default, the
|
|
1334
1291
|
* action uses verbose mode in which the response includes the result of deletion of each
|
|
1335
1292
|
* key in your request. In quiet mode the response includes only keys where the delete
|
|
1336
1293
|
* action encountered an error. For a successful deletion, the action does not return
|
|
1337
1294
|
* any information about the delete in the response body.</p>
|
|
1338
|
-
*
|
|
1339
1295
|
* <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete
|
|
1340
1296
|
* any versioned objects, you must include an MFA token. If you do not provide one, the entire
|
|
1341
1297
|
* request will fail, even if there are non-versioned objects you are trying to delete. If you
|
|
1342
1298
|
* provide an invalid token, whether there are versioned keys in the request or not, the
|
|
1343
1299
|
* entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA
|
|
1344
1300
|
* Delete</a>.</p>
|
|
1345
|
-
*
|
|
1346
1301
|
* <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon
|
|
1347
1302
|
* S3 uses the header value to ensure that your request body has not been altered in
|
|
1348
1303
|
* transit.</p>
|
|
1349
|
-
*
|
|
1350
1304
|
* <p>The following operations are related to <code>DeleteObjects</code>:</p>
|
|
1351
1305
|
* <ul>
|
|
1352
1306
|
* <li>
|
|
@@ -1383,14 +1337,11 @@ export declare class S3 extends S3Client {
|
|
|
1383
1337
|
* <p>Removes the entire tag set from the specified object. For more information about
|
|
1384
1338
|
* managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object
|
|
1385
1339
|
* Tagging</a>.</p>
|
|
1386
|
-
*
|
|
1387
1340
|
* <p>To use this operation, you must have permission to perform the
|
|
1388
1341
|
* <code>s3:DeleteObjectTagging</code> action.</p>
|
|
1389
|
-
*
|
|
1390
1342
|
* <p>To delete tags of a specific object version, add the <code>versionId</code> query
|
|
1391
1343
|
* parameter in the request. You will need permission for the
|
|
1392
1344
|
* <code>s3:DeleteObjectVersionTagging</code> action.</p>
|
|
1393
|
-
*
|
|
1394
1345
|
* <p>The following operations are related to
|
|
1395
1346
|
* <code>DeleteBucketMetricsConfiguration</code>:</p>
|
|
1396
1347
|
* <ul>
|
|
@@ -1414,7 +1365,6 @@ export declare class S3 extends S3Client {
|
|
|
1414
1365
|
* operation, you must have the <code>s3:PutBucketPublicAccessBlock</code> permission. For
|
|
1415
1366
|
* more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
1416
1367
|
* Resources</a>.</p>
|
|
1417
|
-
*
|
|
1418
1368
|
* <p>The following operations are related to <code>DeletePublicAccessBlock</code>:</p>
|
|
1419
1369
|
* <ul>
|
|
1420
1370
|
* <li>
|
|
@@ -1458,7 +1408,6 @@ export declare class S3 extends S3Client {
|
|
|
1458
1408
|
* <p>A GET <code>accelerate</code> request does not return a state value for a bucket that
|
|
1459
1409
|
* has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state
|
|
1460
1410
|
* has never been set on the bucket. </p>
|
|
1461
|
-
*
|
|
1462
1411
|
* <p>For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a> in the
|
|
1463
1412
|
* Amazon S3 User Guide.</p>
|
|
1464
1413
|
* <p class="title">
|
|
@@ -1488,7 +1437,6 @@ export declare class S3 extends S3Client {
|
|
|
1488
1437
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">
|
|
1489
1438
|
* Controlling object ownership and disabling ACLs</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1490
1439
|
* </note>
|
|
1491
|
-
*
|
|
1492
1440
|
* <p class="title">
|
|
1493
1441
|
* <b>Related Resources</b>
|
|
1494
1442
|
* </p>
|
|
@@ -1513,7 +1461,6 @@ export declare class S3 extends S3Client {
|
|
|
1513
1461
|
* Resources</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
1514
1462
|
* <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
1515
1463
|
* Analysis</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1516
|
-
*
|
|
1517
1464
|
* <p class="title">
|
|
1518
1465
|
* <b>Related Resources</b>
|
|
1519
1466
|
* </p>
|
|
@@ -1541,14 +1488,11 @@ export declare class S3 extends S3Client {
|
|
|
1541
1488
|
/**
|
|
1542
1489
|
* <p>Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the
|
|
1543
1490
|
* bucket.</p>
|
|
1544
|
-
*
|
|
1545
1491
|
* <p> To use this operation, you must have permission to perform the
|
|
1546
1492
|
* <code>s3:GetBucketCORS</code> action. By default, the bucket owner has this permission
|
|
1547
1493
|
* and can grant it to others.</p>
|
|
1548
|
-
*
|
|
1549
1494
|
* <p> For more information about CORS, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html"> Enabling Cross-Origin Resource
|
|
1550
1495
|
* Sharing</a>.</p>
|
|
1551
|
-
*
|
|
1552
1496
|
* <p>The following operations are related to <code>GetBucketCors</code>:</p>
|
|
1553
1497
|
* <ul>
|
|
1554
1498
|
* <li>
|
|
@@ -1624,15 +1568,12 @@ export declare class S3 extends S3Client {
|
|
|
1624
1568
|
/**
|
|
1625
1569
|
* <p>Returns an inventory configuration (identified by the inventory configuration ID) from
|
|
1626
1570
|
* the bucket.</p>
|
|
1627
|
-
*
|
|
1628
1571
|
* <p>To use this operation, you must have permissions to perform the
|
|
1629
1572
|
* <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
|
|
1630
1573
|
* by default and can grant this permission to others. For more information about permissions,
|
|
1631
1574
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
1632
1575
|
* Resources</a>.</p>
|
|
1633
|
-
*
|
|
1634
1576
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p>
|
|
1635
|
-
*
|
|
1636
1577
|
* <p>The following operations are related to
|
|
1637
1578
|
* <code>GetBucketInventoryConfiguration</code>:</p>
|
|
1638
1579
|
* <ul>
|
|
@@ -1668,13 +1609,11 @@ export declare class S3 extends S3Client {
|
|
|
1668
1609
|
* <p>Returns the lifecycle configuration information set on the bucket. For information about
|
|
1669
1610
|
* lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object
|
|
1670
1611
|
* Lifecycle Management</a>.</p>
|
|
1671
|
-
*
|
|
1672
1612
|
* <p>To use this operation, you must have permission to perform the
|
|
1673
1613
|
* <code>s3:GetLifecycleConfiguration</code> action. The bucket owner has this permission,
|
|
1674
1614
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
1675
1615
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
1676
1616
|
* Resources</a>.</p>
|
|
1677
|
-
*
|
|
1678
1617
|
* <p>
|
|
1679
1618
|
* <code>GetBucketLifecycleConfiguration</code> has the following special error:</p>
|
|
1680
1619
|
* <ul>
|
|
@@ -1721,11 +1660,8 @@ export declare class S3 extends S3Client {
|
|
|
1721
1660
|
* <p>Returns the Region the bucket resides in. You set the bucket's Region using the
|
|
1722
1661
|
* <code>LocationConstraint</code> request parameter in a <code>CreateBucket</code>
|
|
1723
1662
|
* request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>.</p>
|
|
1724
|
-
*
|
|
1725
1663
|
* <p>To use this implementation of the operation, you must be the bucket owner.</p>
|
|
1726
|
-
*
|
|
1727
1664
|
* <p>To use this API against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
1728
|
-
*
|
|
1729
1665
|
* <p>The following operations are related to <code>GetBucketLocation</code>:</p>
|
|
1730
1666
|
* <ul>
|
|
1731
1667
|
* <li>
|
|
@@ -1746,7 +1682,6 @@ export declare class S3 extends S3Client {
|
|
|
1746
1682
|
/**
|
|
1747
1683
|
* <p>Returns the logging status of a bucket and the permissions users have to view and modify
|
|
1748
1684
|
* that status. To use GET, you must be the bucket owner.</p>
|
|
1749
|
-
*
|
|
1750
1685
|
* <p>The following operations are related to <code>GetBucketLogging</code>:</p>
|
|
1751
1686
|
* <ul>
|
|
1752
1687
|
* <li>
|
|
@@ -1767,16 +1702,13 @@ export declare class S3 extends S3Client {
|
|
|
1767
1702
|
/**
|
|
1768
1703
|
* <p>Gets a metrics configuration (specified by the metrics configuration ID) from the
|
|
1769
1704
|
* bucket. Note that this doesn't include the daily storage metrics.</p>
|
|
1770
|
-
*
|
|
1771
1705
|
* <p> To use this operation, you must have permissions to perform the
|
|
1772
1706
|
* <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
1773
1707
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
1774
1708
|
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
1775
1709
|
* Resources</a>.</p>
|
|
1776
|
-
*
|
|
1777
1710
|
* <p> For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
1778
1711
|
* CloudWatch</a>.</p>
|
|
1779
|
-
*
|
|
1780
1712
|
* <p>The following operations are related to
|
|
1781
1713
|
* <code>GetBucketMetricsConfiguration</code>:</p>
|
|
1782
1714
|
* <ul>
|
|
@@ -1810,16 +1742,13 @@ export declare class S3 extends S3Client {
|
|
|
1810
1742
|
* <p>Returns the notification configuration of a bucket.</p>
|
|
1811
1743
|
* <p>If notifications are not enabled on the bucket, the action returns an empty
|
|
1812
1744
|
* <code>NotificationConfiguration</code> element.</p>
|
|
1813
|
-
*
|
|
1814
1745
|
* <p>By default, you must be the bucket owner to read the notification configuration of a
|
|
1815
1746
|
* bucket. However, the bucket owner can use a bucket policy to grant permission to other
|
|
1816
1747
|
* users to read this configuration with the <code>s3:GetBucketNotification</code>
|
|
1817
1748
|
* permission.</p>
|
|
1818
|
-
*
|
|
1819
1749
|
* <p>For more information about setting and reading the notification configuration on a
|
|
1820
1750
|
* bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Setting Up Notification of
|
|
1821
1751
|
* Bucket Events</a>. For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies</a>.</p>
|
|
1822
|
-
*
|
|
1823
1752
|
* <p>The following action is related to <code>GetBucketNotification</code>:</p>
|
|
1824
1753
|
* <ul>
|
|
1825
1754
|
* <li>
|
|
@@ -1860,21 +1789,17 @@ export declare class S3 extends S3Client {
|
|
|
1860
1789
|
* root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
|
|
1861
1790
|
* <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the
|
|
1862
1791
|
* bucket owner's account in order to use this operation.</p>
|
|
1863
|
-
*
|
|
1864
1792
|
* <p>If you don't have <code>GetBucketPolicy</code> permissions, Amazon S3 returns a <code>403
|
|
1865
1793
|
* Access Denied</code> error. If you have the correct permissions, but you're not using an
|
|
1866
1794
|
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
|
|
1867
1795
|
* Allowed</code> error.</p>
|
|
1868
|
-
*
|
|
1869
1796
|
* <important>
|
|
1870
1797
|
* <p>As a security precaution, the root user of the Amazon Web Services account that owns a bucket can
|
|
1871
1798
|
* always use this operation, even if the policy explicitly denies the root user the
|
|
1872
1799
|
* ability to perform this action.</p>
|
|
1873
1800
|
* </important>
|
|
1874
|
-
*
|
|
1875
1801
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
1876
1802
|
* Policies</a>.</p>
|
|
1877
|
-
*
|
|
1878
1803
|
* <p>The following action is related to <code>GetBucketPolicy</code>:</p>
|
|
1879
1804
|
* <ul>
|
|
1880
1805
|
* <li>
|
|
@@ -1892,9 +1817,7 @@ export declare class S3 extends S3Client {
|
|
|
1892
1817
|
* In order to use this operation, you must have the <code>s3:GetBucketPolicyStatus</code>
|
|
1893
1818
|
* permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
1894
1819
|
* Policy</a>.</p>
|
|
1895
|
-
*
|
|
1896
1820
|
* <p> For more information about when Amazon S3 considers a bucket public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>. </p>
|
|
1897
|
-
*
|
|
1898
1821
|
* <p>The following operations are related to <code>GetBucketPolicyStatus</code>:</p>
|
|
1899
1822
|
* <ul>
|
|
1900
1823
|
* <li>
|
|
@@ -1932,20 +1855,15 @@ export declare class S3 extends S3Client {
|
|
|
1932
1855
|
* </note>
|
|
1933
1856
|
* <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the
|
|
1934
1857
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
1935
|
-
*
|
|
1936
1858
|
* <p>This action requires permissions for the <code>s3:GetReplicationConfiguration</code>
|
|
1937
1859
|
* action. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
|
|
1938
1860
|
* Policies</a>.</p>
|
|
1939
|
-
*
|
|
1940
1861
|
* <p>If you include the <code>Filter</code> element in a replication configuration, you must
|
|
1941
1862
|
* also include the <code>DeleteMarkerReplication</code> and <code>Priority</code> elements.
|
|
1942
1863
|
* The response also returns those elements.</p>
|
|
1943
|
-
*
|
|
1944
1864
|
* <p>For information about <code>GetBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
|
|
1945
1865
|
* replication-related error codes</a>
|
|
1946
1866
|
* </p>
|
|
1947
|
-
*
|
|
1948
|
-
*
|
|
1949
1867
|
* <p>The following operations are related to <code>GetBucketReplication</code>:</p>
|
|
1950
1868
|
* <ul>
|
|
1951
1869
|
* <li>
|
|
@@ -1966,7 +1884,6 @@ export declare class S3 extends S3Client {
|
|
|
1966
1884
|
/**
|
|
1967
1885
|
* <p>Returns the request payment configuration of a bucket. To use this version of the
|
|
1968
1886
|
* operation, you must be the bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays Buckets</a>.</p>
|
|
1969
|
-
*
|
|
1970
1887
|
* <p>The following operations are related to <code>GetBucketRequestPayment</code>:</p>
|
|
1971
1888
|
* <ul>
|
|
1972
1889
|
* <li>
|
|
@@ -1984,7 +1901,6 @@ export declare class S3 extends S3Client {
|
|
|
1984
1901
|
* <p>To use this operation, you must have permission to perform the
|
|
1985
1902
|
* <code>s3:GetBucketTagging</code> action. By default, the bucket owner has this
|
|
1986
1903
|
* permission and can grant this permission to others.</p>
|
|
1987
|
-
*
|
|
1988
1904
|
* <p>
|
|
1989
1905
|
* <code>GetBucketTagging</code> has the following special error:</p>
|
|
1990
1906
|
* <ul>
|
|
@@ -1998,7 +1914,6 @@ export declare class S3 extends S3Client {
|
|
|
1998
1914
|
* </ul>
|
|
1999
1915
|
* </li>
|
|
2000
1916
|
* </ul>
|
|
2001
|
-
*
|
|
2002
1917
|
* <p>The following operations are related to <code>GetBucketTagging</code>:</p>
|
|
2003
1918
|
* <ul>
|
|
2004
1919
|
* <li>
|
|
@@ -2019,11 +1934,9 @@ export declare class S3 extends S3Client {
|
|
|
2019
1934
|
/**
|
|
2020
1935
|
* <p>Returns the versioning state of a bucket.</p>
|
|
2021
1936
|
* <p>To retrieve the versioning state of a bucket, you must be the bucket owner.</p>
|
|
2022
|
-
*
|
|
2023
1937
|
* <p>This implementation also returns the MFA Delete status of the versioning state. If the
|
|
2024
1938
|
* MFA Delete status is <code>enabled</code>, the bucket owner must use an authentication
|
|
2025
1939
|
* device to change the versioning state of the bucket.</p>
|
|
2026
|
-
*
|
|
2027
1940
|
* <p>The following operations are related to <code>GetBucketVersioning</code>:</p>
|
|
2028
1941
|
* <ul>
|
|
2029
1942
|
* <li>
|
|
@@ -2076,12 +1989,10 @@ export declare class S3 extends S3Client {
|
|
|
2076
1989
|
* <p>Retrieves objects from Amazon S3. To use <code>GET</code>, you must have <code>READ</code>
|
|
2077
1990
|
* access to the object. If you grant <code>READ</code> access to the anonymous user, you can
|
|
2078
1991
|
* return the object without using an authorization header.</p>
|
|
2079
|
-
*
|
|
2080
1992
|
* <p>An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer
|
|
2081
1993
|
* file system. You can, however, create a logical hierarchy by using object key names that
|
|
2082
1994
|
* imply a folder structure. For example, instead of naming an object <code>sample.jpg</code>,
|
|
2083
1995
|
* you can name it <code>photos/2006/February/sample.jpg</code>.</p>
|
|
2084
|
-
*
|
|
2085
1996
|
* <p>To get an object from such a logical hierarchy, specify the full key name for the object
|
|
2086
1997
|
* in the <code>GET</code> operation. For a virtual hosted-style request example, if you have
|
|
2087
1998
|
* the object <code>photos/2006/February/sample.jpg</code>, specify the resource as
|
|
@@ -2090,9 +2001,7 @@ export declare class S3 extends S3Client {
|
|
|
2090
2001
|
* <code>examplebucket</code>, specify the resource as
|
|
2091
2002
|
* <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about
|
|
2092
2003
|
* request types, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket">HTTP Host Header Bucket Specification</a>.</p>
|
|
2093
|
-
*
|
|
2094
2004
|
* <p>For more information about returning the ACL of an object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>.</p>
|
|
2095
|
-
*
|
|
2096
2005
|
* <p>If the object you are retrieving is stored in the S3 Glacier or
|
|
2097
2006
|
* S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or
|
|
2098
2007
|
* S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a
|
|
@@ -2100,7 +2009,6 @@ export declare class S3 extends S3Client {
|
|
|
2100
2009
|
* <code>InvalidObjectStateError</code> error. For information about restoring archived
|
|
2101
2010
|
* objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html">Restoring Archived
|
|
2102
2011
|
* Objects</a>.</p>
|
|
2103
|
-
*
|
|
2104
2012
|
* <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not
|
|
2105
2013
|
* be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS)
|
|
2106
2014
|
* or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your
|
|
@@ -2121,12 +2029,10 @@ export declare class S3 extends S3Client {
|
|
|
2121
2029
|
* </ul>
|
|
2122
2030
|
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption (Using
|
|
2123
2031
|
* Customer-Provided Encryption Keys)</a>.</p>
|
|
2124
|
-
*
|
|
2125
2032
|
* <p>Assuming you have the relevant permission to read object tags, the response also returns the
|
|
2126
2033
|
* <code>x-amz-tagging-count</code> header that provides the count of number of tags
|
|
2127
2034
|
* associated with the object. You can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a> to retrieve
|
|
2128
2035
|
* the tag set associated with an object.</p>
|
|
2129
|
-
*
|
|
2130
2036
|
* <p>
|
|
2131
2037
|
* <b>Permissions</b>
|
|
2132
2038
|
* </p>
|
|
@@ -2144,14 +2050,11 @@ export declare class S3 extends S3Client {
|
|
|
2144
2050
|
* HTTP status code 403 ("access denied") error.</p>
|
|
2145
2051
|
* </li>
|
|
2146
2052
|
* </ul>
|
|
2147
|
-
*
|
|
2148
|
-
*
|
|
2149
2053
|
* <p>
|
|
2150
2054
|
* <b>Versioning</b>
|
|
2151
2055
|
* </p>
|
|
2152
2056
|
* <p>By default, the GET action returns the current version of an object. To return a
|
|
2153
2057
|
* different version, use the <code>versionId</code> subresource.</p>
|
|
2154
|
-
*
|
|
2155
2058
|
* <note>
|
|
2156
2059
|
* <ul>
|
|
2157
2060
|
* <li>
|
|
@@ -2168,17 +2071,13 @@ export declare class S3 extends S3Client {
|
|
|
2168
2071
|
* </li>
|
|
2169
2072
|
* </ul>
|
|
2170
2073
|
* </note>
|
|
2171
|
-
*
|
|
2172
|
-
*
|
|
2173
2074
|
* <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html">PutBucketVersioning</a>. </p>
|
|
2174
|
-
*
|
|
2175
2075
|
* <p>
|
|
2176
2076
|
* <b>Overriding Response Header Values</b>
|
|
2177
2077
|
* </p>
|
|
2178
2078
|
* <p>There are times when you want to override certain response header values in a GET
|
|
2179
2079
|
* response. For example, you might override the <code>Content-Disposition</code> response
|
|
2180
2080
|
* header value in your GET request.</p>
|
|
2181
|
-
*
|
|
2182
2081
|
* <p>You can override values for a set of response headers using the following query
|
|
2183
2082
|
* parameters. These response header values are sent only on a successful request, that is,
|
|
2184
2083
|
* when status code 200 OK is returned. The set of headers you can override using these
|
|
@@ -2187,7 +2086,6 @@ export declare class S3 extends S3Client {
|
|
|
2187
2086
|
* <code>Content-Language</code>, <code>Expires</code>, <code>Cache-Control</code>,
|
|
2188
2087
|
* <code>Content-Disposition</code>, and <code>Content-Encoding</code>. To override these
|
|
2189
2088
|
* header values in the GET response, you use the following request parameters.</p>
|
|
2190
|
-
*
|
|
2191
2089
|
* <note>
|
|
2192
2090
|
* <p>You must sign the request, either using an Authorization header or a presigned URL,
|
|
2193
2091
|
* when using these parameters. They cannot be used with an unsigned (anonymous)
|
|
@@ -2225,23 +2123,18 @@ export declare class S3 extends S3Client {
|
|
|
2225
2123
|
* </p>
|
|
2226
2124
|
* </li>
|
|
2227
2125
|
* </ul>
|
|
2228
|
-
*
|
|
2229
2126
|
* <p>
|
|
2230
2127
|
* <b>Additional Considerations about Request Headers</b>
|
|
2231
2128
|
* </p>
|
|
2232
|
-
*
|
|
2233
2129
|
* <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are
|
|
2234
2130
|
* present in the request as follows: <code>If-Match</code> condition evaluates to
|
|
2235
2131
|
* <code>true</code>, and; <code>If-Unmodified-Since</code> condition evaluates to
|
|
2236
2132
|
* <code>false</code>; then, S3 returns 200 OK and the data requested. </p>
|
|
2237
|
-
*
|
|
2238
2133
|
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are
|
|
2239
2134
|
* present in the request as follows:<code> If-None-Match</code> condition evaluates to
|
|
2240
2135
|
* <code>false</code>, and; <code>If-Modified-Since</code> condition evaluates to
|
|
2241
2136
|
* <code>true</code>; then, S3 returns 304 Not Modified response code.</p>
|
|
2242
|
-
*
|
|
2243
2137
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
2244
|
-
*
|
|
2245
2138
|
* <p>The following operations are related to <code>GetObject</code>:</p>
|
|
2246
2139
|
* <ul>
|
|
2247
2140
|
* <li>
|
|
@@ -2266,7 +2159,7 @@ export declare class S3 extends S3Client {
|
|
|
2266
2159
|
* User Guide</i>
|
|
2267
2160
|
* </p>
|
|
2268
2161
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
2269
|
-
*
|
|
2162
|
+
* <p>
|
|
2270
2163
|
* <b>Versioning</b>
|
|
2271
2164
|
* </p>
|
|
2272
2165
|
* <p>By default, GET returns ACL information about the current version of an object. To
|
|
@@ -2309,98 +2202,93 @@ export declare class S3 extends S3Client {
|
|
|
2309
2202
|
* <p>Retrieves all the metadata from an object without returning the object itself. This
|
|
2310
2203
|
* action is useful if you're interested only in an object's metadata. To use
|
|
2311
2204
|
* <code>GetObjectAttributes</code>, you must have READ access to the object.</p>
|
|
2312
|
-
*
|
|
2313
|
-
* <p>
|
|
2205
|
+
* <p>
|
|
2314
2206
|
* <code>GetObjectAttributes</code> combines the functionality of
|
|
2315
2207
|
* <code>GetObjectAcl</code>, <code>GetObjectLegalHold</code>,
|
|
2316
2208
|
* <code>GetObjectLockConfiguration</code>, <code>GetObjectRetention</code>,
|
|
2317
2209
|
* <code>GetObjectTagging</code>, <code>HeadObject</code>, and <code>ListParts</code>. All
|
|
2318
2210
|
* of the data returned with each of those individual calls can be returned with a single call
|
|
2319
2211
|
* to <code>GetObjectAttributes</code>.</p>
|
|
2320
|
-
*
|
|
2321
|
-
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
2212
|
+
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
2322
2213
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
|
|
2323
2214
|
* metadata from the object, you must use the following headers:</p>
|
|
2324
|
-
*
|
|
2215
|
+
* <ul>
|
|
2325
2216
|
* <li>
|
|
2326
|
-
*
|
|
2217
|
+
* <p>
|
|
2327
2218
|
* <code>x-amz-server-side-encryption-customer-algorithm</code>
|
|
2328
2219
|
* </p>
|
|
2329
2220
|
* </li>
|
|
2330
2221
|
* <li>
|
|
2331
|
-
*
|
|
2222
|
+
* <p>
|
|
2332
2223
|
* <code>x-amz-server-side-encryption-customer-key</code>
|
|
2333
2224
|
* </p>
|
|
2334
2225
|
* </li>
|
|
2335
2226
|
* <li>
|
|
2336
|
-
*
|
|
2227
|
+
* <p>
|
|
2337
2228
|
* <code>x-amz-server-side-encryption-customer-key-MD5</code>
|
|
2338
2229
|
* </p>
|
|
2339
2230
|
* </li>
|
|
2340
2231
|
* </ul>
|
|
2341
|
-
*
|
|
2232
|
+
* <p>For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption
|
|
2342
2233
|
* (Using Customer-Provided Encryption Keys)</a> in the
|
|
2343
2234
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
2344
|
-
*
|
|
2235
|
+
* <note>
|
|
2345
2236
|
* <ul>
|
|
2346
2237
|
* <li>
|
|
2347
|
-
*
|
|
2238
|
+
* <p>Encryption request headers, such as
|
|
2348
2239
|
* <code>x-amz-server-side-encryption</code>, should not be sent for GET requests
|
|
2349
2240
|
* if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key
|
|
2350
2241
|
* Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed
|
|
2351
2242
|
* encryption keys (SSE-S3). If your object does use these types of keys, you'll get
|
|
2352
2243
|
* an HTTP <code>400 Bad Request</code> error.</p>
|
|
2353
|
-
*
|
|
2244
|
+
* </li>
|
|
2354
2245
|
* <li>
|
|
2355
2246
|
* <p>
|
|
2356
2247
|
* The last modified property in this case is the creation date of the object.</p>
|
|
2357
|
-
*
|
|
2248
|
+
* </li>
|
|
2358
2249
|
* </ul>
|
|
2359
|
-
*
|
|
2360
|
-
*
|
|
2361
|
-
*
|
|
2362
|
-
* <ul>
|
|
2250
|
+
* </note>
|
|
2251
|
+
* <p>Consider the following when using request headers:</p>
|
|
2252
|
+
* <ul>
|
|
2363
2253
|
* <li>
|
|
2364
|
-
*
|
|
2254
|
+
* <p> If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code>
|
|
2365
2255
|
* headers are present in the request as follows, then Amazon S3 returns the HTTP
|
|
2366
2256
|
* status code <code>200 OK</code> and the data requested:</p>
|
|
2367
|
-
*
|
|
2257
|
+
* <ul>
|
|
2368
2258
|
* <li>
|
|
2369
2259
|
* <p>
|
|
2370
2260
|
* <code>If-Match</code> condition evaluates to <code>true</code>.</p>
|
|
2371
2261
|
* </li>
|
|
2372
2262
|
* <li>
|
|
2373
|
-
*
|
|
2263
|
+
* <p>
|
|
2374
2264
|
* <code>If-Unmodified-Since</code> condition evaluates to
|
|
2375
2265
|
* <code>false</code>.</p>
|
|
2376
|
-
*
|
|
2266
|
+
* </li>
|
|
2377
2267
|
* </ul>
|
|
2378
2268
|
* </li>
|
|
2379
2269
|
* <li>
|
|
2380
|
-
*
|
|
2270
|
+
* <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code>
|
|
2381
2271
|
* headers are present in the request as follows, then Amazon S3 returns the HTTP status code
|
|
2382
2272
|
* <code>304 Not Modified</code>:</p>
|
|
2383
|
-
*
|
|
2273
|
+
* <ul>
|
|
2384
2274
|
* <li>
|
|
2385
|
-
*
|
|
2275
|
+
* <p>
|
|
2386
2276
|
* <code>If-None-Match</code> condition evaluates to
|
|
2387
2277
|
* <code>false</code>.</p>
|
|
2388
|
-
*
|
|
2278
|
+
* </li>
|
|
2389
2279
|
* <li>
|
|
2390
|
-
*
|
|
2280
|
+
* <p>
|
|
2391
2281
|
* <code>If-Modified-Since</code> condition evaluates to
|
|
2392
2282
|
* <code>true</code>.</p>
|
|
2393
|
-
*
|
|
2283
|
+
* </li>
|
|
2394
2284
|
* </ul>
|
|
2395
2285
|
* </li>
|
|
2396
2286
|
* </ul>
|
|
2397
|
-
*
|
|
2398
|
-
*
|
|
2399
|
-
*
|
|
2400
|
-
* <p>
|
|
2287
|
+
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
2288
|
+
* <p>
|
|
2401
2289
|
* <b>Permissions</b>
|
|
2402
2290
|
* </p>
|
|
2403
|
-
*
|
|
2291
|
+
* <p>The permissions that you need to use this operation depend on whether the bucket is
|
|
2404
2292
|
* versioned. If the bucket is versioned, you need both the <code>s3:GetObjectVersion</code>
|
|
2405
2293
|
* and <code>s3:GetObjectVersionAttributes</code> permissions for this operation. If the
|
|
2406
2294
|
* bucket is not versioned, you need the <code>s3:GetObject</code> and
|
|
@@ -2408,56 +2296,55 @@ export declare class S3 extends S3Client {
|
|
|
2408
2296
|
* Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the
|
|
2409
2297
|
* object that you request does not exist, the error Amazon S3 returns depends on whether you also
|
|
2410
2298
|
* have the <code>s3:ListBucket</code> permission.</p>
|
|
2411
|
-
*
|
|
2299
|
+
* <ul>
|
|
2412
2300
|
* <li>
|
|
2413
|
-
*
|
|
2301
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
|
|
2414
2302
|
* returns an HTTP status code <code>404 Not Found</code> ("no such key") error.</p>
|
|
2415
2303
|
* </li>
|
|
2416
2304
|
* <li>
|
|
2417
|
-
*
|
|
2305
|
+
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an
|
|
2418
2306
|
* HTTP status code <code>403 Forbidden</code> ("access denied") error.</p>
|
|
2419
2307
|
* </li>
|
|
2420
2308
|
* </ul>
|
|
2421
|
-
*
|
|
2422
|
-
*
|
|
2423
|
-
* <ul>
|
|
2309
|
+
* <p>The following actions are related to <code>GetObjectAttributes</code>:</p>
|
|
2310
|
+
* <ul>
|
|
2424
2311
|
* <li>
|
|
2425
|
-
*
|
|
2312
|
+
* <p>
|
|
2426
2313
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>
|
|
2427
2314
|
* </p>
|
|
2428
2315
|
* </li>
|
|
2429
2316
|
* <li>
|
|
2430
|
-
*
|
|
2317
|
+
* <p>
|
|
2431
2318
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>
|
|
2432
2319
|
* </p>
|
|
2433
2320
|
* </li>
|
|
2434
2321
|
* <li>
|
|
2435
|
-
*
|
|
2322
|
+
* <p>
|
|
2436
2323
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html">GetObjectLegalHold</a>
|
|
2437
2324
|
* </p>
|
|
2438
2325
|
* </li>
|
|
2439
2326
|
* <li>
|
|
2440
|
-
*
|
|
2327
|
+
* <p>
|
|
2441
2328
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html">GetObjectLockConfiguration</a>
|
|
2442
2329
|
* </p>
|
|
2443
2330
|
* </li>
|
|
2444
2331
|
* <li>
|
|
2445
|
-
*
|
|
2332
|
+
* <p>
|
|
2446
2333
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html">GetObjectRetention</a>
|
|
2447
2334
|
* </p>
|
|
2448
2335
|
* </li>
|
|
2449
2336
|
* <li>
|
|
2450
|
-
*
|
|
2337
|
+
* <p>
|
|
2451
2338
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>
|
|
2452
2339
|
* </p>
|
|
2453
2340
|
* </li>
|
|
2454
2341
|
* <li>
|
|
2455
|
-
*
|
|
2342
|
+
* <p>
|
|
2456
2343
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html">HeadObject</a>
|
|
2457
2344
|
* </p>
|
|
2458
2345
|
* </li>
|
|
2459
2346
|
* <li>
|
|
2460
|
-
*
|
|
2347
|
+
* <p>
|
|
2461
2348
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a>
|
|
2462
2349
|
* </p>
|
|
2463
2350
|
* </li>
|
|
@@ -2470,7 +2357,6 @@ export declare class S3 extends S3Client {
|
|
|
2470
2357
|
* <p>Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
2471
2358
|
* Objects</a>.</p>
|
|
2472
2359
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
2473
|
-
*
|
|
2474
2360
|
* <p>The following action is related to <code>GetObjectLegalHold</code>:</p>
|
|
2475
2361
|
* <ul>
|
|
2476
2362
|
* <li>
|
|
@@ -2488,7 +2374,6 @@ export declare class S3 extends S3Client {
|
|
|
2488
2374
|
* configuration will be applied by default to every new object placed in the specified
|
|
2489
2375
|
* bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking
|
|
2490
2376
|
* Objects</a>.</p>
|
|
2491
|
-
*
|
|
2492
2377
|
* <p>The following action is related to <code>GetObjectLockConfiguration</code>:</p>
|
|
2493
2378
|
* <ul>
|
|
2494
2379
|
* <li>
|
|
@@ -2504,7 +2389,6 @@ export declare class S3 extends S3Client {
|
|
|
2504
2389
|
/**
|
|
2505
2390
|
* <p>Retrieves an object's retention settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>.</p>
|
|
2506
2391
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
2507
|
-
*
|
|
2508
2392
|
* <p>The following action is related to <code>GetObjectRetention</code>:</p>
|
|
2509
2393
|
* <ul>
|
|
2510
2394
|
* <li>
|
|
@@ -2520,19 +2404,15 @@ export declare class S3 extends S3Client {
|
|
|
2520
2404
|
/**
|
|
2521
2405
|
* <p>Returns the tag-set of an object. You send the GET request against the tagging
|
|
2522
2406
|
* subresource associated with the object.</p>
|
|
2523
|
-
*
|
|
2524
2407
|
* <p>To use this operation, you must have permission to perform the
|
|
2525
2408
|
* <code>s3:GetObjectTagging</code> action. By default, the GET action returns
|
|
2526
2409
|
* information about current version of an object. For a versioned bucket, you can have
|
|
2527
2410
|
* multiple versions of an object in your bucket. To retrieve tags of any other version, use
|
|
2528
2411
|
* the versionId query parameter. You also need permission for the
|
|
2529
2412
|
* <code>s3:GetObjectVersionTagging</code> action.</p>
|
|
2530
|
-
*
|
|
2531
2413
|
* <p> By default, the bucket owner has this permission and can grant this permission to
|
|
2532
2414
|
* others.</p>
|
|
2533
|
-
*
|
|
2534
2415
|
* <p> For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
|
|
2535
|
-
*
|
|
2536
2416
|
* <p>The following actions are related to <code>GetObjectTagging</code>:</p>
|
|
2537
2417
|
* <ul>
|
|
2538
2418
|
* <li>
|
|
@@ -2582,7 +2462,6 @@ export declare class S3 extends S3Client {
|
|
|
2582
2462
|
* this operation, you must have the <code>s3:GetBucketPublicAccessBlock</code> permission.
|
|
2583
2463
|
* For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
2584
2464
|
* Policy</a>.</p>
|
|
2585
|
-
*
|
|
2586
2465
|
* <important>
|
|
2587
2466
|
* <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
|
|
2588
2467
|
* an object, it checks the <code>PublicAccessBlock</code> configuration for both the
|
|
@@ -2591,9 +2470,7 @@ export declare class S3 extends S3Client {
|
|
|
2591
2470
|
* account, Amazon S3 uses the most restrictive combination of the bucket-level and
|
|
2592
2471
|
* account-level settings.</p>
|
|
2593
2472
|
* </important>
|
|
2594
|
-
*
|
|
2595
2473
|
* <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>.</p>
|
|
2596
|
-
*
|
|
2597
2474
|
* <p>The following operations are related to <code>GetPublicAccessBlock</code>:</p>
|
|
2598
2475
|
* <ul>
|
|
2599
2476
|
* <li>
|
|
@@ -2626,18 +2503,13 @@ export declare class S3 extends S3Client {
|
|
|
2626
2503
|
* <p>This action is useful to determine if a bucket exists and you have permission to
|
|
2627
2504
|
* access it. The action returns a <code>200 OK</code> if the bucket exists and you have
|
|
2628
2505
|
* permission to access it.</p>
|
|
2629
|
-
*
|
|
2630
|
-
*
|
|
2631
2506
|
* <p>If the bucket does not exist or you do not have permission to access it, the <code>HEAD</code> request
|
|
2632
2507
|
* returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. A message body is not
|
|
2633
2508
|
* included, so you cannot determine the exception beyond these error codes.</p>
|
|
2634
|
-
*
|
|
2635
2509
|
* <p>To use this operation, you must have permissions to perform the
|
|
2636
2510
|
* <code>s3:ListBucket</code> action. The bucket owner has this permission by default and
|
|
2637
2511
|
* can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
2638
2512
|
* Resources</a>.</p>
|
|
2639
|
-
*
|
|
2640
|
-
*
|
|
2641
2513
|
* <p>To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a>.</p>
|
|
2642
2514
|
*/
|
|
2643
2515
|
headBucket(args: HeadBucketCommandInput, options?: __HttpHandlerOptions): Promise<HeadBucketCommandOutput>;
|
|
@@ -2647,13 +2519,11 @@ export declare class S3 extends S3Client {
|
|
|
2647
2519
|
* <p>The HEAD action retrieves metadata from an object without returning the object
|
|
2648
2520
|
* itself. This action is useful if you're only interested in an object's metadata. To use
|
|
2649
2521
|
* HEAD, you must have READ access to the object.</p>
|
|
2650
|
-
*
|
|
2651
2522
|
* <p>A <code>HEAD</code> request has the same options as a <code>GET</code> action on an
|
|
2652
2523
|
* object. The response is identical to the <code>GET</code> response except that there is no
|
|
2653
2524
|
* response body. Because of this, if the <code>HEAD</code> request generates an error, it
|
|
2654
2525
|
* returns a generic <code>404 Not Found</code> or <code>403 Forbidden</code> code. It is not
|
|
2655
2526
|
* possible to retrieve the exact exception beyond these error codes.</p>
|
|
2656
|
-
*
|
|
2657
2527
|
* <p>If you encrypt an object by using server-side encryption with customer-provided
|
|
2658
2528
|
* encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the
|
|
2659
2529
|
* metadata from the object, you must use the following headers:</p>
|
|
@@ -2685,8 +2555,6 @@ export declare class S3 extends S3Client {
|
|
|
2685
2555
|
* </li>
|
|
2686
2556
|
* </ul>
|
|
2687
2557
|
* </note>
|
|
2688
|
-
*
|
|
2689
|
-
*
|
|
2690
2558
|
* <p>Request headers are limited to 8 KB in size. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html">Common Request
|
|
2691
2559
|
* Headers</a>.</p>
|
|
2692
2560
|
* <p>Consider the following when using request headers:</p>
|
|
@@ -2727,9 +2595,7 @@ export declare class S3 extends S3Client {
|
|
|
2727
2595
|
* <p>Then Amazon S3 returns the <code>304 Not Modified</code> response code.</p>
|
|
2728
2596
|
* </li>
|
|
2729
2597
|
* </ul>
|
|
2730
|
-
*
|
|
2731
2598
|
* <p>For more information about conditional requests, see <a href="https://tools.ietf.org/html/rfc7232">RFC 7232</a>.</p>
|
|
2732
|
-
*
|
|
2733
2599
|
* <p>
|
|
2734
2600
|
* <b>Permissions</b>
|
|
2735
2601
|
* </p>
|
|
@@ -2747,7 +2613,6 @@ export declare class S3 extends S3Client {
|
|
|
2747
2613
|
* status code 403 ("access denied") error.</p>
|
|
2748
2614
|
* </li>
|
|
2749
2615
|
* </ul>
|
|
2750
|
-
*
|
|
2751
2616
|
* <p>The following actions are related to <code>HeadObject</code>:</p>
|
|
2752
2617
|
* <ul>
|
|
2753
2618
|
* <li>
|
|
@@ -2768,7 +2633,6 @@ export declare class S3 extends S3Client {
|
|
|
2768
2633
|
/**
|
|
2769
2634
|
* <p>Lists the analytics configurations for the bucket. You can have up to 1,000 analytics
|
|
2770
2635
|
* configurations per bucket.</p>
|
|
2771
|
-
*
|
|
2772
2636
|
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
2773
2637
|
* at a time. You should always check the <code>IsTruncated</code> element in the response. If
|
|
2774
2638
|
* there are no more configurations to list, <code>IsTruncated</code> is set to false. If
|
|
@@ -2777,16 +2641,13 @@ export declare class S3 extends S3Client {
|
|
|
2777
2641
|
* <code>NextContinuationToken</code> value to continue the pagination of the list by
|
|
2778
2642
|
* passing the value in continuation-token in the request to <code>GET</code> the next
|
|
2779
2643
|
* page.</p>
|
|
2780
|
-
*
|
|
2781
2644
|
* <p>To use this operation, you must have permissions to perform the
|
|
2782
2645
|
* <code>s3:GetAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
2783
2646
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
2784
2647
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
2785
2648
|
* Resources</a>.</p>
|
|
2786
|
-
*
|
|
2787
2649
|
* <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
2788
2650
|
* Analysis</a>. </p>
|
|
2789
|
-
*
|
|
2790
2651
|
* <p>The following operations are related to
|
|
2791
2652
|
* <code>ListBucketAnalyticsConfigurations</code>:</p>
|
|
2792
2653
|
* <ul>
|
|
@@ -2841,7 +2702,6 @@ export declare class S3 extends S3Client {
|
|
|
2841
2702
|
/**
|
|
2842
2703
|
* <p>Returns a list of inventory configurations for the bucket. You can have up to 1,000
|
|
2843
2704
|
* analytics configurations per bucket.</p>
|
|
2844
|
-
*
|
|
2845
2705
|
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
2846
2706
|
* at a time. Always check the <code>IsTruncated</code> element in the response. If there are
|
|
2847
2707
|
* no more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
@@ -2849,16 +2709,13 @@ export declare class S3 extends S3Client {
|
|
|
2849
2709
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
2850
2710
|
* to continue the pagination of the list by passing the value in continuation-token in the
|
|
2851
2711
|
* request to <code>GET</code> the next page.</p>
|
|
2852
|
-
*
|
|
2853
2712
|
* <p> To use this operation, you must have permissions to perform the
|
|
2854
2713
|
* <code>s3:GetInventoryConfiguration</code> action. The bucket owner has this permission
|
|
2855
2714
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
2856
2715
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
2857
2716
|
* Resources</a>.</p>
|
|
2858
|
-
*
|
|
2859
2717
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>
|
|
2860
2718
|
* </p>
|
|
2861
|
-
*
|
|
2862
2719
|
* <p>The following operations are related to
|
|
2863
2720
|
* <code>ListBucketInventoryConfigurations</code>:</p>
|
|
2864
2721
|
* <ul>
|
|
@@ -2886,7 +2743,6 @@ export declare class S3 extends S3Client {
|
|
|
2886
2743
|
* <p>Lists the metrics configurations for the bucket. The metrics configurations are only for
|
|
2887
2744
|
* the request metrics of the bucket and do not provide information on daily storage metrics.
|
|
2888
2745
|
* You can have up to 1,000 configurations per bucket.</p>
|
|
2889
|
-
*
|
|
2890
2746
|
* <p>This action supports list pagination and does not return more than 100 configurations
|
|
2891
2747
|
* at a time. Always check the <code>IsTruncated</code> element in the response. If there are
|
|
2892
2748
|
* no more configurations to list, <code>IsTruncated</code> is set to false. If there are more
|
|
@@ -2894,17 +2750,14 @@ export declare class S3 extends S3Client {
|
|
|
2894
2750
|
* <code>NextContinuationToken</code>. You use the <code>NextContinuationToken</code> value
|
|
2895
2751
|
* to continue the pagination of the list by passing the value in
|
|
2896
2752
|
* <code>continuation-token</code> in the request to <code>GET</code> the next page.</p>
|
|
2897
|
-
*
|
|
2898
2753
|
* <p>To use this operation, you must have permissions to perform the
|
|
2899
2754
|
* <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
2900
2755
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
2901
2756
|
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
2902
2757
|
* Resources</a>.</p>
|
|
2903
|
-
*
|
|
2904
2758
|
* <p>For more information about metrics configurations and CloudWatch request metrics, see
|
|
2905
2759
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
2906
2760
|
* CloudWatch</a>.</p>
|
|
2907
|
-
*
|
|
2908
2761
|
* <p>The following operations are related to
|
|
2909
2762
|
* <code>ListBucketMetricsConfigurations</code>:</p>
|
|
2910
2763
|
* <ul>
|
|
@@ -2939,7 +2792,6 @@ export declare class S3 extends S3Client {
|
|
|
2939
2792
|
* <p>This action lists in-progress multipart uploads. An in-progress multipart upload is a
|
|
2940
2793
|
* multipart upload that has been initiated using the Initiate Multipart Upload request, but
|
|
2941
2794
|
* has not yet been completed or aborted.</p>
|
|
2942
|
-
*
|
|
2943
2795
|
* <p>This action returns at most 1,000 multipart uploads in the response. 1,000 multipart
|
|
2944
2796
|
* uploads is the maximum number of uploads a response can include, which is also the default
|
|
2945
2797
|
* value. You can further limit the number of uploads in a response by specifying the
|
|
@@ -2947,18 +2799,14 @@ export declare class S3 extends S3Client {
|
|
|
2947
2799
|
* satisfy the list criteria, the response will contain an <code>IsTruncated</code> element
|
|
2948
2800
|
* with the value true. To list the additional multipart uploads, use the
|
|
2949
2801
|
* <code>key-marker</code> and <code>upload-id-marker</code> request parameters.</p>
|
|
2950
|
-
*
|
|
2951
2802
|
* <p>In the response, the uploads are sorted by key. If your application has initiated more
|
|
2952
2803
|
* than one multipart upload using the same object key, then uploads in the response are first
|
|
2953
2804
|
* sorted by key. Additionally, uploads are sorted in ascending order within each key by the
|
|
2954
2805
|
* upload initiation time.</p>
|
|
2955
|
-
*
|
|
2956
2806
|
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
2957
2807
|
* Upload</a>.</p>
|
|
2958
|
-
*
|
|
2959
2808
|
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
2960
2809
|
* Permissions</a>.</p>
|
|
2961
|
-
*
|
|
2962
2810
|
* <p>The following operations are related to <code>ListMultipartUploads</code>:</p>
|
|
2963
2811
|
* <ul>
|
|
2964
2812
|
* <li>
|
|
@@ -3000,8 +2848,6 @@ export declare class S3 extends S3Client {
|
|
|
3000
2848
|
* <p>This action has been revised. We recommend that you use the newer version, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html">ListObjectsV2</a>, when developing applications. For backward compatibility,
|
|
3001
2849
|
* Amazon S3 continues to support <code>ListObjects</code>.</p>
|
|
3002
2850
|
* </important>
|
|
3003
|
-
*
|
|
3004
|
-
*
|
|
3005
2851
|
* <p>The following operations are related to <code>ListObjects</code>:</p>
|
|
3006
2852
|
* <ul>
|
|
3007
2853
|
* <li>
|
|
@@ -3043,9 +2889,7 @@ export declare class S3 extends S3Client {
|
|
|
3043
2889
|
* For more information about listing objects, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html">Listing object keys
|
|
3044
2890
|
* programmatically</a>
|
|
3045
2891
|
* </p>
|
|
3046
|
-
*
|
|
3047
2892
|
* <p>To use this operation, you must have READ access to the bucket.</p>
|
|
3048
|
-
*
|
|
3049
2893
|
* <p>To use this action in an Identity and Access Management (IAM) policy, you must
|
|
3050
2894
|
* have permissions to perform the <code>s3:ListBucket</code> action. The bucket owner has
|
|
3051
2895
|
* this permission by default and can grant this permission to others. For more information
|
|
@@ -3056,9 +2900,7 @@ export declare class S3 extends S3Client {
|
|
|
3056
2900
|
* revised API for application development. For backward compatibility, Amazon S3 continues to
|
|
3057
2901
|
* support the prior version of this API, <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html">ListObjects</a>.</p>
|
|
3058
2902
|
* </important>
|
|
3059
|
-
*
|
|
3060
2903
|
* <p>To get a list of your buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html">ListBuckets</a>.</p>
|
|
3061
|
-
*
|
|
3062
2904
|
* <p>The following operations are related to <code>ListObjectsV2</code>:</p>
|
|
3063
2905
|
* <ul>
|
|
3064
2906
|
* <li>
|
|
@@ -3139,13 +2981,10 @@ export declare class S3 extends S3Client {
|
|
|
3139
2981
|
* <p>If the upload was created using a checksum algorithm, you will need to have permission
|
|
3140
2982
|
* to the <code>kms:Decrypt</code> action for the request to succeed.
|
|
3141
2983
|
* </p>
|
|
3142
|
-
*
|
|
3143
2984
|
* <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
3144
2985
|
* Upload</a>.</p>
|
|
3145
|
-
*
|
|
3146
2986
|
* <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
3147
2987
|
* Permissions</a>.</p>
|
|
3148
|
-
*
|
|
3149
2988
|
* <p>The following operations are related to <code>ListParts</code>:</p>
|
|
3150
2989
|
* <ul>
|
|
3151
2990
|
* <li>
|
|
@@ -3186,13 +3025,11 @@ export declare class S3 extends S3Client {
|
|
|
3186
3025
|
/**
|
|
3187
3026
|
* <p>Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a
|
|
3188
3027
|
* bucket-level feature that enables you to perform faster data transfers to Amazon S3.</p>
|
|
3189
|
-
*
|
|
3190
3028
|
* <p> To use this operation, you must have permission to perform the
|
|
3191
3029
|
* <code>s3:PutAccelerateConfiguration</code> action. The bucket owner has this permission
|
|
3192
3030
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
3193
3031
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
3194
3032
|
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
3195
|
-
*
|
|
3196
3033
|
* <p> The Transfer Acceleration state of a bucket can be set to one of the following two
|
|
3197
3034
|
* values:</p>
|
|
3198
3035
|
* <ul>
|
|
@@ -3203,19 +3040,13 @@ export declare class S3 extends S3Client {
|
|
|
3203
3040
|
* <p> Suspended – Disables accelerated data transfers to the bucket.</p>
|
|
3204
3041
|
* </li>
|
|
3205
3042
|
* </ul>
|
|
3206
|
-
*
|
|
3207
|
-
*
|
|
3208
3043
|
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html">GetBucketAccelerateConfiguration</a> action returns the transfer acceleration
|
|
3209
3044
|
* state of a bucket.</p>
|
|
3210
|
-
*
|
|
3211
3045
|
* <p>After setting the Transfer Acceleration state of a bucket to Enabled, it might take up
|
|
3212
3046
|
* to thirty minutes before the data transfer rates to the bucket increase.</p>
|
|
3213
|
-
*
|
|
3214
3047
|
* <p> The name of the bucket used for Transfer Acceleration must be DNS-compliant and must
|
|
3215
3048
|
* not contain periods (".").</p>
|
|
3216
|
-
*
|
|
3217
3049
|
* <p> For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a>.</p>
|
|
3218
|
-
*
|
|
3219
3050
|
* <p>The following operations are related to
|
|
3220
3051
|
* <code>PutBucketAccelerateConfiguration</code>:</p>
|
|
3221
3052
|
* <ul>
|
|
@@ -3238,7 +3069,6 @@ export declare class S3 extends S3Client {
|
|
|
3238
3069
|
* <p>Sets the permissions on an existing bucket using access control lists (ACL). For more
|
|
3239
3070
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set
|
|
3240
3071
|
* the ACL of a bucket, you must have <code>WRITE_ACP</code> permission.</p>
|
|
3241
|
-
*
|
|
3242
3072
|
* <p>You can use one of the following two ways to set a bucket's permissions:</p>
|
|
3243
3073
|
* <ul>
|
|
3244
3074
|
* <li>
|
|
@@ -3248,17 +3078,14 @@ export declare class S3 extends S3Client {
|
|
|
3248
3078
|
* <p>Specify permissions using request headers</p>
|
|
3249
3079
|
* </li>
|
|
3250
3080
|
* </ul>
|
|
3251
|
-
*
|
|
3252
3081
|
* <note>
|
|
3253
3082
|
* <p>You cannot specify access permission using both the body and the request
|
|
3254
3083
|
* headers.</p>
|
|
3255
3084
|
* </note>
|
|
3256
|
-
*
|
|
3257
3085
|
* <p>Depending on your application needs, you may choose to set the ACL on a bucket using
|
|
3258
3086
|
* either the request body or the headers. For example, if you have an existing application
|
|
3259
3087
|
* that updates a bucket ACL using the request body, then you can continue to use that
|
|
3260
3088
|
* approach.</p>
|
|
3261
|
-
*
|
|
3262
3089
|
* <important>
|
|
3263
3090
|
* <p>If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions.
|
|
3264
3091
|
* You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and
|
|
@@ -3342,7 +3169,6 @@ export declare class S3 extends S3Client {
|
|
|
3342
3169
|
* <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
|
|
3343
3170
|
* id="111122223333", id="555566667777" </code>
|
|
3344
3171
|
* </p>
|
|
3345
|
-
*
|
|
3346
3172
|
* </li>
|
|
3347
3173
|
* </ul>
|
|
3348
3174
|
* <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
|
|
@@ -3409,8 +3235,6 @@ export declare class S3 extends S3Client {
|
|
|
3409
3235
|
* </note>
|
|
3410
3236
|
* </li>
|
|
3411
3237
|
* </ul>
|
|
3412
|
-
*
|
|
3413
|
-
*
|
|
3414
3238
|
* <p class="title">
|
|
3415
3239
|
* <b>Related Resources</b>
|
|
3416
3240
|
* </p>
|
|
@@ -3438,7 +3262,6 @@ export declare class S3 extends S3Client {
|
|
|
3438
3262
|
/**
|
|
3439
3263
|
* <p>Sets an analytics configuration for the bucket (specified by the analytics configuration
|
|
3440
3264
|
* ID). You can have up to 1,000 analytics configurations per bucket.</p>
|
|
3441
|
-
*
|
|
3442
3265
|
* <p>You can choose to have storage class analysis export analysis reports sent to a
|
|
3443
3266
|
* comma-separated values (CSV) flat file. See the <code>DataExport</code> request element.
|
|
3444
3267
|
* Reports are updated daily and are based on the object filters that you configure. When
|
|
@@ -3447,20 +3270,16 @@ export declare class S3 extends S3Client {
|
|
|
3447
3270
|
* account. However, the destination bucket must be in the same Region as the bucket that you
|
|
3448
3271
|
* are making the PUT analytics configuration to. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
3449
3272
|
* Analysis</a>. </p>
|
|
3450
|
-
*
|
|
3451
3273
|
* <important>
|
|
3452
3274
|
* <p>You must create a bucket policy on the destination bucket where the exported file is
|
|
3453
3275
|
* written to grant permissions to Amazon S3 to write objects to the bucket. For an example
|
|
3454
3276
|
* policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9">Granting Permissions for Amazon S3 Inventory and Storage Class Analysis</a>.</p>
|
|
3455
3277
|
* </important>
|
|
3456
|
-
*
|
|
3457
3278
|
* <p>To use this operation, you must have permissions to perform the
|
|
3458
3279
|
* <code>s3:PutAnalyticsConfiguration</code> action. The bucket owner has this permission
|
|
3459
3280
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
3460
3281
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
3461
3282
|
* Resources</a>.</p>
|
|
3462
|
-
*
|
|
3463
|
-
*
|
|
3464
3283
|
* <p class="title">
|
|
3465
3284
|
* <b>Special Errors</b>
|
|
3466
3285
|
* </p>
|
|
@@ -3526,12 +3345,6 @@ export declare class S3 extends S3Client {
|
|
|
3526
3345
|
* </ul>
|
|
3527
3346
|
* </li>
|
|
3528
3347
|
* </ul>
|
|
3529
|
-
*
|
|
3530
|
-
*
|
|
3531
|
-
*
|
|
3532
|
-
*
|
|
3533
|
-
*
|
|
3534
|
-
*
|
|
3535
3348
|
* <p class="title">
|
|
3536
3349
|
* <b>Related Resources</b>
|
|
3537
3350
|
* </p>
|
|
@@ -3593,7 +3406,6 @@ export declare class S3 extends S3Client {
|
|
|
3593
3406
|
* </ul>
|
|
3594
3407
|
* <p> For more information about CORS, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
3595
3408
|
* Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3596
|
-
*
|
|
3597
3409
|
* <p class="title">
|
|
3598
3410
|
* <b>Related Resources</b>
|
|
3599
3411
|
* </p>
|
|
@@ -3638,7 +3450,6 @@ export declare class S3 extends S3Client {
|
|
|
3638
3450
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
3639
3451
|
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
3640
3452
|
* Resources</a> in the Amazon S3 User Guide. </p>
|
|
3641
|
-
*
|
|
3642
3453
|
* <p class="title">
|
|
3643
3454
|
* <b>Related Resources</b>
|
|
3644
3455
|
* </p>
|
|
@@ -3688,7 +3499,6 @@ export declare class S3 extends S3Client {
|
|
|
3688
3499
|
* move objects stored in the S3 Intelligent-Tiering storage class to the
|
|
3689
3500
|
* Archive Access or Deep Archive Access tier.</p>
|
|
3690
3501
|
* </note>
|
|
3691
|
-
*
|
|
3692
3502
|
* <p class="title">
|
|
3693
3503
|
* <b>Special Errors</b>
|
|
3694
3504
|
* </p>
|
|
@@ -3773,7 +3583,6 @@ export declare class S3 extends S3Client {
|
|
|
3773
3583
|
* by default and can grant this permission to others. For more information about permissions,
|
|
3774
3584
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
3775
3585
|
* Resources</a> in the Amazon S3 User Guide.</p>
|
|
3776
|
-
*
|
|
3777
3586
|
* <p class="title">
|
|
3778
3587
|
* <b>Special Errors</b>
|
|
3779
3588
|
* </p>
|
|
@@ -3827,7 +3636,6 @@ export declare class S3 extends S3Client {
|
|
|
3827
3636
|
* </ul>
|
|
3828
3637
|
* </li>
|
|
3829
3638
|
* </ul>
|
|
3830
|
-
*
|
|
3831
3639
|
* <p class="title">
|
|
3832
3640
|
* <b>Related Resources</b>
|
|
3833
3641
|
* </p>
|
|
@@ -3858,7 +3666,6 @@ export declare class S3 extends S3Client {
|
|
|
3858
3666
|
* you want to retain any configuration details, they must be included in the new lifecycle
|
|
3859
3667
|
* configuration. For information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage
|
|
3860
3668
|
* lifecycle</a>.</p>
|
|
3861
|
-
*
|
|
3862
3669
|
* <note>
|
|
3863
3670
|
* <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an
|
|
3864
3671
|
* object key name prefix, one or more object tags, or a combination of both. Accordingly,
|
|
@@ -3866,9 +3673,6 @@ export declare class S3 extends S3Client {
|
|
|
3866
3673
|
* filtering based only on an object key name prefix, which is supported for backward
|
|
3867
3674
|
* compatibility. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>.</p>
|
|
3868
3675
|
* </note>
|
|
3869
|
-
*
|
|
3870
|
-
*
|
|
3871
|
-
*
|
|
3872
3676
|
* <p>
|
|
3873
3677
|
* <b>Rules</b>
|
|
3874
3678
|
* </p>
|
|
@@ -3876,7 +3680,6 @@ export declare class S3 extends S3Client {
|
|
|
3876
3680
|
* configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle
|
|
3877
3681
|
* configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists
|
|
3878
3682
|
* of the following:</p>
|
|
3879
|
-
*
|
|
3880
3683
|
* <ul>
|
|
3881
3684
|
* <li>
|
|
3882
3685
|
* <p>Filter identifying a subset of objects to which the rule applies. The filter can
|
|
@@ -3894,27 +3697,20 @@ export declare class S3 extends S3Client {
|
|
|
3894
3697
|
* versions.</p>
|
|
3895
3698
|
* </li>
|
|
3896
3699
|
* </ul>
|
|
3897
|
-
*
|
|
3898
3700
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object
|
|
3899
3701
|
* Lifecycle Management</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle Configuration Elements</a>.</p>
|
|
3900
|
-
*
|
|
3901
|
-
*
|
|
3902
3702
|
* <p>
|
|
3903
3703
|
* <b>Permissions</b>
|
|
3904
3704
|
* </p>
|
|
3905
|
-
*
|
|
3906
|
-
*
|
|
3907
3705
|
* <p>By default, all Amazon S3 resources are private, including buckets, objects, and related
|
|
3908
3706
|
* subresources (for example, lifecycle configuration and website configuration). Only the
|
|
3909
3707
|
* resource owner (that is, the Amazon Web Services account that created it) can access the resource. The
|
|
3910
3708
|
* resource owner can optionally grant access permissions to others by writing an access
|
|
3911
3709
|
* policy. For this operation, a user must get the <code>s3:PutLifecycleConfiguration</code>
|
|
3912
3710
|
* permission.</p>
|
|
3913
|
-
*
|
|
3914
3711
|
* <p>You can also explicitly deny permissions. Explicit deny also supersedes any other
|
|
3915
3712
|
* permissions. If you want to block users or accounts from removing or deleting objects from
|
|
3916
3713
|
* your bucket, you must deny them permissions for the following actions:</p>
|
|
3917
|
-
*
|
|
3918
3714
|
* <ul>
|
|
3919
3715
|
* <li>
|
|
3920
3716
|
* <p>
|
|
@@ -3932,11 +3728,8 @@ export declare class S3 extends S3Client {
|
|
|
3932
3728
|
* </p>
|
|
3933
3729
|
* </li>
|
|
3934
3730
|
* </ul>
|
|
3935
|
-
*
|
|
3936
|
-
*
|
|
3937
3731
|
* <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
3938
3732
|
* Resources</a>.</p>
|
|
3939
|
-
*
|
|
3940
3733
|
* <p>The following are related to <code>PutBucketLifecycleConfiguration</code>:</p>
|
|
3941
3734
|
* <ul>
|
|
3942
3735
|
* <li>
|
|
@@ -3964,7 +3757,6 @@ export declare class S3 extends S3Client {
|
|
|
3964
3757
|
* <p>Set the logging parameters for a bucket and to specify permissions for who can view and
|
|
3965
3758
|
* modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the
|
|
3966
3759
|
* source bucket. To set the logging status of a bucket, you must be the bucket owner.</p>
|
|
3967
|
-
*
|
|
3968
3760
|
* <p>The bucket owner is automatically granted FULL_CONTROL to all logs. You use the <code>Grantee</code> request element to grant access to other people. The
|
|
3969
3761
|
* <code>Permissions</code> request element specifies the kind of access the grantee has to
|
|
3970
3762
|
* the logs.</p>
|
|
@@ -3974,13 +3766,11 @@ export declare class S3 extends S3Client {
|
|
|
3974
3766
|
* to grant access to others. Permissions can only be granted using policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the
|
|
3975
3767
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
3976
3768
|
* </important>
|
|
3977
|
-
*
|
|
3978
3769
|
* <p>
|
|
3979
3770
|
* <b>Grantee Values</b>
|
|
3980
3771
|
* </p>
|
|
3981
3772
|
* <p>You can specify the person (grantee) to whom you're assigning access rights (using
|
|
3982
3773
|
* request elements) in the following ways:</p>
|
|
3983
|
-
*
|
|
3984
3774
|
* <ul>
|
|
3985
3775
|
* <li>
|
|
3986
3776
|
* <p>By the person's ID:</p>
|
|
@@ -4008,21 +3798,15 @@ export declare class S3 extends S3Client {
|
|
|
4008
3798
|
* </p>
|
|
4009
3799
|
* </li>
|
|
4010
3800
|
* </ul>
|
|
4011
|
-
*
|
|
4012
|
-
*
|
|
4013
3801
|
* <p>To enable logging, you use LoggingEnabled and its children request elements. To disable
|
|
4014
3802
|
* logging, you use an empty BucketLoggingStatus request element:</p>
|
|
4015
|
-
*
|
|
4016
3803
|
* <p>
|
|
4017
3804
|
* <code><BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01"
|
|
4018
3805
|
* /></code>
|
|
4019
3806
|
* </p>
|
|
4020
|
-
*
|
|
4021
3807
|
* <p>For more information about server access logging, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html">Server Access Logging</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
4022
|
-
*
|
|
4023
3808
|
* <p>For more information about creating a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>. For more
|
|
4024
3809
|
* information about returning the logging status of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html">GetBucketLogging</a>.</p>
|
|
4025
|
-
*
|
|
4026
3810
|
* <p>The following operations are related to <code>PutBucketLogging</code>:</p>
|
|
4027
3811
|
* <ul>
|
|
4028
3812
|
* <li>
|
|
@@ -4055,16 +3839,13 @@ export declare class S3 extends S3Client {
|
|
|
4055
3839
|
* You can have up to 1,000 metrics configurations per bucket. If you're updating an existing
|
|
4056
3840
|
* metrics configuration, note that this is a full replacement of the existing metrics
|
|
4057
3841
|
* configuration. If you don't include the elements you want to keep, they are erased.</p>
|
|
4058
|
-
*
|
|
4059
3842
|
* <p>To use this operation, you must have permissions to perform the
|
|
4060
3843
|
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
4061
3844
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
4062
3845
|
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
4063
3846
|
* Resources</a>.</p>
|
|
4064
|
-
*
|
|
4065
3847
|
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
4066
3848
|
* CloudWatch</a>.</p>
|
|
4067
|
-
*
|
|
4068
3849
|
* <p>The following operations are related to
|
|
4069
3850
|
* <code>PutBucketMetricsConfiguration</code>:</p>
|
|
4070
3851
|
* <ul>
|
|
@@ -4084,7 +3865,6 @@ export declare class S3 extends S3Client {
|
|
|
4084
3865
|
* </p>
|
|
4085
3866
|
* </li>
|
|
4086
3867
|
* </ul>
|
|
4087
|
-
*
|
|
4088
3868
|
* <p>
|
|
4089
3869
|
* <code>GetBucketLifecycle</code> has the following special error:</p>
|
|
4090
3870
|
* <ul>
|
|
@@ -4110,15 +3890,12 @@ export declare class S3 extends S3Client {
|
|
|
4110
3890
|
* <p>Enables notifications of specified events for a bucket. For more information about event
|
|
4111
3891
|
* notifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Event
|
|
4112
3892
|
* Notifications</a>.</p>
|
|
4113
|
-
*
|
|
4114
3893
|
* <p>Using this API, you can replace an existing notification configuration. The
|
|
4115
3894
|
* configuration is an XML file that defines the event types that you want Amazon S3 to publish and
|
|
4116
3895
|
* the destination where you want Amazon S3 to publish an event notification when it detects an
|
|
4117
3896
|
* event of the specified type.</p>
|
|
4118
|
-
*
|
|
4119
3897
|
* <p>By default, your bucket has no event notifications configured. That is, the notification
|
|
4120
3898
|
* configuration will be an empty <code>NotificationConfiguration</code>.</p>
|
|
4121
|
-
*
|
|
4122
3899
|
* <p>
|
|
4123
3900
|
* <code><NotificationConfiguration></code>
|
|
4124
3901
|
* </p>
|
|
@@ -4127,7 +3904,6 @@ export declare class S3 extends S3Client {
|
|
|
4127
3904
|
* </p>
|
|
4128
3905
|
* <p>This action replaces the existing notification configuration with the configuration
|
|
4129
3906
|
* you include in the request body.</p>
|
|
4130
|
-
*
|
|
4131
3907
|
* <p>After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification
|
|
4132
3908
|
* Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and
|
|
4133
3909
|
* that the bucket owner has permission to publish to it by sending a test notification. In
|
|
@@ -4135,7 +3911,6 @@ export declare class S3 extends S3Client {
|
|
|
4135
3911
|
* grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,
|
|
4136
3912
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Configuring Notifications for Amazon S3
|
|
4137
3913
|
* Events</a>.</p>
|
|
4138
|
-
*
|
|
4139
3914
|
* <p>You can disable notifications by adding the empty NotificationConfiguration
|
|
4140
3915
|
* element.</p>
|
|
4141
3916
|
* <p>For more information about the number of event notification configurations that you can create per bucket, see
|
|
@@ -4143,7 +3918,6 @@ export declare class S3 extends S3Client {
|
|
|
4143
3918
|
* <p>By default, only the bucket owner can configure notifications on a bucket. However,
|
|
4144
3919
|
* bucket owners can use a bucket policy to grant permission to other users to set this
|
|
4145
3920
|
* configuration with <code>s3:PutBucketNotification</code> permission.</p>
|
|
4146
|
-
*
|
|
4147
3921
|
* <note>
|
|
4148
3922
|
* <p>The PUT notification is an atomic operation. For example, suppose your notification
|
|
4149
3923
|
* configuration includes SNS topic, SQS queue, and Lambda function configurations. When
|
|
@@ -4151,7 +3925,6 @@ export declare class S3 extends S3Client {
|
|
|
4151
3925
|
* topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add
|
|
4152
3926
|
* the configuration to your bucket.</p>
|
|
4153
3927
|
* </note>
|
|
4154
|
-
*
|
|
4155
3928
|
* <p>
|
|
4156
3929
|
* <b>Responses</b>
|
|
4157
3930
|
* </p>
|
|
@@ -4160,7 +3933,6 @@ export declare class S3 extends S3Client {
|
|
|
4160
3933
|
* <code>s3:ReducedRedundancyLostObject</code> event type, the response will also include
|
|
4161
3934
|
* the <code>x-amz-sns-test-message-id</code> header containing the message ID of the test
|
|
4162
3935
|
* notification sent to the topic.</p>
|
|
4163
|
-
*
|
|
4164
3936
|
* <p>The following action is related to
|
|
4165
3937
|
* <code>PutBucketNotificationConfiguration</code>:</p>
|
|
4166
3938
|
* <ul>
|
|
@@ -4201,19 +3973,16 @@ export declare class S3 extends S3Client {
|
|
|
4201
3973
|
* the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the
|
|
4202
3974
|
* <code>PutBucketPolicy</code> permissions on the specified bucket and belong to the
|
|
4203
3975
|
* bucket owner's account in order to use this operation.</p>
|
|
4204
|
-
*
|
|
4205
3976
|
* <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403
|
|
4206
3977
|
* Access Denied</code> error. If you have the correct permissions, but you're not using an
|
|
4207
3978
|
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
|
|
4208
3979
|
* Allowed</code> error.</p>
|
|
4209
|
-
*
|
|
4210
3980
|
* <important>
|
|
4211
3981
|
* <p> As a security precaution, the root user of the Amazon Web Services account that owns a bucket can
|
|
4212
3982
|
* always use this operation, even if the policy explicitly denies the root user the
|
|
4213
3983
|
* ability to perform this action. </p>
|
|
4214
3984
|
* </important>
|
|
4215
3985
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html">Bucket policy examples</a>.</p>
|
|
4216
|
-
*
|
|
4217
3986
|
* <p>The following operations are related to <code>PutBucketPolicy</code>:</p>
|
|
4218
3987
|
* <ul>
|
|
4219
3988
|
* <li>
|
|
@@ -4234,18 +4003,14 @@ export declare class S3 extends S3Client {
|
|
|
4234
4003
|
/**
|
|
4235
4004
|
* <p> Creates a replication configuration or replaces an existing one. For more information,
|
|
4236
4005
|
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the <i>Amazon S3 User Guide</i>. </p>
|
|
4237
|
-
*
|
|
4238
4006
|
* <p>Specify the replication configuration in the request body. In the replication
|
|
4239
4007
|
* configuration, you provide the name of the destination bucket or buckets where you want
|
|
4240
4008
|
* Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your
|
|
4241
4009
|
* behalf, and other relevant information.</p>
|
|
4242
|
-
*
|
|
4243
|
-
*
|
|
4244
4010
|
* <p>A replication configuration must include at least one rule, and can contain a maximum of
|
|
4245
4011
|
* 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in
|
|
4246
4012
|
* the source bucket. To choose additional subsets of objects to replicate, add a rule for
|
|
4247
4013
|
* each subset.</p>
|
|
4248
|
-
*
|
|
4249
4014
|
* <p>To specify a subset of the objects in the source bucket to apply a replication rule to,
|
|
4250
4015
|
* add the Filter element as a child of the Rule element. You can filter objects based on an
|
|
4251
4016
|
* object key prefix, one or more object tags, or both. When you add the Filter element in the
|
|
@@ -4257,7 +4022,6 @@ export declare class S3 extends S3Client {
|
|
|
4257
4022
|
* replication of delete markers differently. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations">Backward Compatibility</a>.</p>
|
|
4258
4023
|
* </note>
|
|
4259
4024
|
* <p>For information about enabling versioning on a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html">Using Versioning</a>.</p>
|
|
4260
|
-
*
|
|
4261
4025
|
* <p>
|
|
4262
4026
|
* <b>Handling Replication of Encrypted Objects</b>
|
|
4263
4027
|
* </p>
|
|
@@ -4268,11 +4032,9 @@ export declare class S3 extends S3Client {
|
|
|
4268
4032
|
* <code>ReplicaKmsKeyID</code>. For information about replication configuration, see
|
|
4269
4033
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html">Replicating Objects
|
|
4270
4034
|
* Created with SSE Using KMS keys</a>.</p>
|
|
4271
|
-
*
|
|
4272
4035
|
* <p>For information on <code>PutBucketReplication</code> errors, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList">List of
|
|
4273
4036
|
* replication-related error codes</a>
|
|
4274
4037
|
* </p>
|
|
4275
|
-
*
|
|
4276
4038
|
* <p>
|
|
4277
4039
|
* <b>Permissions</b>
|
|
4278
4040
|
* </p>
|
|
@@ -4288,7 +4050,6 @@ export declare class S3 extends S3Client {
|
|
|
4288
4050
|
* <p>To perform this operation, the user or role performing the action must have the
|
|
4289
4051
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">iam:PassRole</a> permission.</p>
|
|
4290
4052
|
* </note>
|
|
4291
|
-
*
|
|
4292
4053
|
* <p>The following operations are related to <code>PutBucketReplication</code>:</p>
|
|
4293
4054
|
* <ul>
|
|
4294
4055
|
* <li>
|
|
@@ -4312,7 +4073,6 @@ export declare class S3 extends S3Client {
|
|
|
4312
4073
|
* to specify that the person requesting the download will be charged for the download. For
|
|
4313
4074
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html">Requester Pays
|
|
4314
4075
|
* Buckets</a>.</p>
|
|
4315
|
-
*
|
|
4316
4076
|
* <p>The following operations are related to <code>PutBucketRequestPayment</code>:</p>
|
|
4317
4077
|
* <ul>
|
|
4318
4078
|
* <li>
|
|
@@ -4340,7 +4100,6 @@ export declare class S3 extends S3Client {
|
|
|
4340
4100
|
* across several services. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Cost Allocation
|
|
4341
4101
|
* and Tagging</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html">Using Cost Allocation in Amazon S3 Bucket
|
|
4342
4102
|
* Tags</a>.</p>
|
|
4343
|
-
*
|
|
4344
4103
|
* <note>
|
|
4345
4104
|
* <p>
|
|
4346
4105
|
* When this operation sets the tags for a bucket, it will overwrite any current tags the
|
|
@@ -4350,7 +4109,6 @@ export declare class S3 extends S3Client {
|
|
|
4350
4109
|
* <code>s3:PutBucketTagging</code> action. The bucket owner has this permission by default
|
|
4351
4110
|
* and can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
|
|
4352
4111
|
* Resources</a>.</p>
|
|
4353
|
-
*
|
|
4354
4112
|
* <p>
|
|
4355
4113
|
* <code>PutBucketTagging</code> has the following special errors:</p>
|
|
4356
4114
|
* <ul>
|
|
@@ -4395,8 +4153,6 @@ export declare class S3 extends S3Client {
|
|
|
4395
4153
|
* </ul>
|
|
4396
4154
|
* </li>
|
|
4397
4155
|
* </ul>
|
|
4398
|
-
*
|
|
4399
|
-
*
|
|
4400
4156
|
* <p>The following operations are related to <code>PutBucketTagging</code>:</p>
|
|
4401
4157
|
* <ul>
|
|
4402
4158
|
* <li>
|
|
@@ -4417,24 +4173,19 @@ export declare class S3 extends S3Client {
|
|
|
4417
4173
|
/**
|
|
4418
4174
|
* <p>Sets the versioning state of an existing bucket.</p>
|
|
4419
4175
|
* <p>You can set the versioning state with one of the following values:</p>
|
|
4420
|
-
*
|
|
4421
4176
|
* <p>
|
|
4422
4177
|
* <b>Enabled</b>—Enables versioning for the objects in the
|
|
4423
4178
|
* bucket. All objects added to the bucket receive a unique version ID.</p>
|
|
4424
|
-
*
|
|
4425
4179
|
* <p>
|
|
4426
4180
|
* <b>Suspended</b>—Disables versioning for the objects in the
|
|
4427
4181
|
* bucket. All objects added to the bucket receive the version ID null.</p>
|
|
4428
|
-
*
|
|
4429
4182
|
* <p>If the versioning state has never been set on a bucket, it has no versioning state; a
|
|
4430
4183
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a> request does not return a versioning state value.</p>
|
|
4431
|
-
*
|
|
4432
4184
|
* <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner
|
|
4433
4185
|
* and want to enable MFA Delete in the bucket versioning configuration, you must
|
|
4434
4186
|
* include the <code>x-amz-mfa request</code> header and the
|
|
4435
4187
|
* <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set
|
|
4436
4188
|
* the versioning state of the bucket.</p>
|
|
4437
|
-
*
|
|
4438
4189
|
* <important>
|
|
4439
4190
|
* <p>If you have an object expiration lifecycle policy in your non-versioned bucket and
|
|
4440
4191
|
* you want to maintain the same permanent delete behavior when you enable versioning, you
|
|
@@ -4443,7 +4194,6 @@ export declare class S3 extends S3Client {
|
|
|
4443
4194
|
* version-enabled bucket maintains one current and zero or more noncurrent object
|
|
4444
4195
|
* versions.) For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config">Lifecycle and Versioning</a>.</p>
|
|
4445
4196
|
* </important>
|
|
4446
|
-
*
|
|
4447
4197
|
* <p class="title">
|
|
4448
4198
|
* <b>Related Resources</b>
|
|
4449
4199
|
* </p>
|
|
@@ -4473,12 +4223,10 @@ export declare class S3 extends S3Client {
|
|
|
4473
4223
|
* subresource. To configure a bucket as a website, you can add this subresource on the bucket
|
|
4474
4224
|
* with website configuration information such as the file name of the index document and any
|
|
4475
4225
|
* redirect rules. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a>.</p>
|
|
4476
|
-
*
|
|
4477
4226
|
* <p>This PUT action requires the <code>S3:PutBucketWebsite</code> permission. By default,
|
|
4478
4227
|
* only the bucket owner can configure the website attached to a bucket; however, bucket
|
|
4479
4228
|
* owners can allow other users to set the website configuration by writing a bucket policy
|
|
4480
4229
|
* that grants them the <code>S3:PutBucketWebsite</code> permission.</p>
|
|
4481
|
-
*
|
|
4482
4230
|
* <p>To redirect all website requests sent to the bucket's website endpoint, you add a
|
|
4483
4231
|
* website configuration with the following elements. Because all requests are sent to another
|
|
4484
4232
|
* website, you don't need to provide index document name for the bucket.</p>
|
|
@@ -4504,7 +4252,6 @@ export declare class S3 extends S3Client {
|
|
|
4504
4252
|
* </p>
|
|
4505
4253
|
* </li>
|
|
4506
4254
|
* </ul>
|
|
4507
|
-
*
|
|
4508
4255
|
* <p>If you want granular control over redirects, you can use the following elements to add
|
|
4509
4256
|
* routing rules that describe conditions for redirecting requests and information about the
|
|
4510
4257
|
* redirect destination. In this case, the website configuration must provide an index
|
|
@@ -4591,7 +4338,6 @@ export declare class S3 extends S3Client {
|
|
|
4591
4338
|
* </p>
|
|
4592
4339
|
* </li>
|
|
4593
4340
|
* </ul>
|
|
4594
|
-
*
|
|
4595
4341
|
* <p>Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more
|
|
4596
4342
|
* than 50 routing rules, you can use object redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">Configuring an
|
|
4597
4343
|
* Object Redirect</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
@@ -4602,16 +4348,12 @@ export declare class S3 extends S3Client {
|
|
|
4602
4348
|
/**
|
|
4603
4349
|
* <p>Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object
|
|
4604
4350
|
* to it.</p>
|
|
4605
|
-
*
|
|
4606
|
-
*
|
|
4607
4351
|
* <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the
|
|
4608
4352
|
* entire object to the bucket.</p>
|
|
4609
|
-
*
|
|
4610
4353
|
* <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object
|
|
4611
4354
|
* simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object
|
|
4612
4355
|
* locking; if you need this, make sure to build it into your application layer or use
|
|
4613
4356
|
* versioning instead.</p>
|
|
4614
|
-
*
|
|
4615
4357
|
* <p>To ensure that data is not corrupted traversing the network, use the
|
|
4616
4358
|
* <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object
|
|
4617
4359
|
* against the provided MD5 value and, if they do not match, returns an error. Additionally,
|
|
@@ -4678,8 +4420,6 @@ export declare class S3 extends S3Client {
|
|
|
4678
4420
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
4679
4421
|
* the OUTPOSTS Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the
|
|
4680
4422
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
4681
|
-
*
|
|
4682
|
-
*
|
|
4683
4423
|
* <p>
|
|
4684
4424
|
* <b>Versioning</b>
|
|
4685
4425
|
* </p>
|
|
@@ -4690,8 +4430,6 @@ export declare class S3 extends S3Client {
|
|
|
4690
4430
|
* <p>For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to
|
|
4691
4431
|
* Versioning Enabled Buckets</a>. For information about returning the versioning state
|
|
4692
4432
|
* of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. </p>
|
|
4693
|
-
*
|
|
4694
|
-
*
|
|
4695
4433
|
* <p class="title">
|
|
4696
4434
|
* <b>Related Resources</b>
|
|
4697
4435
|
* </p>
|
|
@@ -4728,7 +4466,6 @@ export declare class S3 extends S3Client {
|
|
|
4728
4466
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object ownership</a>
|
|
4729
4467
|
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
4730
4468
|
* </important>
|
|
4731
|
-
*
|
|
4732
4469
|
* <p>
|
|
4733
4470
|
* <b>Access Permissions</b>
|
|
4734
4471
|
* </p>
|
|
@@ -4750,7 +4487,6 @@ export declare class S3 extends S3Client {
|
|
|
4750
4487
|
* <code>x-amz-acl</code> header to set a canned ACL. These parameters map to the set
|
|
4751
4488
|
* of permissions that Amazon S3 supports in an ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL)
|
|
4752
4489
|
* Overview</a>.</p>
|
|
4753
|
-
*
|
|
4754
4490
|
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
|
4755
4491
|
* following:</p>
|
|
4756
4492
|
* <ul>
|
|
@@ -4806,7 +4542,6 @@ export declare class S3 extends S3Client {
|
|
|
4806
4542
|
* <code>x-amz-grant-read: emailAddress="xyz@amazon.com",
|
|
4807
4543
|
* emailAddress="abc@amazon.com" </code>
|
|
4808
4544
|
* </p>
|
|
4809
|
-
*
|
|
4810
4545
|
* </li>
|
|
4811
4546
|
* </ul>
|
|
4812
4547
|
* <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
|
|
@@ -4949,21 +4684,15 @@ export declare class S3 extends S3Client {
|
|
|
4949
4684
|
* <p>A tag is a key-value pair. You can associate tags with an object by sending a PUT
|
|
4950
4685
|
* request against the tagging subresource that is associated with the object. You can
|
|
4951
4686
|
* retrieve tags by sending a GET request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html">GetObjectTagging</a>.</p>
|
|
4952
|
-
*
|
|
4953
4687
|
* <p>For tagging-related restrictions related to characters and encodings, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">Tag
|
|
4954
4688
|
* Restrictions</a>. Note that Amazon S3 limits the maximum number of tags to 10 tags per
|
|
4955
4689
|
* object.</p>
|
|
4956
|
-
*
|
|
4957
4690
|
* <p>To use this operation, you must have permission to perform the
|
|
4958
4691
|
* <code>s3:PutObjectTagging</code> action. By default, the bucket owner has this
|
|
4959
4692
|
* permission and can grant this permission to others.</p>
|
|
4960
|
-
*
|
|
4961
4693
|
* <p>To put tags of any other version, use the <code>versionId</code> query parameter. You
|
|
4962
4694
|
* also need permission for the <code>s3:PutObjectVersionTagging</code> action.</p>
|
|
4963
|
-
*
|
|
4964
4695
|
* <p>For information about the Amazon S3 object tagging feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html">Object Tagging</a>.</p>
|
|
4965
|
-
*
|
|
4966
|
-
*
|
|
4967
4696
|
* <p class="title">
|
|
4968
4697
|
* <b>Special Errors</b>
|
|
4969
4698
|
* </p>
|
|
@@ -5028,12 +4757,6 @@ export declare class S3 extends S3Client {
|
|
|
5028
4757
|
* </ul>
|
|
5029
4758
|
* </li>
|
|
5030
4759
|
* </ul>
|
|
5031
|
-
*
|
|
5032
|
-
*
|
|
5033
|
-
*
|
|
5034
|
-
*
|
|
5035
|
-
*
|
|
5036
|
-
*
|
|
5037
4760
|
* <p class="title">
|
|
5038
4761
|
* <b>Related Resources</b>
|
|
5039
4762
|
* </p>
|
|
@@ -5058,7 +4781,6 @@ export declare class S3 extends S3Client {
|
|
|
5058
4781
|
* To use this operation, you must have the <code>s3:PutBucketPublicAccessBlock</code>
|
|
5059
4782
|
* permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
5060
4783
|
* Policy</a>.</p>
|
|
5061
|
-
*
|
|
5062
4784
|
* <important>
|
|
5063
4785
|
* <p>When Amazon S3 evaluates the <code>PublicAccessBlock</code> configuration for a bucket or
|
|
5064
4786
|
* an object, it checks the <code>PublicAccessBlock</code> configuration for both the
|
|
@@ -5067,12 +4789,7 @@ export declare class S3 extends S3Client {
|
|
|
5067
4789
|
* the account, Amazon S3 uses the most restrictive combination of the bucket-level and
|
|
5068
4790
|
* account-level settings.</p>
|
|
5069
4791
|
* </important>
|
|
5070
|
-
*
|
|
5071
|
-
*
|
|
5072
4792
|
* <p>For more information about when Amazon S3 considers a bucket or an object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a>.</p>
|
|
5073
|
-
*
|
|
5074
|
-
*
|
|
5075
|
-
*
|
|
5076
4793
|
* <p class="title">
|
|
5077
4794
|
* <b>Related Resources</b>
|
|
5078
4795
|
* </p>
|
|
@@ -5366,7 +5083,6 @@ export declare class S3 extends S3Client {
|
|
|
5366
5083
|
* </ul>
|
|
5367
5084
|
* </li>
|
|
5368
5085
|
* </ul>
|
|
5369
|
-
*
|
|
5370
5086
|
* <p class="title">
|
|
5371
5087
|
* <b>Related Resources</b>
|
|
5372
5088
|
* </p>
|
|
@@ -5455,7 +5171,6 @@ export declare class S3 extends S3Client {
|
|
|
5455
5171
|
* Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5456
5172
|
* </li>
|
|
5457
5173
|
* </ul>
|
|
5458
|
-
*
|
|
5459
5174
|
* <p>
|
|
5460
5175
|
* <b>Working with the Response Body</b>
|
|
5461
5176
|
* </p>
|
|
@@ -5463,7 +5178,6 @@ export declare class S3 extends S3Client {
|
|
|
5463
5178
|
* messages and includes a <code>Transfer-Encoding</code> header with <code>chunked</code> as
|
|
5464
5179
|
* its value in the response. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html">Appendix: SelectObjectContent
|
|
5465
5180
|
* Response</a>.</p>
|
|
5466
|
-
*
|
|
5467
5181
|
* <p></p>
|
|
5468
5182
|
* <p>
|
|
5469
5183
|
* <b>GetObject Support</b>
|
|
@@ -5488,7 +5202,6 @@ export declare class S3 extends S3Client {
|
|
|
5488
5202
|
* <p>
|
|
5489
5203
|
* <b>Special Errors</b>
|
|
5490
5204
|
* </p>
|
|
5491
|
-
*
|
|
5492
5205
|
* <p>For a list of special errors for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList">List of
|
|
5493
5206
|
* SELECT Object Content Error Codes</a>
|
|
5494
5207
|
* </p>
|
|
@@ -5524,7 +5237,6 @@ export declare class S3 extends S3Client {
|
|
|
5524
5237
|
* upload a part from an existing object, you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> operation.
|
|
5525
5238
|
* </p>
|
|
5526
5239
|
* </note>
|
|
5527
|
-
*
|
|
5528
5240
|
* <p>You must initiate a multipart upload (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>)
|
|
5529
5241
|
* before you can upload any part. In response to your initiate request, Amazon S3 returns an
|
|
5530
5242
|
* upload ID, a unique identifier, that you must include in your upload part request.</p>
|
|
@@ -5536,27 +5248,21 @@ export declare class S3 extends S3Client {
|
|
|
5536
5248
|
* <p>To ensure that data is not corrupted when traversing the network, specify the
|
|
5537
5249
|
* <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data
|
|
5538
5250
|
* against the provided MD5 value. If they do not match, Amazon S3 returns an error. </p>
|
|
5539
|
-
*
|
|
5540
5251
|
* <p>If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the
|
|
5541
5252
|
* <code>x-amz-content-sha256</code> header as a checksum instead of
|
|
5542
5253
|
* <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version
|
|
5543
5254
|
* 4)</a>. </p>
|
|
5544
|
-
*
|
|
5545
|
-
*
|
|
5546
|
-
*
|
|
5547
5255
|
* <p>
|
|
5548
5256
|
* <b>Note:</b> After you initiate multipart upload and upload
|
|
5549
5257
|
* one or more parts, you must either complete or abort multipart upload in order to stop
|
|
5550
5258
|
* getting charged for storage of the uploaded parts. Only after you either complete or abort
|
|
5551
5259
|
* multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts
|
|
5552
5260
|
* storage.</p>
|
|
5553
|
-
*
|
|
5554
5261
|
* <p>For more information on multipart uploads, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the
|
|
5555
5262
|
* <i>Amazon S3 User Guide </i>.</p>
|
|
5556
5263
|
* <p>For information on the permissions required to use the multipart upload API, go to
|
|
5557
5264
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload and
|
|
5558
5265
|
* Permissions</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5559
|
-
*
|
|
5560
5266
|
* <p>You can optionally request server-side encryption where Amazon S3 encrypts your data as it
|
|
5561
5267
|
* writes it to disks in its data centers and decrypts it for you when you access it. You have
|
|
5562
5268
|
* the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption
|
|
@@ -5564,18 +5270,14 @@ export declare class S3 extends S3Client {
|
|
|
5564
5270
|
* the request must match the headers you used in the request to initiate the upload by using
|
|
5565
5271
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>. For more information, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side Encryption</a> in
|
|
5566
5272
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
5567
|
-
*
|
|
5568
5273
|
* <p>Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are
|
|
5569
5274
|
* using a customer-provided encryption key, you don't need to specify the encryption
|
|
5570
5275
|
* parameters in each UploadPart request. Instead, you only need to specify the server-side
|
|
5571
5276
|
* encryption parameters in the initial Initiate Multipart request. For more information, see
|
|
5572
5277
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>.</p>
|
|
5573
|
-
*
|
|
5574
5278
|
* <p>If you requested server-side encryption using a customer-provided encryption key in your
|
|
5575
5279
|
* initiate multipart upload request, you must provide identical encryption information in
|
|
5576
5280
|
* each part upload using the following headers.</p>
|
|
5577
|
-
*
|
|
5578
|
-
*
|
|
5579
5281
|
* <ul>
|
|
5580
5282
|
* <li>
|
|
5581
5283
|
* <p>x-amz-server-side-encryption-customer-algorithm</p>
|
|
@@ -5587,7 +5289,6 @@ export declare class S3 extends S3Client {
|
|
|
5587
5289
|
* <p>x-amz-server-side-encryption-customer-key-MD5</p>
|
|
5588
5290
|
* </li>
|
|
5589
5291
|
* </ul>
|
|
5590
|
-
*
|
|
5591
5292
|
* <p class="title">
|
|
5592
5293
|
* <b>Special Errors</b>
|
|
5593
5294
|
* </p>
|
|
@@ -5619,12 +5320,6 @@ export declare class S3 extends S3Client {
|
|
|
5619
5320
|
* </ul>
|
|
5620
5321
|
* </li>
|
|
5621
5322
|
* </ul>
|
|
5622
|
-
*
|
|
5623
|
-
*
|
|
5624
|
-
*
|
|
5625
|
-
*
|
|
5626
|
-
*
|
|
5627
|
-
*
|
|
5628
5323
|
* <p class="title">
|
|
5629
5324
|
* <b>Related Resources</b>
|
|
5630
5325
|
* </p>
|
|
@@ -5669,13 +5364,11 @@ export declare class S3 extends S3Client {
|
|
|
5669
5364
|
* <p>Instead of using an existing object as part data, you might use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
|
|
5670
5365
|
* action and provide data in your request.</p>
|
|
5671
5366
|
* </note>
|
|
5672
|
-
*
|
|
5673
5367
|
* <p>You must initiate a multipart upload before you can upload any part. In response to your
|
|
5674
5368
|
* initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in
|
|
5675
5369
|
* your upload part request.</p>
|
|
5676
5370
|
* <p>For more information about using the <code>UploadPartCopy</code> operation, see the
|
|
5677
5371
|
* following:</p>
|
|
5678
|
-
*
|
|
5679
5372
|
* <ul>
|
|
5680
5373
|
* <li>
|
|
5681
5374
|
* <p>For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart
|
|
@@ -5716,7 +5409,6 @@ export declare class S3 extends S3Client {
|
|
|
5716
5409
|
* <code>false</code>;</p>
|
|
5717
5410
|
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
|
|
5718
5411
|
* </p>
|
|
5719
|
-
*
|
|
5720
5412
|
* </li>
|
|
5721
5413
|
* <li>
|
|
5722
5414
|
* <p>
|
|
@@ -5749,7 +5441,6 @@ export declare class S3 extends S3Client {
|
|
|
5749
5441
|
* <p>
|
|
5750
5442
|
* <code>x-amz-copy-source: /bucket/object?versionId=version id</code>
|
|
5751
5443
|
* </p>
|
|
5752
|
-
*
|
|
5753
5444
|
* <p class="title">
|
|
5754
5445
|
* <b>Special Errors</b>
|
|
5755
5446
|
* </p>
|
|
@@ -5796,12 +5487,6 @@ export declare class S3 extends S3Client {
|
|
|
5796
5487
|
* </ul>
|
|
5797
5488
|
* </li>
|
|
5798
5489
|
* </ul>
|
|
5799
|
-
*
|
|
5800
|
-
*
|
|
5801
|
-
*
|
|
5802
|
-
*
|
|
5803
|
-
*
|
|
5804
|
-
*
|
|
5805
5490
|
* <p class="title">
|
|
5806
5491
|
* <b>Related Resources</b>
|
|
5807
5492
|
* </p>
|