@aws-sdk/client-s3 3.315.0 → 3.316.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/S3.js +97 -1302
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-es/S3.js +97 -1302
- package/dist-es/models/models_0.js +2 -0
- package/dist-types/S3.d.ts +100 -5179
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +2 -2
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +14 -22
- package/dist-types/commands/CopyObjectCommand.d.ts +31 -54
- package/dist-types/commands/CreateBucketCommand.d.ts +14 -22
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +49 -75
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +5 -7
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +3 -4
- package/dist-types/commands/DeleteObjectCommand.d.ts +11 -11
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +4 -2
- package/dist-types/commands/DeleteObjectsCommand.d.ts +14 -13
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +4 -5
- package/dist-types/commands/GetBucketAclCommand.d.ts +7 -9
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +4 -5
- package/dist-types/commands/GetBucketCorsCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +7 -7
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/GetBucketLocationCommand.d.ts +0 -4
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +6 -5
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +2 -3
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +3 -4
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +0 -1
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +1 -2
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +2 -1
- package/dist-types/commands/GetObjectAclCommand.d.ts +4 -5
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +28 -23
- package/dist-types/commands/GetObjectCommand.d.ts +18 -20
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -2
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +5 -5
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +1 -1
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +9 -15
- package/dist-types/commands/HeadObjectCommand.d.ts +19 -20
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +4 -4
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +5 -5
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +7 -6
- package/dist-types/commands/ListBucketsCommand.d.ts +1 -3
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +2 -2
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +6 -3
- package/dist-types/commands/ListObjectsV2Command.d.ts +12 -11
- package/dist-types/commands/ListPartsCommand.d.ts +4 -3
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +3 -4
- package/dist-types/commands/PutBucketAclCommand.d.ts +12 -15
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketCorsCommand.d.ts +2 -2
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +14 -16
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +8 -7
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +8 -20
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +8 -8
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +7 -11
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +9 -9
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +2 -4
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +1 -2
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +12 -13
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +1 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +12 -12
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +4 -4
- package/dist-types/commands/PutObjectAclCommand.d.ts +13 -17
- package/dist-types/commands/PutObjectCommand.d.ts +54 -45
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +8 -7
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +4 -3
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +3 -4
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +69 -50
- package/dist-types/commands/SelectObjectContentCommand.d.ts +17 -13
- package/dist-types/commands/UploadPartCommand.d.ts +16 -23
- package/dist-types/commands/UploadPartCopyCommand.d.ts +5 -7
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +22 -33
- package/dist-types/models/models_0.d.ts +363 -426
- package/dist-types/models/models_1.d.ts +76 -81
- package/dist-types/ts3.4/S3.d.ts +2 -1
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +6 -6
|
@@ -55,8 +55,8 @@ export interface AbortMultipartUploadRequest {
|
|
|
55
55
|
/**
|
|
56
56
|
* <p>The bucket name to which the upload was taking place. </p>
|
|
57
57
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
58
|
-
* <p>When
|
|
59
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
58
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
59
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
60
60
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
61
61
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
62
62
|
*/
|
|
@@ -221,34 +221,7 @@ export interface Grant {
|
|
|
221
221
|
*/
|
|
222
222
|
export interface Owner {
|
|
223
223
|
/**
|
|
224
|
-
* <p>Container for the display name of the owner
|
|
225
|
-
* following Amazon Web Services Regions:</p>
|
|
226
|
-
* <ul>
|
|
227
|
-
* <li>
|
|
228
|
-
* <p>US East (N. Virginia)</p>
|
|
229
|
-
* </li>
|
|
230
|
-
* <li>
|
|
231
|
-
* <p>US West (N. California)</p>
|
|
232
|
-
* </li>
|
|
233
|
-
* <li>
|
|
234
|
-
* <p>US West (Oregon)</p>
|
|
235
|
-
* </li>
|
|
236
|
-
* <li>
|
|
237
|
-
* <p>Asia Pacific (Singapore)</p>
|
|
238
|
-
* </li>
|
|
239
|
-
* <li>
|
|
240
|
-
* <p>Asia Pacific (Sydney)</p>
|
|
241
|
-
* </li>
|
|
242
|
-
* <li>
|
|
243
|
-
* <p>Asia Pacific (Tokyo)</p>
|
|
244
|
-
* </li>
|
|
245
|
-
* <li>
|
|
246
|
-
* <p>Europe (Ireland)</p>
|
|
247
|
-
* </li>
|
|
248
|
-
* <li>
|
|
249
|
-
* <p>South America (São Paulo)</p>
|
|
250
|
-
* </li>
|
|
251
|
-
* </ul>
|
|
224
|
+
* <p>Container for the display name of the owner.</p>
|
|
252
225
|
*/
|
|
253
226
|
DisplayName?: string;
|
|
254
227
|
/**
|
|
@@ -313,11 +286,10 @@ export interface CompleteMultipartUploadOutput {
|
|
|
313
286
|
*/
|
|
314
287
|
Location?: string;
|
|
315
288
|
/**
|
|
316
|
-
* <p>The name of the bucket that contains the newly created object. Does not return the access point
|
|
317
|
-
* ARN or access point alias if used.</p>
|
|
289
|
+
* <p>The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.</p>
|
|
318
290
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
319
|
-
* <p>When
|
|
320
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
291
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
292
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
321
293
|
*/
|
|
322
294
|
Bucket?: string;
|
|
323
295
|
/**
|
|
@@ -336,8 +308,9 @@ export interface CompleteMultipartUploadOutput {
|
|
|
336
308
|
* tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5
|
|
337
309
|
* digest of the object data, it will contain one or more nonhexadecimal characters and/or
|
|
338
310
|
* will consist of less than 32 or more than 32 hexadecimal digits. For more information about
|
|
339
|
-
* how the entity tag is calculated, see
|
|
340
|
-
*
|
|
311
|
+
* how the entity tag is calculated, see
|
|
312
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking
|
|
313
|
+
* object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
341
314
|
*/
|
|
342
315
|
ETag?: string;
|
|
343
316
|
/**
|
|
@@ -369,8 +342,10 @@ export interface CompleteMultipartUploadOutput {
|
|
|
369
342
|
*/
|
|
370
343
|
ChecksumSHA256?: string;
|
|
371
344
|
/**
|
|
372
|
-
* <p>
|
|
373
|
-
*
|
|
345
|
+
* <p>If you specified server-side encryption either with an Amazon S3-managed encryption key or an
|
|
346
|
+
* Amazon Web Services KMS key in your initiate multipart upload request, the response
|
|
347
|
+
* includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the
|
|
348
|
+
* object.</p>
|
|
374
349
|
*/
|
|
375
350
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
376
351
|
/**
|
|
@@ -380,12 +355,11 @@ export interface CompleteMultipartUploadOutput {
|
|
|
380
355
|
VersionId?: string;
|
|
381
356
|
/**
|
|
382
357
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
383
|
-
*
|
|
358
|
+
* customer managed key that was used for the object.</p>
|
|
384
359
|
*/
|
|
385
360
|
SSEKMSKeyId?: string;
|
|
386
361
|
/**
|
|
387
|
-
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
388
|
-
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
362
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
|
|
389
363
|
*/
|
|
390
364
|
BucketKeyEnabled?: boolean;
|
|
391
365
|
/**
|
|
@@ -444,8 +418,8 @@ export interface CompletedPart {
|
|
|
444
418
|
export interface CompletedMultipartUpload {
|
|
445
419
|
/**
|
|
446
420
|
* <p>Array of CompletedPart data types.</p>
|
|
447
|
-
* <p>If you do not supply a valid <code>Part</code> with your request, the service sends back
|
|
448
|
-
*
|
|
421
|
+
* <p>If you do not supply a valid <code>Part</code> with your request, the service sends back an HTTP
|
|
422
|
+
* 400 response.</p>
|
|
449
423
|
*/
|
|
450
424
|
Parts?: CompletedPart[];
|
|
451
425
|
}
|
|
@@ -456,8 +430,8 @@ export interface CompleteMultipartUploadRequest {
|
|
|
456
430
|
/**
|
|
457
431
|
* <p>Name of the bucket to which the multipart upload was initiated.</p>
|
|
458
432
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
459
|
-
* <p>When
|
|
460
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
433
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
434
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
461
435
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
462
436
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
463
437
|
*/
|
|
@@ -541,8 +515,7 @@ export interface CompleteMultipartUploadRequest {
|
|
|
541
515
|
*/
|
|
542
516
|
export interface CopyObjectResult {
|
|
543
517
|
/**
|
|
544
|
-
* <p>Returns the ETag of the new object. The ETag reflects only changes to the contents of an
|
|
545
|
-
* object, not its metadata.</p>
|
|
518
|
+
* <p>Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.</p>
|
|
546
519
|
*/
|
|
547
520
|
ETag?: string;
|
|
548
521
|
/**
|
|
@@ -600,7 +573,7 @@ export interface CopyObjectOutput {
|
|
|
600
573
|
VersionId?: string;
|
|
601
574
|
/**
|
|
602
575
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
603
|
-
* AES256,
|
|
576
|
+
* AES256, aws:kms).</p>
|
|
604
577
|
*/
|
|
605
578
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
606
579
|
/**
|
|
@@ -616,7 +589,7 @@ export interface CopyObjectOutput {
|
|
|
616
589
|
SSECustomerKeyMD5?: string;
|
|
617
590
|
/**
|
|
618
591
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
619
|
-
*
|
|
592
|
+
* customer managed key that was used for the object.</p>
|
|
620
593
|
*/
|
|
621
594
|
SSEKMSKeyId?: string;
|
|
622
595
|
/**
|
|
@@ -626,8 +599,7 @@ export interface CopyObjectOutput {
|
|
|
626
599
|
*/
|
|
627
600
|
SSEKMSEncryptionContext?: string;
|
|
628
601
|
/**
|
|
629
|
-
* <p>Indicates whether the copied object uses an S3 Bucket Key for server-side encryption
|
|
630
|
-
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
602
|
+
* <p>Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
|
|
631
603
|
*/
|
|
632
604
|
BucketKeyEnabled?: boolean;
|
|
633
605
|
/**
|
|
@@ -715,6 +687,7 @@ export declare const StorageClass: {
|
|
|
715
687
|
readonly ONEZONE_IA: "ONEZONE_IA";
|
|
716
688
|
readonly OUTPOSTS: "OUTPOSTS";
|
|
717
689
|
readonly REDUCED_REDUNDANCY: "REDUCED_REDUNDANCY";
|
|
690
|
+
readonly SNOW: "SNOW";
|
|
718
691
|
readonly STANDARD: "STANDARD";
|
|
719
692
|
readonly STANDARD_IA: "STANDARD_IA";
|
|
720
693
|
};
|
|
@@ -746,8 +719,8 @@ export interface CopyObjectRequest {
|
|
|
746
719
|
/**
|
|
747
720
|
* <p>The name of the destination bucket.</p>
|
|
748
721
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
749
|
-
* <p>When
|
|
750
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
722
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
723
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
751
724
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
752
725
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
753
726
|
*/
|
|
@@ -827,12 +800,14 @@ export interface CopyObjectRequest {
|
|
|
827
800
|
*/
|
|
828
801
|
Expires?: Date;
|
|
829
802
|
/**
|
|
830
|
-
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
803
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
804
|
+
* object.</p>
|
|
831
805
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
832
806
|
*/
|
|
833
807
|
GrantFullControl?: string;
|
|
834
808
|
/**
|
|
835
|
-
* <p>Allows grantee to read the object data and its
|
|
809
|
+
* <p>Allows grantee to read the object data and its
|
|
810
|
+
* metadata.</p>
|
|
836
811
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
837
812
|
*/
|
|
838
813
|
GrantRead?: string;
|
|
@@ -842,7 +817,8 @@ export interface CopyObjectRequest {
|
|
|
842
817
|
*/
|
|
843
818
|
GrantReadACP?: string;
|
|
844
819
|
/**
|
|
845
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
820
|
+
* <p>Allows grantee to write the ACL for the applicable
|
|
821
|
+
* object.</p>
|
|
846
822
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
847
823
|
*/
|
|
848
824
|
GrantWriteACP?: string;
|
|
@@ -866,7 +842,7 @@ export interface CopyObjectRequest {
|
|
|
866
842
|
TaggingDirective?: TaggingDirective | string;
|
|
867
843
|
/**
|
|
868
844
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
869
|
-
* AES256,
|
|
845
|
+
* AES256, aws:kms).</p>
|
|
870
846
|
*/
|
|
871
847
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
872
848
|
/**
|
|
@@ -874,15 +850,13 @@ export interface CopyObjectRequest {
|
|
|
874
850
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
875
851
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
876
852
|
* 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
|
|
877
|
-
*
|
|
853
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
878
854
|
*/
|
|
879
855
|
StorageClass?: StorageClass | string;
|
|
880
856
|
/**
|
|
881
857
|
* <p>If the bucket is configured as a website, redirects requests for this object to another
|
|
882
858
|
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
|
|
883
|
-
* the object metadata
|
|
884
|
-
* <code>x-amz-metadata-directive</code> header. Instead, you may opt to provide this
|
|
885
|
-
* header in combination with the directive.</p>
|
|
859
|
+
* the object metadata.</p>
|
|
886
860
|
*/
|
|
887
861
|
WebsiteRedirectLocation?: string;
|
|
888
862
|
/**
|
|
@@ -904,26 +878,22 @@ export interface CopyObjectRequest {
|
|
|
904
878
|
*/
|
|
905
879
|
SSECustomerKeyMD5?: string;
|
|
906
880
|
/**
|
|
907
|
-
* <p>Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests
|
|
908
|
-
*
|
|
909
|
-
* information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services
|
|
910
|
-
*
|
|
911
|
-
* Signature Version in Request Authentication</a> in the
|
|
912
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
881
|
+
* <p>Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for
|
|
882
|
+
* an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For
|
|
883
|
+
* information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI,
|
|
884
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the
|
|
885
|
+
* Signature Version in Request Authentication</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
913
886
|
*/
|
|
914
887
|
SSEKMSKeyId?: string;
|
|
915
888
|
/**
|
|
916
|
-
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
917
|
-
*
|
|
918
|
-
*
|
|
889
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this
|
|
890
|
+
* header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value
|
|
891
|
+
* pairs.</p>
|
|
919
892
|
*/
|
|
920
893
|
SSEKMSEncryptionContext?: string;
|
|
921
894
|
/**
|
|
922
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
923
|
-
*
|
|
924
|
-
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. </p>
|
|
925
|
-
* <p>Specifying this header with a COPY action doesn’t affect bucket-level settings for S3
|
|
926
|
-
* Bucket Key.</p>
|
|
895
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. </p>
|
|
896
|
+
* <p>Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.</p>
|
|
927
897
|
*/
|
|
928
898
|
BucketKeyEnabled?: boolean;
|
|
929
899
|
/**
|
|
@@ -1132,8 +1102,7 @@ export interface CreateBucketRequest {
|
|
|
1132
1102
|
GrantReadACP?: string;
|
|
1133
1103
|
/**
|
|
1134
1104
|
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
1135
|
-
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
1136
|
-
* overwrites of those objects.</p>
|
|
1105
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.</p>
|
|
1137
1106
|
*/
|
|
1138
1107
|
GrantWrite?: string;
|
|
1139
1108
|
/**
|
|
@@ -1151,11 +1120,11 @@ export interface CreateBucketRequest {
|
|
|
1151
1120
|
* ACL.</p>
|
|
1152
1121
|
* <p>ObjectWriter - The uploading account will own the object if the object is uploaded with
|
|
1153
1122
|
* the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
1154
|
-
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect
|
|
1155
|
-
*
|
|
1156
|
-
*
|
|
1157
|
-
*
|
|
1158
|
-
* equivalent form of this ACL expressed in the XML format.</p>
|
|
1123
|
+
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions.
|
|
1124
|
+
* The bucket owner automatically owns and has full control over every object in the bucket. The bucket only
|
|
1125
|
+
* accepts PUT requests that don't specify an ACL or bucket owner full control
|
|
1126
|
+
* ACLs, such as the <code>bucket-owner-full-control</code> canned
|
|
1127
|
+
* ACL or an equivalent form of this ACL expressed in the XML format.</p>
|
|
1159
1128
|
*/
|
|
1160
1129
|
ObjectOwnership?: ObjectOwnership | string;
|
|
1161
1130
|
}
|
|
@@ -1180,11 +1149,10 @@ export interface CreateMultipartUploadOutput {
|
|
|
1180
1149
|
*/
|
|
1181
1150
|
AbortRuleId?: string;
|
|
1182
1151
|
/**
|
|
1183
|
-
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
1184
|
-
* access point ARN or access point alias if used.</p>
|
|
1152
|
+
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.</p>
|
|
1185
1153
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1186
|
-
* <p>When
|
|
1187
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
1154
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1155
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1188
1156
|
*/
|
|
1189
1157
|
Bucket?: string;
|
|
1190
1158
|
/**
|
|
@@ -1197,7 +1165,7 @@ export interface CreateMultipartUploadOutput {
|
|
|
1197
1165
|
UploadId?: string;
|
|
1198
1166
|
/**
|
|
1199
1167
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
1200
|
-
* AES256,
|
|
1168
|
+
* AES256, aws:kms).</p>
|
|
1201
1169
|
*/
|
|
1202
1170
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
1203
1171
|
/**
|
|
@@ -1213,7 +1181,7 @@ export interface CreateMultipartUploadOutput {
|
|
|
1213
1181
|
SSECustomerKeyMD5?: string;
|
|
1214
1182
|
/**
|
|
1215
1183
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
1216
|
-
*
|
|
1184
|
+
* customer managed key that was used for the object.</p>
|
|
1217
1185
|
*/
|
|
1218
1186
|
SSEKMSKeyId?: string;
|
|
1219
1187
|
/**
|
|
@@ -1223,8 +1191,7 @@ export interface CreateMultipartUploadOutput {
|
|
|
1223
1191
|
*/
|
|
1224
1192
|
SSEKMSEncryptionContext?: string;
|
|
1225
1193
|
/**
|
|
1226
|
-
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption
|
|
1227
|
-
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
1194
|
+
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
|
|
1228
1195
|
*/
|
|
1229
1196
|
BucketKeyEnabled?: boolean;
|
|
1230
1197
|
/**
|
|
@@ -1249,8 +1216,8 @@ export interface CreateMultipartUploadRequest {
|
|
|
1249
1216
|
/**
|
|
1250
1217
|
* <p>The name of the bucket to which to initiate the upload</p>
|
|
1251
1218
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1252
|
-
* <p>When
|
|
1253
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
1219
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1220
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1254
1221
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1255
1222
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1256
1223
|
*/
|
|
@@ -1282,12 +1249,14 @@ export interface CreateMultipartUploadRequest {
|
|
|
1282
1249
|
*/
|
|
1283
1250
|
Expires?: Date;
|
|
1284
1251
|
/**
|
|
1285
|
-
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
1252
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
1253
|
+
* object.</p>
|
|
1286
1254
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
1287
1255
|
*/
|
|
1288
1256
|
GrantFullControl?: string;
|
|
1289
1257
|
/**
|
|
1290
|
-
* <p>Allows grantee to read the object data and its
|
|
1258
|
+
* <p>Allows grantee to read the object data and its
|
|
1259
|
+
* metadata.</p>
|
|
1291
1260
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
1292
1261
|
*/
|
|
1293
1262
|
GrantRead?: string;
|
|
@@ -1297,7 +1266,8 @@ export interface CreateMultipartUploadRequest {
|
|
|
1297
1266
|
*/
|
|
1298
1267
|
GrantReadACP?: string;
|
|
1299
1268
|
/**
|
|
1300
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
1269
|
+
* <p>Allows grantee to write the ACL for the applicable
|
|
1270
|
+
* object.</p>
|
|
1301
1271
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
1302
1272
|
*/
|
|
1303
1273
|
GrantWriteACP?: string;
|
|
@@ -1311,7 +1281,7 @@ export interface CreateMultipartUploadRequest {
|
|
|
1311
1281
|
Metadata?: Record<string, string>;
|
|
1312
1282
|
/**
|
|
1313
1283
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
1314
|
-
* AES256,
|
|
1284
|
+
* AES256, aws:kms).</p>
|
|
1315
1285
|
*/
|
|
1316
1286
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
1317
1287
|
/**
|
|
@@ -1319,7 +1289,7 @@ export interface CreateMultipartUploadRequest {
|
|
|
1319
1289
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
1320
1290
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
1321
1291
|
* 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
|
|
1322
|
-
*
|
|
1292
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
1323
1293
|
*/
|
|
1324
1294
|
StorageClass?: StorageClass | string;
|
|
1325
1295
|
/**
|
|
@@ -1347,25 +1317,22 @@ export interface CreateMultipartUploadRequest {
|
|
|
1347
1317
|
*/
|
|
1348
1318
|
SSECustomerKeyMD5?: string;
|
|
1349
1319
|
/**
|
|
1350
|
-
* <p>Specifies the ID of the symmetric
|
|
1351
|
-
* All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not
|
|
1352
|
-
* or using SigV4. For information about configuring using any of the officially
|
|
1353
|
-
* Amazon Web Services SDKs and Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in Request Authentication</a>
|
|
1320
|
+
* <p>Specifies the ID of the symmetric customer managed key to use for object
|
|
1321
|
+
* encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not
|
|
1322
|
+
* made via SSL or using SigV4. For information about configuring using any of the officially
|
|
1323
|
+
* supported Amazon Web Services SDKs and Amazon Web Services CLI, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version">Specifying the Signature Version in Request Authentication</a>
|
|
1354
1324
|
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
1355
1325
|
*/
|
|
1356
1326
|
SSEKMSKeyId?: string;
|
|
1357
1327
|
/**
|
|
1358
|
-
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
1359
|
-
*
|
|
1360
|
-
*
|
|
1328
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this
|
|
1329
|
+
* header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value
|
|
1330
|
+
* pairs.</p>
|
|
1361
1331
|
*/
|
|
1362
1332
|
SSEKMSEncryptionContext?: string;
|
|
1363
1333
|
/**
|
|
1364
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
1365
|
-
*
|
|
1366
|
-
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
1367
|
-
* <p>Specifying this header with an object action doesn’t affect bucket-level settings for S3
|
|
1368
|
-
* Bucket Key.</p>
|
|
1334
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
1335
|
+
* <p>Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.</p>
|
|
1369
1336
|
*/
|
|
1370
1337
|
BucketKeyEnabled?: boolean;
|
|
1371
1338
|
/**
|
|
@@ -1525,8 +1492,7 @@ export interface DeleteBucketMetricsConfigurationRequest {
|
|
|
1525
1492
|
*/
|
|
1526
1493
|
Bucket: string | undefined;
|
|
1527
1494
|
/**
|
|
1528
|
-
* <p>The ID used to identify the metrics configuration
|
|
1529
|
-
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
1495
|
+
* <p>The ID used to identify the metrics configuration.</p>
|
|
1530
1496
|
*/
|
|
1531
1497
|
Id: string | undefined;
|
|
1532
1498
|
/**
|
|
@@ -1636,8 +1602,8 @@ export interface DeleteObjectRequest {
|
|
|
1636
1602
|
/**
|
|
1637
1603
|
* <p>The bucket name of the bucket containing the object. </p>
|
|
1638
1604
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1639
|
-
* <p>When
|
|
1640
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
1605
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
1606
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
1641
1607
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
1642
1608
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
1643
1609
|
*/
|
|
@@ -1665,8 +1631,8 @@ export interface DeleteObjectRequest {
|
|
|
1665
1631
|
RequestPayer?: RequestPayer | string;
|
|
1666
1632
|
/**
|
|
1667
1633
|
* <p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process
|
|
1668
|
-
* this operation. To use this header, you must have the
|
|
1669
|
-
*
|
|
1634
|
+
* this operation. To use this header, you must have the <code>s3:BypassGovernanceRetention</code>
|
|
1635
|
+
* permission.</p>
|
|
1670
1636
|
*/
|
|
1671
1637
|
BypassGovernanceRetention?: boolean;
|
|
1672
1638
|
/**
|
|
@@ -2278,8 +2244,8 @@ export interface _Error {
|
|
|
2278
2244
|
* <li>
|
|
2279
2245
|
* <p>
|
|
2280
2246
|
* <i>Description:</i> The specified location constraint is not
|
|
2281
|
-
* valid. For more information about Regions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">How to Select
|
|
2282
|
-
*
|
|
2247
|
+
* valid. For more information about Regions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">How to Select a
|
|
2248
|
+
* Region for Your Buckets</a>. </p>
|
|
2283
2249
|
* </li>
|
|
2284
2250
|
* <li>
|
|
2285
2251
|
* <p>
|
|
@@ -2427,8 +2393,7 @@ export interface _Error {
|
|
|
2427
2393
|
* </li>
|
|
2428
2394
|
* <li>
|
|
2429
2395
|
* <p>
|
|
2430
|
-
* <i>Description:</i> Please use
|
|
2431
|
-
* <code>AWS4-HMAC-SHA256</code>.</p>
|
|
2396
|
+
* <i>Description:</i> Please use <code>AWS4-HMAC-SHA256</code>.</p>
|
|
2432
2397
|
* </li>
|
|
2433
2398
|
* <li>
|
|
2434
2399
|
* <p>
|
|
@@ -3397,9 +3362,9 @@ export interface _Error {
|
|
|
3397
3362
|
* <p>
|
|
3398
3363
|
* <i>Description:</i> The request signature we calculated does
|
|
3399
3364
|
* not match the signature you provided. Check your Amazon Web Services secret access key and
|
|
3400
|
-
* signing method. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST
|
|
3401
|
-
*
|
|
3402
|
-
*
|
|
3365
|
+
* signing method. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST Authentication</a> and
|
|
3366
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html">SOAP Authentication</a>
|
|
3367
|
+
* for details.</p>
|
|
3403
3368
|
* </li>
|
|
3404
3369
|
* <li>
|
|
3405
3370
|
* <p>
|
|
@@ -3419,8 +3384,7 @@ export interface _Error {
|
|
|
3419
3384
|
* </li>
|
|
3420
3385
|
* <li>
|
|
3421
3386
|
* <p>
|
|
3422
|
-
* <i>Description:</i>
|
|
3423
|
-
* request.</p>
|
|
3387
|
+
* <i>Description:</i> Reduce your request rate.</p>
|
|
3424
3388
|
* </li>
|
|
3425
3389
|
* <li>
|
|
3426
3390
|
* <p>
|
|
@@ -3652,8 +3616,8 @@ export interface DeleteObjectsRequest {
|
|
|
3652
3616
|
/**
|
|
3653
3617
|
* <p>The bucket name containing the objects to delete. </p>
|
|
3654
3618
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3655
|
-
* <p>When
|
|
3656
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
3619
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
3620
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3657
3621
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
3658
3622
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
3659
3623
|
*/
|
|
@@ -3677,8 +3641,8 @@ export interface DeleteObjectsRequest {
|
|
|
3677
3641
|
RequestPayer?: RequestPayer | string;
|
|
3678
3642
|
/**
|
|
3679
3643
|
* <p>Specifies whether you want to delete this object even if it has a Governance-type Object
|
|
3680
|
-
* Lock in place. To use this header, you must have the
|
|
3681
|
-
*
|
|
3644
|
+
* Lock in place. To use this header, you must have the <code>s3:BypassGovernanceRetention</code>
|
|
3645
|
+
* permission.</p>
|
|
3682
3646
|
*/
|
|
3683
3647
|
BypassGovernanceRetention?: boolean;
|
|
3684
3648
|
/**
|
|
@@ -3693,8 +3657,8 @@ export interface DeleteObjectsRequest {
|
|
|
3693
3657
|
* the <i>Amazon S3 User Guide</i>.</p>
|
|
3694
3658
|
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
|
|
3695
3659
|
* <code>ChecksumAlgorithm</code> parameter.</p>
|
|
3696
|
-
* <p>This checksum algorithm must be the same for all parts and it match the checksum
|
|
3697
|
-
*
|
|
3660
|
+
* <p>This checksum algorithm must be the same for all parts and it match the checksum
|
|
3661
|
+
* value supplied in the <code>CreateMultipartUpload</code> request.</p>
|
|
3698
3662
|
*/
|
|
3699
3663
|
ChecksumAlgorithm?: ChecksumAlgorithm | string;
|
|
3700
3664
|
}
|
|
@@ -3714,8 +3678,8 @@ export interface DeleteObjectTaggingRequest {
|
|
|
3714
3678
|
/**
|
|
3715
3679
|
* <p>The bucket name containing the objects from which to remove the tags. </p>
|
|
3716
3680
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3717
|
-
* <p>When
|
|
3718
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
3681
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
3682
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
3719
3683
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
3720
3684
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
3721
3685
|
*/
|
|
@@ -3974,8 +3938,7 @@ export interface StorageClassAnalysis {
|
|
|
3974
3938
|
}
|
|
3975
3939
|
/**
|
|
3976
3940
|
* @public
|
|
3977
|
-
* <p>Specifies the configuration and any analyses for the analytics filter of an Amazon S3
|
|
3978
|
-
* bucket.</p>
|
|
3941
|
+
* <p>Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.</p>
|
|
3979
3942
|
*/
|
|
3980
3943
|
export interface AnalyticsConfiguration {
|
|
3981
3944
|
/**
|
|
@@ -4088,9 +4051,8 @@ export interface GetBucketCorsRequest {
|
|
|
4088
4051
|
* <p>Describes the default server-side encryption to apply to new objects in the bucket. If a
|
|
4089
4052
|
* PUT Object request doesn't specify any server-side encryption, this default encryption will
|
|
4090
4053
|
* be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates
|
|
4091
|
-
* an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted
|
|
4092
|
-
*
|
|
4093
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html">PUT Bucket encryption</a> in
|
|
4054
|
+
* an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with
|
|
4055
|
+
* SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html">PUT Bucket encryption</a> in
|
|
4094
4056
|
* the <i>Amazon S3 API Reference</i>.</p>
|
|
4095
4057
|
*/
|
|
4096
4058
|
export interface ServerSideEncryptionByDefault {
|
|
@@ -4100,11 +4062,11 @@ export interface ServerSideEncryptionByDefault {
|
|
|
4100
4062
|
SSEAlgorithm: ServerSideEncryption | string | undefined;
|
|
4101
4063
|
/**
|
|
4102
4064
|
* <p>Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default
|
|
4103
|
-
*
|
|
4104
|
-
*
|
|
4065
|
+
* encryption. This parameter is allowed if and only if <code>SSEAlgorithm</code> is set to
|
|
4066
|
+
* <code>aws:kms</code>.</p>
|
|
4105
4067
|
* <p>You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if
|
|
4106
|
-
* you are using encryption with cross-account or Amazon Web Services service operations you must use a
|
|
4107
|
-
*
|
|
4068
|
+
* you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS
|
|
4069
|
+
* key ARN. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy">Using encryption for cross-account operations</a>. </p>
|
|
4108
4070
|
* <p>
|
|
4109
4071
|
* <b>For example:</b>
|
|
4110
4072
|
* </p>
|
|
@@ -4120,9 +4082,9 @@ export interface ServerSideEncryptionByDefault {
|
|
|
4120
4082
|
* </li>
|
|
4121
4083
|
* </ul>
|
|
4122
4084
|
* <important>
|
|
4123
|
-
* <p>Amazon S3 only supports symmetric
|
|
4124
|
-
*
|
|
4125
|
-
*
|
|
4085
|
+
* <p>Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see
|
|
4086
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and
|
|
4087
|
+
* asymmetric keys</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>.</p>
|
|
4126
4088
|
* </important>
|
|
4127
4089
|
*/
|
|
4128
4090
|
KMSMasterKeyID?: string;
|
|
@@ -4139,12 +4101,8 @@ export interface ServerSideEncryptionRule {
|
|
|
4139
4101
|
*/
|
|
4140
4102
|
ApplyServerSideEncryptionByDefault?: ServerSideEncryptionByDefault;
|
|
4141
4103
|
/**
|
|
4142
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS
|
|
4143
|
-
*
|
|
4144
|
-
* <code>BucketKeyEnabled</code> element to <code>true</code> causes Amazon S3 to use an S3
|
|
4145
|
-
* Bucket Key. By default, S3 Bucket Key is not enabled.</p>
|
|
4146
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
4147
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
4104
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the <code>BucketKeyEnabled</code> element to <code>true</code> causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.</p>
|
|
4105
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4148
4106
|
*/
|
|
4149
4107
|
BucketKeyEnabled?: boolean;
|
|
4150
4108
|
}
|
|
@@ -4267,18 +4225,17 @@ export interface Tiering {
|
|
|
4267
4225
|
*/
|
|
4268
4226
|
Days: number | undefined;
|
|
4269
4227
|
/**
|
|
4270
|
-
* <p>S3 Intelligent-Tiering access tier. See <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class
|
|
4271
|
-
*
|
|
4272
|
-
*
|
|
4228
|
+
* <p>S3 Intelligent-Tiering access tier. See <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for
|
|
4229
|
+
* automatically optimizing frequently and infrequently accessed objects</a> for a list
|
|
4230
|
+
* of access tiers in the S3 Intelligent-Tiering storage class.</p>
|
|
4273
4231
|
*/
|
|
4274
4232
|
AccessTier: IntelligentTieringAccessTier | string | undefined;
|
|
4275
4233
|
}
|
|
4276
4234
|
/**
|
|
4277
4235
|
* @public
|
|
4278
4236
|
* <p>Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.</p>
|
|
4279
|
-
* <p>For information about the S3 Intelligent-Tiering storage class, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class
|
|
4280
|
-
*
|
|
4281
|
-
* objects</a>.</p>
|
|
4237
|
+
* <p>For information about the S3 Intelligent-Tiering storage class, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for
|
|
4238
|
+
* automatically optimizing frequently and infrequently accessed objects</a>.</p>
|
|
4282
4239
|
*/
|
|
4283
4240
|
export interface IntelligentTieringConfiguration {
|
|
4284
4241
|
/**
|
|
@@ -4329,8 +4286,8 @@ export interface GetBucketIntelligentTieringConfigurationRequest {
|
|
|
4329
4286
|
*/
|
|
4330
4287
|
export interface SSEKMS {
|
|
4331
4288
|
/**
|
|
4332
|
-
* <p>Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
4333
|
-
*
|
|
4289
|
+
* <p>Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key
|
|
4290
|
+
* to use for encrypting inventory reports.</p>
|
|
4334
4291
|
*/
|
|
4335
4292
|
KeyId: string | undefined;
|
|
4336
4293
|
}
|
|
@@ -4484,7 +4441,8 @@ export interface InventorySchedule {
|
|
|
4484
4441
|
/**
|
|
4485
4442
|
* @public
|
|
4486
4443
|
* <p>Specifies the inventory configuration for an Amazon S3 bucket. For more information, see
|
|
4487
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html">GET Bucket inventory</a> in the <i>Amazon S3 API Reference</i>.
|
|
4444
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html">GET Bucket inventory</a> in the <i>Amazon S3 API Reference</i>.
|
|
4445
|
+
* </p>
|
|
4488
4446
|
*/
|
|
4489
4447
|
export interface InventoryConfiguration {
|
|
4490
4448
|
/**
|
|
@@ -4554,8 +4512,6 @@ export interface GetBucketInventoryConfigurationRequest {
|
|
|
4554
4512
|
/**
|
|
4555
4513
|
* @public
|
|
4556
4514
|
* <p>Container for the expiration for the lifecycle of the object.</p>
|
|
4557
|
-
* <p>For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage
|
|
4558
|
-
* lifecycle</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4559
4515
|
*/
|
|
4560
4516
|
export interface LifecycleExpiration {
|
|
4561
4517
|
/**
|
|
@@ -4701,17 +4657,15 @@ export declare namespace LifecycleRuleFilter {
|
|
|
4701
4657
|
export interface NoncurrentVersionExpiration {
|
|
4702
4658
|
/**
|
|
4703
4659
|
* <p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the
|
|
4704
|
-
* associated action. The value must be a non-zero positive integer. For information about the
|
|
4705
|
-
*
|
|
4706
|
-
* Amazon S3 Calculates When an Object Became Noncurrent</a> in the
|
|
4707
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
4660
|
+
* associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations">How
|
|
4661
|
+
* Amazon S3 Calculates When an Object Became Noncurrent</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4708
4662
|
*/
|
|
4709
4663
|
NoncurrentDays?: number;
|
|
4710
4664
|
/**
|
|
4711
|
-
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more
|
|
4712
|
-
*
|
|
4713
|
-
*
|
|
4714
|
-
*
|
|
4665
|
+
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent
|
|
4666
|
+
* noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent
|
|
4667
|
+
* versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration elements</a>
|
|
4668
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
4715
4669
|
*/
|
|
4716
4670
|
NewerNoncurrentVersions?: number;
|
|
4717
4671
|
}
|
|
@@ -4735,12 +4689,12 @@ export type TransitionStorageClass = (typeof TransitionStorageClass)[keyof typeo
|
|
|
4735
4689
|
* @public
|
|
4736
4690
|
* <p>Container for the transition rule that describes when noncurrent objects transition to
|
|
4737
4691
|
* the <code>STANDARD_IA</code>, <code>ONEZONE_IA</code>, <code>INTELLIGENT_TIERING</code>,
|
|
4738
|
-
*
|
|
4739
|
-
*
|
|
4740
|
-
*
|
|
4741
|
-
* <code>
|
|
4742
|
-
* <code>
|
|
4743
|
-
*
|
|
4692
|
+
* <code>GLACIER_IR</code>, <code>GLACIER</code>, or <code>DEEP_ARCHIVE</code> storage class. If your bucket is
|
|
4693
|
+
* versioning-enabled (or versioning is suspended), you can set this action to request that
|
|
4694
|
+
* Amazon S3 transition noncurrent object versions to the <code>STANDARD_IA</code>,
|
|
4695
|
+
* <code>ONEZONE_IA</code>, <code>INTELLIGENT_TIERING</code>, <code>GLACIER_IR</code>, <code>GLACIER</code>, or
|
|
4696
|
+
* <code>DEEP_ARCHIVE</code> storage class at a specific period in the object's
|
|
4697
|
+
* lifetime.</p>
|
|
4744
4698
|
*/
|
|
4745
4699
|
export interface NoncurrentVersionTransition {
|
|
4746
4700
|
/**
|
|
@@ -4755,10 +4709,10 @@ export interface NoncurrentVersionTransition {
|
|
|
4755
4709
|
*/
|
|
4756
4710
|
StorageClass?: TransitionStorageClass | string;
|
|
4757
4711
|
/**
|
|
4758
|
-
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more
|
|
4759
|
-
*
|
|
4760
|
-
*
|
|
4761
|
-
*
|
|
4712
|
+
* <p>Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent
|
|
4713
|
+
* noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent
|
|
4714
|
+
* versions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html">Lifecycle configuration elements</a>
|
|
4715
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
4762
4716
|
*/
|
|
4763
4717
|
NewerNoncurrentVersions?: number;
|
|
4764
4718
|
}
|
|
@@ -4799,8 +4753,6 @@ export interface Transition {
|
|
|
4799
4753
|
/**
|
|
4800
4754
|
* @public
|
|
4801
4755
|
* <p>A lifecycle rule for individual objects in an Amazon S3 bucket.</p>
|
|
4802
|
-
* <p>For more information see, <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage
|
|
4803
|
-
* lifecycle</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
4804
4756
|
*/
|
|
4805
4757
|
export interface LifecycleRule {
|
|
4806
4758
|
/**
|
|
@@ -4893,8 +4845,9 @@ export interface GetBucketLifecycleConfigurationRequest {
|
|
|
4893
4845
|
export interface GetBucketLocationOutput {
|
|
4894
4846
|
/**
|
|
4895
4847
|
* <p>Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported
|
|
4896
|
-
* location constraints by Region, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a>.
|
|
4897
|
-
* Region <code>us-east-1</code> have a LocationConstraint of
|
|
4848
|
+
* location constraints by Region, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a>.
|
|
4849
|
+
* Buckets in Region <code>us-east-1</code> have a LocationConstraint of
|
|
4850
|
+
* <code>null</code>.</p>
|
|
4898
4851
|
*/
|
|
4899
4852
|
LocationConstraint?: BucketLocationConstraint | string;
|
|
4900
4853
|
}
|
|
@@ -4929,9 +4882,9 @@ export type BucketLogsPermission = (typeof BucketLogsPermission)[keyof typeof Bu
|
|
|
4929
4882
|
/**
|
|
4930
4883
|
* @public
|
|
4931
4884
|
* <p>Container for granting information.</p>
|
|
4932
|
-
* <p>Buckets that use the bucket owner enforced setting for Object
|
|
4933
|
-
* target grants. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions server access log delivery</a> in the
|
|
4934
|
-
*
|
|
4885
|
+
* <p>Buckets that use the bucket owner enforced setting for Object
|
|
4886
|
+
* Ownership don't support target grants. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions server access log delivery</a> in the
|
|
4887
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
4935
4888
|
*/
|
|
4936
4889
|
export interface TargetGrant {
|
|
4937
4890
|
/**
|
|
@@ -4960,8 +4913,8 @@ export interface LoggingEnabled {
|
|
|
4960
4913
|
TargetBucket: string | undefined;
|
|
4961
4914
|
/**
|
|
4962
4915
|
* <p>Container for granting information.</p>
|
|
4963
|
-
* <p>Buckets that use the bucket owner enforced setting for Object
|
|
4964
|
-
*
|
|
4916
|
+
* <p>Buckets that use the bucket owner enforced setting for Object
|
|
4917
|
+
* Ownership don't support target grants. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general">Permissions for server access log delivery</a> in the
|
|
4965
4918
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
4966
4919
|
*/
|
|
4967
4920
|
TargetGrants?: TargetGrant[];
|
|
@@ -5021,8 +4974,8 @@ export interface MetricsAndOperator {
|
|
|
5021
4974
|
/**
|
|
5022
4975
|
* @public
|
|
5023
4976
|
* <p>Specifies a metrics configuration filter. The metrics configuration only includes
|
|
5024
|
-
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an
|
|
5025
|
-
*
|
|
4977
|
+
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction
|
|
4978
|
+
* (MetricsAndOperator). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a>.</p>
|
|
5026
4979
|
*/
|
|
5027
4980
|
export type MetricsFilter = MetricsFilter.AccessPointArnMember | MetricsFilter.AndMember | MetricsFilter.PrefixMember | MetricsFilter.TagMember | MetricsFilter.$UnknownMember;
|
|
5028
4981
|
/**
|
|
@@ -5097,14 +5050,13 @@ export declare namespace MetricsFilter {
|
|
|
5097
5050
|
*/
|
|
5098
5051
|
export interface MetricsConfiguration {
|
|
5099
5052
|
/**
|
|
5100
|
-
* <p>The ID used to identify the metrics configuration
|
|
5101
|
-
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
5053
|
+
* <p>The ID used to identify the metrics configuration.</p>
|
|
5102
5054
|
*/
|
|
5103
5055
|
Id: string | undefined;
|
|
5104
5056
|
/**
|
|
5105
5057
|
* <p>Specifies a metrics configuration filter. The metrics configuration will only include
|
|
5106
|
-
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an
|
|
5107
|
-
*
|
|
5058
|
+
* objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction
|
|
5059
|
+
* (MetricsAndOperator).</p>
|
|
5108
5060
|
*/
|
|
5109
5061
|
Filter?: MetricsFilter;
|
|
5110
5062
|
}
|
|
@@ -5128,8 +5080,7 @@ export interface GetBucketMetricsConfigurationRequest {
|
|
|
5128
5080
|
*/
|
|
5129
5081
|
Bucket: string | undefined;
|
|
5130
5082
|
/**
|
|
5131
|
-
* <p>The ID used to identify the metrics configuration
|
|
5132
|
-
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
5083
|
+
* <p>The ID used to identify the metrics configuration.</p>
|
|
5133
5084
|
*/
|
|
5134
5085
|
Id: string | undefined;
|
|
5135
5086
|
/**
|
|
@@ -5370,11 +5321,11 @@ export interface OwnershipControlsRule {
|
|
|
5370
5321
|
* ACL.</p>
|
|
5371
5322
|
* <p>ObjectWriter - The uploading account will own the object if the object is uploaded with
|
|
5372
5323
|
* the <code>bucket-owner-full-control</code> canned ACL.</p>
|
|
5373
|
-
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect
|
|
5374
|
-
*
|
|
5375
|
-
*
|
|
5376
|
-
*
|
|
5377
|
-
* equivalent form of this ACL expressed in the XML format.</p>
|
|
5324
|
+
* <p>BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions.
|
|
5325
|
+
* The bucket owner automatically owns and has full control over every object in the bucket. The bucket only
|
|
5326
|
+
* accepts PUT requests that don't specify an ACL or bucket owner full control
|
|
5327
|
+
* ACLs, such as the <code>bucket-owner-full-control</code> canned
|
|
5328
|
+
* ACL or an equivalent form of this ACL expressed in the XML format.</p>
|
|
5378
5329
|
*/
|
|
5379
5330
|
ObjectOwnership: ObjectOwnership | string | undefined;
|
|
5380
5331
|
}
|
|
@@ -5393,8 +5344,8 @@ export interface OwnershipControls {
|
|
|
5393
5344
|
*/
|
|
5394
5345
|
export interface GetBucketOwnershipControlsOutput {
|
|
5395
5346
|
/**
|
|
5396
|
-
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
5397
|
-
*
|
|
5347
|
+
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in
|
|
5348
|
+
* effect for this Amazon S3 bucket.</p>
|
|
5398
5349
|
*/
|
|
5399
5350
|
OwnershipControls?: OwnershipControls;
|
|
5400
5351
|
}
|
|
@@ -5516,12 +5467,11 @@ export interface DeleteMarkerReplication {
|
|
|
5516
5467
|
*/
|
|
5517
5468
|
export interface EncryptionConfiguration {
|
|
5518
5469
|
/**
|
|
5519
|
-
* <p>Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key
|
|
5520
|
-
* Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses
|
|
5521
|
-
* encrypt replica objects. Amazon S3 only supports symmetric
|
|
5522
|
-
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">
|
|
5523
|
-
*
|
|
5524
|
-
* Guide</i>.</p>
|
|
5470
|
+
* <p>Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key
|
|
5471
|
+
* stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses
|
|
5472
|
+
* this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys.
|
|
5473
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and
|
|
5474
|
+
* asymmetric keys</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>.</p>
|
|
5525
5475
|
*/
|
|
5526
5476
|
ReplicaKmsKeyID?: string;
|
|
5527
5477
|
}
|
|
@@ -5601,17 +5551,15 @@ export interface ReplicationTime {
|
|
|
5601
5551
|
*/
|
|
5602
5552
|
export interface Destination {
|
|
5603
5553
|
/**
|
|
5604
|
-
* <p> The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the
|
|
5605
|
-
* results.</p>
|
|
5554
|
+
* <p> The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.</p>
|
|
5606
5555
|
*/
|
|
5607
5556
|
Bucket: string | undefined;
|
|
5608
5557
|
/**
|
|
5609
5558
|
* <p>Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to
|
|
5610
|
-
* change replica ownership to the Amazon Web Services account that owns the destination bucket by
|
|
5611
|
-
*
|
|
5612
|
-
*
|
|
5613
|
-
* Configuration: Changing the Replica Owner</a> in the
|
|
5614
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
5559
|
+
* change replica ownership to the Amazon Web Services account that owns the destination bucket by specifying
|
|
5560
|
+
* the <code>AccessControlTranslation</code> property, this is the account ID of the
|
|
5561
|
+
* destination bucket owner. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-change-owner.html">Replication Additional
|
|
5562
|
+
* Configuration: Changing the Replica Owner</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5615
5563
|
*/
|
|
5616
5564
|
Account?: string;
|
|
5617
5565
|
/**
|
|
@@ -5624,10 +5572,9 @@ export interface Destination {
|
|
|
5624
5572
|
StorageClass?: StorageClass | string;
|
|
5625
5573
|
/**
|
|
5626
5574
|
* <p>Specify this only in a cross-account scenario (where source and destination bucket
|
|
5627
|
-
* owners are not the same), and you want to change replica ownership to the Amazon Web Services account
|
|
5628
|
-
*
|
|
5629
|
-
*
|
|
5630
|
-
* object.</p>
|
|
5575
|
+
* owners are not the same), and you want to change replica ownership to the Amazon Web Services account that
|
|
5576
|
+
* owns the destination bucket. If this is not specified in the replication configuration, the
|
|
5577
|
+
* replicas are owned by same Amazon Web Services account that owns the source object.</p>
|
|
5631
5578
|
*/
|
|
5632
5579
|
AccessControlTranslation?: AccessControlTranslation;
|
|
5633
5580
|
/**
|
|
@@ -5667,7 +5614,7 @@ export type ExistingObjectReplicationStatus = (typeof ExistingObjectReplicationS
|
|
|
5667
5614
|
*/
|
|
5668
5615
|
export interface ExistingObjectReplication {
|
|
5669
5616
|
/**
|
|
5670
|
-
* <p
|
|
5617
|
+
* <p></p>
|
|
5671
5618
|
*/
|
|
5672
5619
|
Status: ExistingObjectReplicationStatus | string | undefined;
|
|
5673
5620
|
}
|
|
@@ -5828,14 +5775,14 @@ export interface SseKmsEncryptedObjects {
|
|
|
5828
5775
|
* <p>A container that describes additional filters for identifying the source objects that
|
|
5829
5776
|
* you want to replicate. You can choose to enable or disable the replication of these
|
|
5830
5777
|
* objects. Currently, Amazon S3 supports only the filter that you can specify for objects created
|
|
5831
|
-
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management
|
|
5832
|
-
* (SSE-KMS).</p>
|
|
5778
|
+
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management
|
|
5779
|
+
* Service (SSE-KMS).</p>
|
|
5833
5780
|
*/
|
|
5834
5781
|
export interface SourceSelectionCriteria {
|
|
5835
5782
|
/**
|
|
5836
|
-
* <p> A container for filter information for the selection of Amazon S3 objects encrypted with
|
|
5837
|
-
*
|
|
5838
|
-
*
|
|
5783
|
+
* <p> A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services
|
|
5784
|
+
* KMS. If you include <code>SourceSelectionCriteria</code> in the replication configuration,
|
|
5785
|
+
* this element is required. </p>
|
|
5839
5786
|
*/
|
|
5840
5787
|
SseKmsEncryptedObjects?: SseKmsEncryptedObjects;
|
|
5841
5788
|
/**
|
|
@@ -5909,14 +5856,12 @@ export interface ReplicationRule {
|
|
|
5909
5856
|
* <p>A container that describes additional filters for identifying the source objects that
|
|
5910
5857
|
* you want to replicate. You can choose to enable or disable the replication of these
|
|
5911
5858
|
* objects. Currently, Amazon S3 supports only the filter that you can specify for objects created
|
|
5912
|
-
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management
|
|
5913
|
-
* (SSE-KMS).</p>
|
|
5859
|
+
* with server-side encryption using a customer managed key stored in Amazon Web Services Key Management
|
|
5860
|
+
* Service (SSE-KMS).</p>
|
|
5914
5861
|
*/
|
|
5915
5862
|
SourceSelectionCriteria?: SourceSelectionCriteria;
|
|
5916
5863
|
/**
|
|
5917
|
-
* <p>
|
|
5918
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication">Replicating Existing Objects</a> in the <i>Amazon S3 User Guide</i>.
|
|
5919
|
-
* </p>
|
|
5864
|
+
* <p></p>
|
|
5920
5865
|
*/
|
|
5921
5866
|
ExistingObjectReplication?: ExistingObjectReplication;
|
|
5922
5867
|
/**
|
|
@@ -5947,9 +5892,9 @@ export interface ReplicationRule {
|
|
|
5947
5892
|
*/
|
|
5948
5893
|
export interface ReplicationConfiguration {
|
|
5949
5894
|
/**
|
|
5950
|
-
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that
|
|
5951
|
-
* replicating objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html">How to Set Up
|
|
5952
|
-
*
|
|
5895
|
+
* <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that
|
|
5896
|
+
* Amazon S3 assumes when replicating objects. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html">How to Set Up
|
|
5897
|
+
* Replication</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
5953
5898
|
*/
|
|
5954
5899
|
Role: string | undefined;
|
|
5955
5900
|
/**
|
|
@@ -6335,8 +6280,8 @@ export interface GetObjectOutput {
|
|
|
6335
6280
|
*/
|
|
6336
6281
|
Expiration?: string;
|
|
6337
6282
|
/**
|
|
6338
|
-
* <p>Provides information about object restoration action and expiration time of the
|
|
6339
|
-
* object copy.</p>
|
|
6283
|
+
* <p>Provides information about object restoration action and expiration time of the
|
|
6284
|
+
* restored object copy.</p>
|
|
6340
6285
|
*/
|
|
6341
6286
|
Restore?: string;
|
|
6342
6287
|
/**
|
|
@@ -6429,7 +6374,7 @@ export interface GetObjectOutput {
|
|
|
6429
6374
|
WebsiteRedirectLocation?: string;
|
|
6430
6375
|
/**
|
|
6431
6376
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
6432
|
-
* AES256,
|
|
6377
|
+
* AES256, aws:kms).</p>
|
|
6433
6378
|
*/
|
|
6434
6379
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
6435
6380
|
/**
|
|
@@ -6449,12 +6394,11 @@ export interface GetObjectOutput {
|
|
|
6449
6394
|
SSECustomerKeyMD5?: string;
|
|
6450
6395
|
/**
|
|
6451
6396
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
6452
|
-
*
|
|
6397
|
+
* customer managed key that was used for the object.</p>
|
|
6453
6398
|
*/
|
|
6454
6399
|
SSEKMSKeyId?: string;
|
|
6455
6400
|
/**
|
|
6456
|
-
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services
|
|
6457
|
-
* KMS (SSE-KMS).</p>
|
|
6401
|
+
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
|
|
6458
6402
|
*/
|
|
6459
6403
|
BucketKeyEnabled?: boolean;
|
|
6460
6404
|
/**
|
|
@@ -6473,9 +6417,8 @@ export interface GetObjectOutput {
|
|
|
6473
6417
|
*/
|
|
6474
6418
|
ReplicationStatus?: ReplicationStatus | string;
|
|
6475
6419
|
/**
|
|
6476
|
-
* <p>The count of parts this object has. This value is only returned if you specify
|
|
6477
|
-
*
|
|
6478
|
-
* upload.</p>
|
|
6420
|
+
* <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code>
|
|
6421
|
+
* in your request and the object was uploaded as a multipart upload.</p>
|
|
6479
6422
|
*/
|
|
6480
6423
|
PartsCount?: number;
|
|
6481
6424
|
/**
|
|
@@ -6515,8 +6458,8 @@ export interface GetObjectRequest {
|
|
|
6515
6458
|
* <p>The bucket name containing the object. </p>
|
|
6516
6459
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6517
6460
|
* <p>When using an Object Lambda access point the hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com.</p>
|
|
6518
|
-
* <p>When
|
|
6519
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
6461
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
6462
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6520
6463
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
6521
6464
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
6522
6465
|
*/
|
|
@@ -6547,7 +6490,7 @@ export interface GetObjectRequest {
|
|
|
6547
6490
|
Key: string | undefined;
|
|
6548
6491
|
/**
|
|
6549
6492
|
* <p>Downloads the specified range bytes of an object. For more information about the HTTP
|
|
6550
|
-
* Range header, see <a href="https://www.
|
|
6493
|
+
* Range header, see <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35">https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35</a>.</p>
|
|
6551
6494
|
* <note>
|
|
6552
6495
|
* <p>Amazon S3 doesn't support retrieving multiple ranges of data per <code>GET</code>
|
|
6553
6496
|
* request.</p>
|
|
@@ -6798,9 +6741,9 @@ export interface GetObjectAttributesParts {
|
|
|
6798
6741
|
*/
|
|
6799
6742
|
MaxParts?: number;
|
|
6800
6743
|
/**
|
|
6801
|
-
* <p>Indicates whether the returned list of parts is truncated. A value of
|
|
6802
|
-
*
|
|
6803
|
-
* exceeds the limit returned in the <code>MaxParts</code> element.</p>
|
|
6744
|
+
* <p>Indicates whether the returned list of parts is truncated. A value of
|
|
6745
|
+
* <code>true</code> indicates that the list was truncated. A list can be truncated if the
|
|
6746
|
+
* number of parts exceeds the limit returned in the <code>MaxParts</code> element.</p>
|
|
6804
6747
|
*/
|
|
6805
6748
|
IsTruncated?: boolean;
|
|
6806
6749
|
/**
|
|
@@ -6834,7 +6777,7 @@ export interface GetObjectAttributesOutput {
|
|
|
6834
6777
|
RequestCharged?: RequestCharged | string;
|
|
6835
6778
|
/**
|
|
6836
6779
|
* <p>An ETag is an opaque identifier assigned by a web server to a specific version of a
|
|
6837
|
-
*
|
|
6780
|
+
* resource found at a URL.</p>
|
|
6838
6781
|
*/
|
|
6839
6782
|
ETag?: string;
|
|
6840
6783
|
/**
|
|
@@ -6848,7 +6791,8 @@ export interface GetObjectAttributesOutput {
|
|
|
6848
6791
|
/**
|
|
6849
6792
|
* <p>Provides the storage class information of the object. Amazon S3 returns this header for all
|
|
6850
6793
|
* objects except for S3 Standard storage class objects.</p>
|
|
6851
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
6794
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
6795
|
+
* Classes</a>.</p>
|
|
6852
6796
|
*/
|
|
6853
6797
|
StorageClass?: StorageClass | string;
|
|
6854
6798
|
/**
|
|
@@ -6878,8 +6822,8 @@ export interface GetObjectAttributesRequest {
|
|
|
6878
6822
|
/**
|
|
6879
6823
|
* <p>The name of the bucket that contains the object.</p>
|
|
6880
6824
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6881
|
-
* <p>When
|
|
6882
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
6825
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
6826
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
6883
6827
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
6884
6828
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
6885
6829
|
*/
|
|
@@ -6898,24 +6842,25 @@ export interface GetObjectAttributesRequest {
|
|
|
6898
6842
|
MaxParts?: number;
|
|
6899
6843
|
/**
|
|
6900
6844
|
* <p>Specifies the part after which listing should begin. Only parts with higher part numbers
|
|
6901
|
-
*
|
|
6845
|
+
* will be listed.</p>
|
|
6902
6846
|
*/
|
|
6903
6847
|
PartNumberMarker?: string;
|
|
6904
6848
|
/**
|
|
6905
|
-
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
6849
|
+
* <p>Specifies the algorithm to use when encrypting the object (for example,
|
|
6850
|
+
* AES256).</p>
|
|
6906
6851
|
*/
|
|
6907
6852
|
SSECustomerAlgorithm?: string;
|
|
6908
6853
|
/**
|
|
6909
6854
|
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
|
|
6910
|
-
*
|
|
6911
|
-
*
|
|
6855
|
+
* value is used to store the object and then it is discarded; Amazon S3 does not store the
|
|
6856
|
+
* encryption key. The key must be appropriate for use with the algorithm specified in the
|
|
6912
6857
|
* <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
|
|
6913
6858
|
*/
|
|
6914
6859
|
SSECustomerKey?: string;
|
|
6915
6860
|
/**
|
|
6916
6861
|
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
|
|
6917
|
-
*
|
|
6918
|
-
*
|
|
6862
|
+
* this header for a message integrity check to ensure that the encryption key was transmitted
|
|
6863
|
+
* without error.</p>
|
|
6919
6864
|
*/
|
|
6920
6865
|
SSECustomerKeyMD5?: string;
|
|
6921
6866
|
/**
|
|
@@ -6930,8 +6875,8 @@ export interface GetObjectAttributesRequest {
|
|
|
6930
6875
|
*/
|
|
6931
6876
|
ExpectedBucketOwner?: string;
|
|
6932
6877
|
/**
|
|
6933
|
-
* <p>An XML header that specifies the fields at the root level that you want returned in
|
|
6934
|
-
* response. Fields that you do not specify are not returned.</p>
|
|
6878
|
+
* <p>An XML header that specifies the fields at the root level that you want returned in
|
|
6879
|
+
* the response. Fields that you do not specify are not returned.</p>
|
|
6935
6880
|
*/
|
|
6936
6881
|
ObjectAttributes: (ObjectAttributes | string)[] | undefined;
|
|
6937
6882
|
}
|
|
@@ -7016,12 +6961,12 @@ export type ObjectLockRetentionMode = (typeof ObjectLockRetentionMode)[keyof typ
|
|
|
7016
6961
|
* <ul>
|
|
7017
6962
|
* <li>
|
|
7018
6963
|
* <p>The <code>DefaultRetention</code> settings require both a mode and a
|
|
7019
|
-
*
|
|
6964
|
+
* period.</p>
|
|
7020
6965
|
* </li>
|
|
7021
6966
|
* <li>
|
|
7022
|
-
* <p>The <code>DefaultRetention</code> period can be either <code>Days</code>
|
|
7023
|
-
*
|
|
7024
|
-
*
|
|
6967
|
+
* <p>The <code>DefaultRetention</code> period can be either <code>Days</code>
|
|
6968
|
+
* or <code>Years</code> but you must select one. You cannot specify <code>Days</code>
|
|
6969
|
+
* and <code>Years</code> at the same time.</p>
|
|
7025
6970
|
* </li>
|
|
7026
6971
|
* </ul>
|
|
7027
6972
|
* </note>
|
|
@@ -7050,9 +6995,9 @@ export interface DefaultRetention {
|
|
|
7050
6995
|
export interface ObjectLockRule {
|
|
7051
6996
|
/**
|
|
7052
6997
|
* <p>The default Object Lock retention mode and period that you want to apply to new objects
|
|
7053
|
-
* placed in the specified bucket. Bucket settings require both a mode and a period.
|
|
7054
|
-
* period can be either <code>Days</code> or <code>Years</code> but you must select one.
|
|
7055
|
-
* cannot specify <code>Days</code> and <code>Years</code> at the same time.</p>
|
|
6998
|
+
* placed in the specified bucket. Bucket settings require both a mode and a period.
|
|
6999
|
+
* The period can be either <code>Days</code> or <code>Years</code> but you must select one.
|
|
7000
|
+
* You cannot specify <code>Days</code> and <code>Years</code> at the same time.</p>
|
|
7056
7001
|
*/
|
|
7057
7002
|
DefaultRetention?: DefaultRetention;
|
|
7058
7003
|
}
|
|
@@ -7062,17 +7007,16 @@ export interface ObjectLockRule {
|
|
|
7062
7007
|
*/
|
|
7063
7008
|
export interface ObjectLockConfiguration {
|
|
7064
7009
|
/**
|
|
7065
|
-
* <p>Indicates whether this bucket has an Object Lock configuration enabled.
|
|
7066
|
-
*
|
|
7067
|
-
* bucket. </p>
|
|
7010
|
+
* <p>Indicates whether this bucket has an Object Lock configuration enabled.
|
|
7011
|
+
* Enable <code>ObjectLockEnabled</code> when you apply <code>ObjectLockConfiguration</code>
|
|
7012
|
+
* to a bucket. </p>
|
|
7068
7013
|
*/
|
|
7069
7014
|
ObjectLockEnabled?: ObjectLockEnabled | string;
|
|
7070
7015
|
/**
|
|
7071
|
-
* <p>Specifies the Object Lock rule for the specified object. Enable the this rule when you
|
|
7072
|
-
*
|
|
7073
|
-
*
|
|
7074
|
-
*
|
|
7075
|
-
* time.</p>
|
|
7016
|
+
* <p>Specifies the Object Lock rule for the specified object. Enable the this rule when you apply
|
|
7017
|
+
* <code>ObjectLockConfiguration</code> to a bucket. Bucket settings require both a mode and a period.
|
|
7018
|
+
* The period can be either <code>Days</code> or <code>Years</code> but you must select one.
|
|
7019
|
+
* You cannot specify <code>Days</code> and <code>Years</code> at the same time.</p>
|
|
7076
7020
|
*/
|
|
7077
7021
|
Rule?: ObjectLockRule;
|
|
7078
7022
|
}
|
|
@@ -7175,8 +7119,8 @@ export interface GetObjectTaggingRequest {
|
|
|
7175
7119
|
/**
|
|
7176
7120
|
* <p>The bucket name containing the object for which to get the tagging information. </p>
|
|
7177
7121
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7178
|
-
* <p>When
|
|
7179
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
7122
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
7123
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7180
7124
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
7181
7125
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
7182
7126
|
*/
|
|
@@ -7284,8 +7228,9 @@ export interface PublicAccessBlockConfiguration {
|
|
|
7284
7228
|
BlockPublicPolicy?: boolean;
|
|
7285
7229
|
/**
|
|
7286
7230
|
* <p>Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting
|
|
7287
|
-
* this element to <code>TRUE</code> restricts access to this bucket to only Amazon Web Service
|
|
7288
|
-
* a public
|
|
7231
|
+
* this element to <code>TRUE</code> restricts access to this bucket to only Amazon Web Service
|
|
7232
|
+
* principals and authorized users within this account if the bucket has a public
|
|
7233
|
+
* policy.</p>
|
|
7289
7234
|
* <p>Enabling this setting doesn't affect previously stored bucket policies, except that
|
|
7290
7235
|
* public and cross-account access within any public bucket policy, including non-public
|
|
7291
7236
|
* delegation to specific accounts, is blocked.</p>
|
|
@@ -7325,8 +7270,8 @@ export interface HeadBucketRequest {
|
|
|
7325
7270
|
/**
|
|
7326
7271
|
* <p>The bucket name.</p>
|
|
7327
7272
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7328
|
-
* <p>When
|
|
7329
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
7273
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
7274
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7330
7275
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
7331
7276
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
7332
7277
|
*/
|
|
@@ -7483,8 +7428,10 @@ export interface HeadObjectOutput {
|
|
|
7483
7428
|
*/
|
|
7484
7429
|
WebsiteRedirectLocation?: string;
|
|
7485
7430
|
/**
|
|
7486
|
-
* <p>
|
|
7487
|
-
*
|
|
7431
|
+
* <p>If the object is stored using server-side encryption either with an Amazon Web Services KMS key or
|
|
7432
|
+
* an Amazon S3-managed encryption key, the response includes this header with
|
|
7433
|
+
* the value of the server-side encryption algorithm used when storing this object in Amazon
|
|
7434
|
+
* S3 (for example, AES256, aws:kms).</p>
|
|
7488
7435
|
*/
|
|
7489
7436
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
7490
7437
|
/**
|
|
@@ -7504,18 +7451,18 @@ export interface HeadObjectOutput {
|
|
|
7504
7451
|
SSECustomerKeyMD5?: string;
|
|
7505
7452
|
/**
|
|
7506
7453
|
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
|
|
7507
|
-
*
|
|
7454
|
+
* customer managed key that was used for the object.</p>
|
|
7508
7455
|
*/
|
|
7509
7456
|
SSEKMSKeyId?: string;
|
|
7510
7457
|
/**
|
|
7511
|
-
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services
|
|
7512
|
-
* KMS (SSE-KMS).</p>
|
|
7458
|
+
* <p>Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
|
|
7513
7459
|
*/
|
|
7514
7460
|
BucketKeyEnabled?: boolean;
|
|
7515
7461
|
/**
|
|
7516
7462
|
* <p>Provides storage class information of the object. Amazon S3 returns this header for all
|
|
7517
7463
|
* objects except for S3 Standard storage class objects.</p>
|
|
7518
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
7464
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage
|
|
7465
|
+
* Classes</a>.</p>
|
|
7519
7466
|
*/
|
|
7520
7467
|
StorageClass?: StorageClass | string;
|
|
7521
7468
|
/**
|
|
@@ -7534,9 +7481,9 @@ export interface HeadObjectOutput {
|
|
|
7534
7481
|
* <ul>
|
|
7535
7482
|
* <li>
|
|
7536
7483
|
* <p>
|
|
7537
|
-
* <b>If requesting an object from the source bucket</b>,
|
|
7538
|
-
*
|
|
7539
|
-
*
|
|
7484
|
+
* <b>If requesting an object from the source bucket</b>, Amazon S3 will return the
|
|
7485
|
+
* <code>x-amz-replication-status</code> header if the object in your request is
|
|
7486
|
+
* eligible for replication.</p>
|
|
7540
7487
|
* <p> For example, suppose that in your replication configuration, you specify object
|
|
7541
7488
|
* prefix <code>TaxDocs</code> requesting Amazon S3 to replicate objects with key prefix
|
|
7542
7489
|
* <code>TaxDocs</code>. Any objects you upload with this key name prefix, for
|
|
@@ -7547,34 +7494,34 @@ export interface HeadObjectOutput {
|
|
|
7547
7494
|
* </li>
|
|
7548
7495
|
* <li>
|
|
7549
7496
|
* <p>
|
|
7550
|
-
* <b>If requesting an object from a destination
|
|
7551
|
-
*
|
|
7552
|
-
*
|
|
7553
|
-
*
|
|
7497
|
+
* <b>If requesting an object from a destination bucket</b>, Amazon S3 will return the
|
|
7498
|
+
* <code>x-amz-replication-status</code> header with value REPLICA if the object in
|
|
7499
|
+
* your request is a replica that Amazon S3 created and there is no replica modification
|
|
7500
|
+
* replication in progress.</p>
|
|
7554
7501
|
* </li>
|
|
7555
7502
|
* <li>
|
|
7556
7503
|
* <p>
|
|
7557
|
-
* <b>When replicating objects to multiple destination
|
|
7558
|
-
*
|
|
7559
|
-
*
|
|
7560
|
-
*
|
|
7561
|
-
*
|
|
7562
|
-
*
|
|
7504
|
+
* <b>When replicating objects to multiple destination buckets</b>, the
|
|
7505
|
+
* <code>x-amz-replication-status</code> header acts differently. The header of the
|
|
7506
|
+
* source object will only return a value of COMPLETED when replication is successful to
|
|
7507
|
+
* all destinations. The header will remain at value PENDING until replication has
|
|
7508
|
+
* completed for all destinations. If one or more destinations fails replication the
|
|
7509
|
+
* header will return FAILED. </p>
|
|
7563
7510
|
* </li>
|
|
7564
7511
|
* </ul>
|
|
7565
7512
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html">Replication</a>.</p>
|
|
7566
7513
|
*/
|
|
7567
7514
|
ReplicationStatus?: ReplicationStatus | string;
|
|
7568
7515
|
/**
|
|
7569
|
-
* <p>The count of parts this object has. This value is only returned if you specify
|
|
7570
|
-
*
|
|
7571
|
-
* upload.</p>
|
|
7516
|
+
* <p>The count of parts this object has. This value is only returned if you specify <code>partNumber</code>
|
|
7517
|
+
* in your request and the object was uploaded as a multipart upload.</p>
|
|
7572
7518
|
*/
|
|
7573
7519
|
PartsCount?: number;
|
|
7574
7520
|
/**
|
|
7575
7521
|
* <p>The Object Lock mode, if any, that's in effect for this object. This header is only
|
|
7576
7522
|
* returned if the requester has the <code>s3:GetObjectRetention</code> permission. For more
|
|
7577
|
-
* information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object
|
|
7523
|
+
* information about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object
|
|
7524
|
+
* Lock</a>. </p>
|
|
7578
7525
|
*/
|
|
7579
7526
|
ObjectLockMode?: ObjectLockMode | string;
|
|
7580
7527
|
/**
|
|
@@ -7597,8 +7544,8 @@ export interface HeadObjectRequest {
|
|
|
7597
7544
|
/**
|
|
7598
7545
|
* <p>The name of the bucket containing the object.</p>
|
|
7599
7546
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7600
|
-
* <p>When
|
|
7601
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
7547
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
7548
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
7602
7549
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
7603
7550
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
7604
7551
|
*/
|
|
@@ -7628,9 +7575,8 @@ export interface HeadObjectRequest {
|
|
|
7628
7575
|
*/
|
|
7629
7576
|
Key: string | undefined;
|
|
7630
7577
|
/**
|
|
7631
|
-
* <p>HeadObject returns only the metadata for an object
|
|
7632
|
-
*
|
|
7633
|
-
* satisfiable, S3 returns a <code>416 - Requested Range Not Satisfiable</code> error.</p>
|
|
7578
|
+
* <p>Because <code>HeadObject</code> returns only the metadata for an object, this parameter
|
|
7579
|
+
* has no effect.</p>
|
|
7634
7580
|
*/
|
|
7635
7581
|
Range?: string;
|
|
7636
7582
|
/**
|
|
@@ -7675,8 +7621,8 @@ export interface HeadObjectRequest {
|
|
|
7675
7621
|
/**
|
|
7676
7622
|
* <p>To retrieve the checksum, this parameter must be enabled.</p>
|
|
7677
7623
|
* <p>In addition, if you enable <code>ChecksumMode</code> and the object is encrypted with
|
|
7678
|
-
*
|
|
7679
|
-
*
|
|
7624
|
+
* Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the
|
|
7625
|
+
* <code>kms:Decrypt</code> action for the request to succeed.</p>
|
|
7680
7626
|
*/
|
|
7681
7627
|
ChecksumMode?: ChecksumMode | string;
|
|
7682
7628
|
}
|
|
@@ -7877,8 +7823,7 @@ export interface Bucket {
|
|
|
7877
7823
|
*/
|
|
7878
7824
|
Name?: string;
|
|
7879
7825
|
/**
|
|
7880
|
-
* <p>Date the bucket was created. This date can change when making changes to your bucket,
|
|
7881
|
-
* such as editing its bucket policy.</p>
|
|
7826
|
+
* <p>Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.</p>
|
|
7882
7827
|
*/
|
|
7883
7828
|
CreationDate?: Date;
|
|
7884
7829
|
}
|
|
@@ -7925,8 +7870,8 @@ export type EncodingType = (typeof EncodingType)[keyof typeof EncodingType];
|
|
|
7925
7870
|
*/
|
|
7926
7871
|
export interface Initiator {
|
|
7927
7872
|
/**
|
|
7928
|
-
* <p>If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the
|
|
7929
|
-
*
|
|
7873
|
+
* <p>If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal
|
|
7874
|
+
* is an IAM User, it provides a user ARN value.</p>
|
|
7930
7875
|
*/
|
|
7931
7876
|
ID?: string;
|
|
7932
7877
|
/**
|
|
@@ -7973,8 +7918,7 @@ export interface MultipartUpload {
|
|
|
7973
7918
|
*/
|
|
7974
7919
|
export interface ListMultipartUploadsOutput {
|
|
7975
7920
|
/**
|
|
7976
|
-
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
7977
|
-
* access point ARN or access point alias if used.</p>
|
|
7921
|
+
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.</p>
|
|
7978
7922
|
*/
|
|
7979
7923
|
Bucket?: string;
|
|
7980
7924
|
/**
|
|
@@ -8045,8 +7989,8 @@ export interface ListMultipartUploadsRequest {
|
|
|
8045
7989
|
/**
|
|
8046
7990
|
* <p>The name of the bucket to which the multipart upload was initiated. </p>
|
|
8047
7991
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8048
|
-
* <p>When
|
|
8049
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
7992
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
7993
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8050
7994
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8051
7995
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8052
7996
|
*/
|
|
@@ -8116,6 +8060,7 @@ export declare const ObjectStorageClass: {
|
|
|
8116
8060
|
readonly ONEZONE_IA: "ONEZONE_IA";
|
|
8117
8061
|
readonly OUTPOSTS: "OUTPOSTS";
|
|
8118
8062
|
readonly REDUCED_REDUNDANCY: "REDUCED_REDUNDANCY";
|
|
8063
|
+
readonly SNOW: "SNOW";
|
|
8119
8064
|
readonly STANDARD: "STANDARD";
|
|
8120
8065
|
readonly STANDARD_IA: "STANDARD_IA";
|
|
8121
8066
|
};
|
|
@@ -8145,8 +8090,8 @@ export interface _Object {
|
|
|
8145
8090
|
* <ul>
|
|
8146
8091
|
* <li>
|
|
8147
8092
|
* <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the
|
|
8148
|
-
* Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that
|
|
8149
|
-
*
|
|
8093
|
+
* Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are
|
|
8094
|
+
* an MD5 digest of their object data.</p>
|
|
8150
8095
|
* </li>
|
|
8151
8096
|
* <li>
|
|
8152
8097
|
* <p>Objects created by the PUT Object, POST Object, or Copy operation, or through the
|
|
@@ -8155,8 +8100,8 @@ export interface _Object {
|
|
|
8155
8100
|
* </li>
|
|
8156
8101
|
* <li>
|
|
8157
8102
|
* <p>If an object is created by either the Multipart Upload or Part Copy operation, the
|
|
8158
|
-
* ETag is not an MD5 digest, regardless of the method of encryption. If an object
|
|
8159
|
-
* larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a
|
|
8103
|
+
* ETag is not an MD5 digest, regardless of the method of encryption. If an object
|
|
8104
|
+
* is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a
|
|
8160
8105
|
* Multipart Upload, and therefore the ETag will not be an MD5 digest.</p>
|
|
8161
8106
|
* </li>
|
|
8162
8107
|
* </ul>
|
|
@@ -8227,8 +8172,8 @@ export interface ListObjectsOutput {
|
|
|
8227
8172
|
*/
|
|
8228
8173
|
MaxKeys?: number;
|
|
8229
8174
|
/**
|
|
8230
|
-
* <p>All of the keys (up to 1,000) rolled up in a common prefix count as a single return when
|
|
8231
|
-
*
|
|
8175
|
+
* <p>All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating
|
|
8176
|
+
* the number of returns. </p>
|
|
8232
8177
|
* <p>A response can contain CommonPrefixes only if you specify a delimiter.</p>
|
|
8233
8178
|
* <p>CommonPrefixes contains all (if there are any) keys between Prefix and the next
|
|
8234
8179
|
* occurrence of the string specified by the delimiter.</p>
|
|
@@ -8251,8 +8196,8 @@ export interface ListObjectsRequest {
|
|
|
8251
8196
|
/**
|
|
8252
8197
|
* <p>The name of the bucket containing the objects.</p>
|
|
8253
8198
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8254
|
-
* <p>When
|
|
8255
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8199
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8200
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8256
8201
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8257
8202
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8258
8203
|
*/
|
|
@@ -8271,12 +8216,12 @@ export interface ListObjectsRequest {
|
|
|
8271
8216
|
EncodingType?: EncodingType | string;
|
|
8272
8217
|
/**
|
|
8273
8218
|
* <p>Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after
|
|
8274
|
-
*
|
|
8219
|
+
* this specified key. Marker can be any key in the bucket.</p>
|
|
8275
8220
|
*/
|
|
8276
8221
|
Marker?: string;
|
|
8277
8222
|
/**
|
|
8278
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8279
|
-
*
|
|
8223
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns up
|
|
8224
|
+
* to 1,000 key names. The response might contain fewer keys but will never contain more.
|
|
8280
8225
|
* </p>
|
|
8281
8226
|
*/
|
|
8282
8227
|
MaxKeys?: number;
|
|
@@ -8323,8 +8268,8 @@ export interface ListObjectsV2Output {
|
|
|
8323
8268
|
/**
|
|
8324
8269
|
* <p>The bucket name.</p>
|
|
8325
8270
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8326
|
-
* <p>When
|
|
8327
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8271
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8272
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8328
8273
|
*/
|
|
8329
8274
|
Name?: string;
|
|
8330
8275
|
/**
|
|
@@ -8339,14 +8284,14 @@ export interface ListObjectsV2Output {
|
|
|
8339
8284
|
*/
|
|
8340
8285
|
Delimiter?: string;
|
|
8341
8286
|
/**
|
|
8342
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8343
|
-
*
|
|
8287
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns up
|
|
8288
|
+
* to 1,000 key names. The response might contain fewer keys but will never contain
|
|
8344
8289
|
* more.</p>
|
|
8345
8290
|
*/
|
|
8346
8291
|
MaxKeys?: number;
|
|
8347
8292
|
/**
|
|
8348
|
-
* <p>All of the keys (up to 1,000) rolled up into a common prefix count as a single return
|
|
8349
|
-
*
|
|
8293
|
+
* <p>All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating
|
|
8294
|
+
* the number of returns.</p>
|
|
8350
8295
|
* <p>A response can contain <code>CommonPrefixes</code> only if you specify a
|
|
8351
8296
|
* delimiter.</p>
|
|
8352
8297
|
* <p>
|
|
@@ -8372,8 +8317,8 @@ export interface ListObjectsV2Output {
|
|
|
8372
8317
|
EncodingType?: EncodingType | string;
|
|
8373
8318
|
/**
|
|
8374
8319
|
* <p>KeyCount is the number of keys returned with this request. KeyCount will always be less
|
|
8375
|
-
* than or
|
|
8376
|
-
*
|
|
8320
|
+
* than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than
|
|
8321
|
+
* equals 50 keys </p>
|
|
8377
8322
|
*/
|
|
8378
8323
|
KeyCount?: number;
|
|
8379
8324
|
/**
|
|
@@ -8400,8 +8345,8 @@ export interface ListObjectsV2Request {
|
|
|
8400
8345
|
/**
|
|
8401
8346
|
* <p>Bucket name to list. </p>
|
|
8402
8347
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8403
|
-
* <p>When
|
|
8404
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8348
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8349
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8405
8350
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8406
8351
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8407
8352
|
*/
|
|
@@ -8415,8 +8360,8 @@ export interface ListObjectsV2Request {
|
|
|
8415
8360
|
*/
|
|
8416
8361
|
EncodingType?: EncodingType | string;
|
|
8417
8362
|
/**
|
|
8418
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8419
|
-
*
|
|
8363
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns up
|
|
8364
|
+
* to 1,000 key names. The response might contain fewer keys but will never contain
|
|
8420
8365
|
* more.</p>
|
|
8421
8366
|
*/
|
|
8422
8367
|
MaxKeys?: number;
|
|
@@ -8637,9 +8582,9 @@ export interface ListObjectVersionsRequest {
|
|
|
8637
8582
|
*/
|
|
8638
8583
|
KeyMarker?: string;
|
|
8639
8584
|
/**
|
|
8640
|
-
* <p>Sets the maximum number of keys returned in the response. By default the action returns
|
|
8641
|
-
*
|
|
8642
|
-
*
|
|
8585
|
+
* <p>Sets the maximum number of keys returned in the response. By default the action returns up
|
|
8586
|
+
* to 1,000 key names. The response might contain fewer keys but will never contain more. If
|
|
8587
|
+
* additional keys satisfy the search criteria, but were not returned because max-keys was
|
|
8643
8588
|
* exceeded, the response contains <isTruncated>true</isTruncated>. To return the
|
|
8644
8589
|
* additional keys, see key-marker and version-id-marker.</p>
|
|
8645
8590
|
*/
|
|
@@ -8720,7 +8665,8 @@ export interface ListPartsOutput {
|
|
|
8720
8665
|
* <p>If the bucket has a lifecycle rule configured with an action to abort incomplete
|
|
8721
8666
|
* multipart uploads and the prefix in the lifecycle rule matches the object name in the
|
|
8722
8667
|
* request, then the response includes this header indicating when the initiated multipart
|
|
8723
|
-
* upload will become eligible for abort operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting
|
|
8668
|
+
* upload will become eligible for abort operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting
|
|
8669
|
+
* Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a>.</p>
|
|
8724
8670
|
* <p>The response will also include the <code>x-amz-abort-rule-id</code> header that will
|
|
8725
8671
|
* provide the ID of the lifecycle configuration rule that defines this action.</p>
|
|
8726
8672
|
*/
|
|
@@ -8732,8 +8678,7 @@ export interface ListPartsOutput {
|
|
|
8732
8678
|
*/
|
|
8733
8679
|
AbortRuleId?: string;
|
|
8734
8680
|
/**
|
|
8735
|
-
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the
|
|
8736
|
-
* access point ARN or access point alias if used.</p>
|
|
8681
|
+
* <p>The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.</p>
|
|
8737
8682
|
*/
|
|
8738
8683
|
Bucket?: string;
|
|
8739
8684
|
/**
|
|
@@ -8806,8 +8751,8 @@ export interface ListPartsRequest {
|
|
|
8806
8751
|
/**
|
|
8807
8752
|
* <p>The name of the bucket to which the parts are being uploaded. </p>
|
|
8808
8753
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8809
|
-
* <p>When
|
|
8810
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
8754
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
8755
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8811
8756
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
8812
8757
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
8813
8758
|
*/
|
|
@@ -8943,8 +8888,7 @@ export interface PutBucketAclRequest {
|
|
|
8943
8888
|
GrantReadACP?: string;
|
|
8944
8889
|
/**
|
|
8945
8890
|
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
8946
|
-
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
8947
|
-
* overwrites of those objects.</p>
|
|
8891
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.</p>
|
|
8948
8892
|
*/
|
|
8949
8893
|
GrantWrite?: string;
|
|
8950
8894
|
/**
|
|
@@ -8983,8 +8927,7 @@ export interface PutBucketAnalyticsConfigurationRequest {
|
|
|
8983
8927
|
* @public
|
|
8984
8928
|
* <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more
|
|
8985
8929
|
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
8986
|
-
* Cross-Origin Resource Sharing</a> in the
|
|
8987
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
8930
|
+
* Cross-Origin Resource Sharing</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
8988
8931
|
*/
|
|
8989
8932
|
export interface CORSConfiguration {
|
|
8990
8933
|
/**
|
|
@@ -9005,9 +8948,8 @@ export interface PutBucketCorsRequest {
|
|
|
9005
8948
|
Bucket: string | undefined;
|
|
9006
8949
|
/**
|
|
9007
8950
|
* <p>Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more
|
|
9008
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
9009
|
-
*
|
|
9010
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
8951
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource
|
|
8952
|
+
* Sharing</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9011
8953
|
*/
|
|
9012
8954
|
CORSConfiguration: CORSConfiguration | undefined;
|
|
9013
8955
|
/**
|
|
@@ -9039,19 +8981,16 @@ export interface PutBucketCorsRequest {
|
|
|
9039
8981
|
*/
|
|
9040
8982
|
export interface PutBucketEncryptionRequest {
|
|
9041
8983
|
/**
|
|
9042
|
-
* <p>Specifies default encryption for a bucket using server-side encryption with
|
|
9043
|
-
*
|
|
9044
|
-
*
|
|
9045
|
-
* encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default
|
|
9046
|
-
* encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
|
|
8984
|
+
* <p>Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed
|
|
8985
|
+
* keys (SSE-S3) or customer managed keys (SSE-KMS). For information about
|
|
8986
|
+
* the Amazon S3 default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Default Bucket Encryption</a>
|
|
9047
8987
|
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
9048
8988
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
9049
8989
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
9050
8990
|
*/
|
|
9051
8991
|
Bucket: string | undefined;
|
|
9052
8992
|
/**
|
|
9053
|
-
* <p>The base64-encoded 128-bit MD5 digest of the server-side encryption
|
|
9054
|
-
* configuration.</p>
|
|
8993
|
+
* <p>The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.</p>
|
|
9055
8994
|
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
9056
8995
|
*/
|
|
9057
8996
|
ContentMD5?: string;
|
|
@@ -9214,8 +9153,7 @@ export interface PutBucketMetricsConfigurationRequest {
|
|
|
9214
9153
|
*/
|
|
9215
9154
|
Bucket: string | undefined;
|
|
9216
9155
|
/**
|
|
9217
|
-
* <p>The ID used to identify the metrics configuration
|
|
9218
|
-
* can only contain letters, numbers, periods, dashes, and underscores.</p>
|
|
9156
|
+
* <p>The ID used to identify the metrics configuration.</p>
|
|
9219
9157
|
*/
|
|
9220
9158
|
Id: string | undefined;
|
|
9221
9159
|
/**
|
|
@@ -9247,8 +9185,7 @@ export interface PutBucketNotificationConfigurationRequest {
|
|
|
9247
9185
|
*/
|
|
9248
9186
|
ExpectedBucketOwner?: string;
|
|
9249
9187
|
/**
|
|
9250
|
-
* <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda
|
|
9251
|
-
* destinations. True or false value.</p>
|
|
9188
|
+
* <p>Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.</p>
|
|
9252
9189
|
*/
|
|
9253
9190
|
SkipDestinationValidation?: boolean;
|
|
9254
9191
|
}
|
|
@@ -9272,8 +9209,8 @@ export interface PutBucketOwnershipControlsRequest {
|
|
|
9272
9209
|
*/
|
|
9273
9210
|
ExpectedBucketOwner?: string;
|
|
9274
9211
|
/**
|
|
9275
|
-
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or
|
|
9276
|
-
*
|
|
9212
|
+
* <p>The <code>OwnershipControls</code> (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want
|
|
9213
|
+
* to apply to this Amazon S3 bucket.</p>
|
|
9277
9214
|
*/
|
|
9278
9215
|
OwnershipControls: OwnershipControls | undefined;
|
|
9279
9216
|
}
|
|
@@ -9378,9 +9315,10 @@ export interface PutBucketRequestPaymentRequest {
|
|
|
9378
9315
|
*/
|
|
9379
9316
|
Bucket: string | undefined;
|
|
9380
9317
|
/**
|
|
9381
|
-
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a
|
|
9382
|
-
* integrity check to verify that the request body was not corrupted in transit. For
|
|
9383
|
-
* information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC
|
|
9318
|
+
* <p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a
|
|
9319
|
+
* message integrity check to verify that the request body was not corrupted in transit. For
|
|
9320
|
+
* more information, see <a href="http://www.ietf.org/rfc/rfc1864.txt">RFC
|
|
9321
|
+
* 1864</a>.</p>
|
|
9384
9322
|
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
|
|
9385
9323
|
*/
|
|
9386
9324
|
ContentMD5?: string;
|
|
@@ -9625,8 +9563,9 @@ export interface PutObjectOutput {
|
|
|
9625
9563
|
*/
|
|
9626
9564
|
ChecksumSHA256?: string;
|
|
9627
9565
|
/**
|
|
9628
|
-
* <p>
|
|
9629
|
-
*
|
|
9566
|
+
* <p>If you specified server-side encryption either with an Amazon Web Services KMS key
|
|
9567
|
+
* or Amazon S3-managed encryption key in your PUT request, the response includes this header. It
|
|
9568
|
+
* confirms the encryption algorithm that Amazon S3 used to encrypt the object.</p>
|
|
9630
9569
|
*/
|
|
9631
9570
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
9632
9571
|
/**
|
|
@@ -9645,22 +9584,20 @@ export interface PutObjectOutput {
|
|
|
9645
9584
|
*/
|
|
9646
9585
|
SSECustomerKeyMD5?: string;
|
|
9647
9586
|
/**
|
|
9648
|
-
* <p>If <code>x-amz-server-side-encryption</code> is has
|
|
9587
|
+
* <p>If <code>x-amz-server-side-encryption</code> is present and has the value of
|
|
9649
9588
|
* <code>aws:kms</code>, this header specifies the ID of the Amazon Web Services Key Management Service
|
|
9650
|
-
* (Amazon Web Services KMS) symmetric
|
|
9589
|
+
* (Amazon Web Services KMS) symmetric customer managed key that was used for the
|
|
9590
|
+
* object. </p>
|
|
9651
9591
|
*/
|
|
9652
9592
|
SSEKMSKeyId?: string;
|
|
9653
9593
|
/**
|
|
9654
9594
|
* <p>If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The
|
|
9655
9595
|
* value of this header is a base64-encoded UTF-8 string holding JSON with the encryption
|
|
9656
|
-
* context key-value pairs
|
|
9657
|
-
* on to Amazon Web Services KMS for future <code>GetObject</code> or <code>CopyObject</code> operations on
|
|
9658
|
-
* this object.</p>
|
|
9596
|
+
* context key-value pairs.</p>
|
|
9659
9597
|
*/
|
|
9660
9598
|
SSEKMSEncryptionContext?: string;
|
|
9661
9599
|
/**
|
|
9662
|
-
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption
|
|
9663
|
-
* with Amazon Web Services KMS (SSE-KMS).</p>
|
|
9600
|
+
* <p>Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
|
|
9664
9601
|
*/
|
|
9665
9602
|
BucketKeyEnabled?: boolean;
|
|
9666
9603
|
/**
|
|
@@ -9675,7 +9612,7 @@ export interface PutObjectOutput {
|
|
|
9675
9612
|
export interface PutObjectRequest {
|
|
9676
9613
|
/**
|
|
9677
9614
|
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
9678
|
-
*
|
|
9615
|
+
* ACL</a>.</p>
|
|
9679
9616
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9680
9617
|
*/
|
|
9681
9618
|
ACL?: ObjectCannedACL | string;
|
|
@@ -9686,8 +9623,8 @@ export interface PutObjectRequest {
|
|
|
9686
9623
|
/**
|
|
9687
9624
|
* <p>The bucket name to which the PUT action was initiated. </p>
|
|
9688
9625
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9689
|
-
* <p>When
|
|
9690
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
9626
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
9627
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9691
9628
|
* <p>Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies.
|
|
9692
9629
|
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
|
|
9693
9630
|
*/
|
|
@@ -9698,13 +9635,13 @@ export interface PutObjectRequest {
|
|
|
9698
9635
|
*/
|
|
9699
9636
|
CacheControl?: string;
|
|
9700
9637
|
/**
|
|
9701
|
-
* <p>Specifies presentational information for the object. For more information, see <a href="
|
|
9638
|
+
* <p>Specifies presentational information for the object. For more information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1">http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1</a>.</p>
|
|
9702
9639
|
*/
|
|
9703
9640
|
ContentDisposition?: string;
|
|
9704
9641
|
/**
|
|
9705
9642
|
* <p>Specifies what content encodings have been applied to the object and thus what decoding
|
|
9706
9643
|
* mechanisms must be applied to obtain the media-type referenced by the Content-Type header
|
|
9707
|
-
* field. For more information, see <a href="
|
|
9644
|
+
* field. For more information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11</a>.</p>
|
|
9708
9645
|
*/
|
|
9709
9646
|
ContentEncoding?: string;
|
|
9710
9647
|
/**
|
|
@@ -9713,7 +9650,7 @@ export interface PutObjectRequest {
|
|
|
9713
9650
|
ContentLanguage?: string;
|
|
9714
9651
|
/**
|
|
9715
9652
|
* <p>Size of the body in bytes. This parameter is useful when the size of the body cannot be
|
|
9716
|
-
* determined automatically. For more information, see <a href="
|
|
9653
|
+
* determined automatically. For more information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13</a>.</p>
|
|
9717
9654
|
*/
|
|
9718
9655
|
ContentLength?: number;
|
|
9719
9656
|
/**
|
|
@@ -9721,12 +9658,13 @@ export interface PutObjectRequest {
|
|
|
9721
9658
|
* RFC 1864. This header can be used as a message integrity check to verify that the data is
|
|
9722
9659
|
* the same data that was originally sent. Although it is optional, we recommend using the
|
|
9723
9660
|
* Content-MD5 mechanism as an end-to-end integrity check. For more information about REST
|
|
9724
|
-
* request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST
|
|
9661
|
+
* request authentication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">REST
|
|
9662
|
+
* Authentication</a>.</p>
|
|
9725
9663
|
*/
|
|
9726
9664
|
ContentMD5?: string;
|
|
9727
9665
|
/**
|
|
9728
9666
|
* <p>A standard MIME type describing the format of the contents. For more information, see
|
|
9729
|
-
* <a href="
|
|
9667
|
+
* <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17</a>.</p>
|
|
9730
9668
|
*/
|
|
9731
9669
|
ContentType?: string;
|
|
9732
9670
|
/**
|
|
@@ -9769,16 +9707,18 @@ export interface PutObjectRequest {
|
|
|
9769
9707
|
ChecksumSHA256?: string;
|
|
9770
9708
|
/**
|
|
9771
9709
|
* <p>The date and time at which the object is no longer cacheable. For more information, see
|
|
9772
|
-
* <a href="
|
|
9710
|
+
* <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21">http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21</a>.</p>
|
|
9773
9711
|
*/
|
|
9774
9712
|
Expires?: Date;
|
|
9775
9713
|
/**
|
|
9776
|
-
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
9714
|
+
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
|
|
9715
|
+
* object.</p>
|
|
9777
9716
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9778
9717
|
*/
|
|
9779
9718
|
GrantFullControl?: string;
|
|
9780
9719
|
/**
|
|
9781
|
-
* <p>Allows grantee to read the object data and its
|
|
9720
|
+
* <p>Allows grantee to read the object data and its
|
|
9721
|
+
* metadata.</p>
|
|
9782
9722
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9783
9723
|
*/
|
|
9784
9724
|
GrantRead?: string;
|
|
@@ -9788,7 +9728,8 @@ export interface PutObjectRequest {
|
|
|
9788
9728
|
*/
|
|
9789
9729
|
GrantReadACP?: string;
|
|
9790
9730
|
/**
|
|
9791
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
9731
|
+
* <p>Allows grantee to write the ACL for the applicable
|
|
9732
|
+
* object.</p>
|
|
9792
9733
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9793
9734
|
*/
|
|
9794
9735
|
GrantWriteACP?: string;
|
|
@@ -9802,7 +9743,7 @@ export interface PutObjectRequest {
|
|
|
9802
9743
|
Metadata?: Record<string, string>;
|
|
9803
9744
|
/**
|
|
9804
9745
|
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
|
|
9805
|
-
* AES256,
|
|
9746
|
+
* AES256, aws:kms).</p>
|
|
9806
9747
|
*/
|
|
9807
9748
|
ServerSideEncryption?: ServerSideEncryption | string;
|
|
9808
9749
|
/**
|
|
@@ -9810,7 +9751,7 @@ export interface PutObjectRequest {
|
|
|
9810
9751
|
* STANDARD storage class provides high durability and high availability. Depending on
|
|
9811
9752
|
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
|
|
9812
9753
|
* 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
|
|
9813
|
-
*
|
|
9754
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
9814
9755
|
*/
|
|
9815
9756
|
StorageClass?: StorageClass | string;
|
|
9816
9757
|
/**
|
|
@@ -9827,9 +9768,8 @@ export interface PutObjectRequest {
|
|
|
9827
9768
|
* <p>
|
|
9828
9769
|
* <code>x-amz-website-redirect-location: http://www.example.com/</code>
|
|
9829
9770
|
* </p>
|
|
9830
|
-
* <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and
|
|
9831
|
-
*
|
|
9832
|
-
* Configure Website Page Redirects</a>. </p>
|
|
9771
|
+
* <p>For more information about website hosting in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html">Hosting Websites on Amazon S3</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html">How to Configure Website Page
|
|
9772
|
+
* Redirects</a>. </p>
|
|
9833
9773
|
*/
|
|
9834
9774
|
WebsiteRedirectLocation?: string;
|
|
9835
9775
|
/**
|
|
@@ -9851,29 +9791,25 @@ export interface PutObjectRequest {
|
|
|
9851
9791
|
*/
|
|
9852
9792
|
SSECustomerKeyMD5?: string;
|
|
9853
9793
|
/**
|
|
9854
|
-
* <p>If <code>x-amz-server-side-encryption</code> has
|
|
9855
|
-
* this header specifies the ID of the Amazon Web Services Key Management Service
|
|
9856
|
-
*
|
|
9857
|
-
*
|
|
9858
|
-
*
|
|
9859
|
-
* protect the data. If the KMS key does not exist in the same account
|
|
9860
|
-
* you must use the full ARN and not just the ID.
|
|
9794
|
+
* <p>If <code>x-amz-server-side-encryption</code> is present and has the value of
|
|
9795
|
+
* <code>aws:kms</code>, this header specifies the ID of the Amazon Web Services Key Management Service
|
|
9796
|
+
* (Amazon Web Services KMS) symmetrical customer managed key that was used for the
|
|
9797
|
+
* object. If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but do not
|
|
9798
|
+
* provide<code> x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services
|
|
9799
|
+
* managed key to protect the data. If the KMS key does not exist in the same account
|
|
9800
|
+
* issuing the command, you must use the full ARN and not just the ID.
|
|
9801
|
+
* </p>
|
|
9861
9802
|
*/
|
|
9862
9803
|
SSEKMSKeyId?: string;
|
|
9863
9804
|
/**
|
|
9864
|
-
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
|
|
9865
|
-
*
|
|
9866
|
-
*
|
|
9867
|
-
* Amazon Web Services KMS for future <code>GetObject</code> or <code>CopyObject</code> operations on this
|
|
9868
|
-
* object.</p>
|
|
9805
|
+
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this
|
|
9806
|
+
* header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value
|
|
9807
|
+
* pairs.</p>
|
|
9869
9808
|
*/
|
|
9870
9809
|
SSEKMSEncryptionContext?: string;
|
|
9871
9810
|
/**
|
|
9872
|
-
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
|
|
9873
|
-
*
|
|
9874
|
-
* causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
9875
|
-
* <p>Specifying this header with a PUT action doesn’t affect bucket-level settings for S3
|
|
9876
|
-
* Bucket Key.</p>
|
|
9811
|
+
* <p>Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to <code>true</code> causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.</p>
|
|
9812
|
+
* <p>Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.</p>
|
|
9877
9813
|
*/
|
|
9878
9814
|
BucketKeyEnabled?: boolean;
|
|
9879
9815
|
/**
|
|
@@ -9899,7 +9835,8 @@ export interface PutObjectRequest {
|
|
|
9899
9835
|
ObjectLockRetainUntilDate?: Date;
|
|
9900
9836
|
/**
|
|
9901
9837
|
* <p>Specifies whether a legal hold will be applied to this object. For more information
|
|
9902
|
-
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object
|
|
9838
|
+
* about S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Object
|
|
9839
|
+
* Lock</a>.</p>
|
|
9903
9840
|
*/
|
|
9904
9841
|
ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus | string;
|
|
9905
9842
|
/**
|
|
@@ -9922,8 +9859,7 @@ export interface PutObjectAclOutput {
|
|
|
9922
9859
|
*/
|
|
9923
9860
|
export interface PutObjectAclRequest {
|
|
9924
9861
|
/**
|
|
9925
|
-
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned
|
|
9926
|
-
* ACL</a>.</p>
|
|
9862
|
+
* <p>The canned ACL to apply to the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned ACL</a>.</p>
|
|
9927
9863
|
*/
|
|
9928
9864
|
ACL?: ObjectCannedACL | string;
|
|
9929
9865
|
/**
|
|
@@ -9963,7 +9899,8 @@ export interface PutObjectAclRequest {
|
|
|
9963
9899
|
*/
|
|
9964
9900
|
GrantFullControl?: string;
|
|
9965
9901
|
/**
|
|
9966
|
-
* <p>Allows grantee to list the objects in the
|
|
9902
|
+
* <p>Allows grantee to list the objects in the
|
|
9903
|
+
* bucket.</p>
|
|
9967
9904
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9968
9905
|
*/
|
|
9969
9906
|
GrantRead?: string;
|
|
@@ -9974,20 +9911,20 @@ export interface PutObjectAclRequest {
|
|
|
9974
9911
|
GrantReadACP?: string;
|
|
9975
9912
|
/**
|
|
9976
9913
|
* <p>Allows grantee to create new objects in the bucket.</p>
|
|
9977
|
-
* <p>For the bucket and object owners of existing objects, also allows deletions and
|
|
9978
|
-
* overwrites of those objects.</p>
|
|
9914
|
+
* <p>For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.</p>
|
|
9979
9915
|
*/
|
|
9980
9916
|
GrantWrite?: string;
|
|
9981
9917
|
/**
|
|
9982
|
-
* <p>Allows grantee to write the ACL for the applicable
|
|
9918
|
+
* <p>Allows grantee to write the ACL for the applicable
|
|
9919
|
+
* bucket.</p>
|
|
9983
9920
|
* <p>This action is not supported by Amazon S3 on Outposts.</p>
|
|
9984
9921
|
*/
|
|
9985
9922
|
GrantWriteACP?: string;
|
|
9986
9923
|
/**
|
|
9987
9924
|
* <p>Key for which the PUT action was initiated.</p>
|
|
9988
9925
|
* <p>When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9989
|
-
* <p>When
|
|
9990
|
-
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When
|
|
9926
|
+
* <p>When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code>
|
|
9927
|
+
* <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
9991
9928
|
*/
|
|
9992
9929
|
Key: string | undefined;
|
|
9993
9930
|
/**
|