-
Notifications
You must be signed in to change notification settings - Fork 573
/
models_0.ts
12494 lines (11145 loc) · 471 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@aws-sdk/smithy-client";
import { Readable } from "stream";
import { S3ServiceException as __BaseException } from "./S3ServiceException";
/**
* <p>Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will
* wait before permanently removing all parts of the upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">
* Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
export interface AbortIncompleteMultipartUpload {
/**
* <p>Specifies the number of days after which Amazon S3 aborts an incomplete multipart
* upload.</p>
*/
DaysAfterInitiation?: number;
}
export namespace AbortIncompleteMultipartUpload {
/**
* @internal
*/
export const filterSensitiveLog = (obj: AbortIncompleteMultipartUpload): any => ({
...obj,
});
}
export type RequestCharged = "requester";
export interface AbortMultipartUploadOutput {
/**
* <p>If present, indicates that the requester was successfully charged for the
* request.</p>
*/
RequestCharged?: RequestCharged | string;
}
export namespace AbortMultipartUploadOutput {
/**
* @internal
*/
export const filterSensitiveLog = (obj: AbortMultipartUploadOutput): any => ({
...obj,
});
}
export type RequestPayer = "requester";
export interface AbortMultipartUploadRequest {
/**
* <p>The bucket name to which the upload was taking place. </p>
* <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>
* <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>
* <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>
* <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.
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
*/
Bucket: string | undefined;
/**
* <p>Key of the object for which the multipart upload was initiated.</p>
*/
Key: string | undefined;
/**
* <p>Upload ID that identifies the multipart upload.</p>
*/
UploadId: string | undefined;
/**
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
* owners need not specify this parameter in their requests. For information about downloading
* objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
RequestPayer?: RequestPayer | string;
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
*/
ExpectedBucketOwner?: string;
}
export namespace AbortMultipartUploadRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: AbortMultipartUploadRequest): any => ({
...obj,
});
}
/**
* <p>The specified multipart upload does not exist.</p>
*/
export class NoSuchUpload extends __BaseException {
readonly name: "NoSuchUpload" = "NoSuchUpload";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<NoSuchUpload, __BaseException>) {
super({
name: "NoSuchUpload",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, NoSuchUpload.prototype);
}
}
export type BucketAccelerateStatus = "Enabled" | "Suspended";
/**
* <p>Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Amazon S3
* Transfer Acceleration</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
export interface AccelerateConfiguration {
/**
* <p>Specifies the transfer acceleration status of the bucket.</p>
*/
Status?: BucketAccelerateStatus | string;
}
export namespace AccelerateConfiguration {
/**
* @internal
*/
export const filterSensitiveLog = (obj: AccelerateConfiguration): any => ({
...obj,
});
}
export type Type = "AmazonCustomerByEmail" | "CanonicalUser" | "Group";
/**
* <p>Container for the person being granted permissions.</p>
*/
export interface Grantee {
/**
* <p>Screen name of the grantee.</p>
*/
DisplayName?: string;
/**
* <p>Email address of the grantee.</p>
* <note>
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
* <ul>
* <li>
* <p>US East (N. Virginia)</p>
* </li>
* <li>
* <p>US West (N. California)</p>
* </li>
* <li>
* <p> US West (Oregon)</p>
* </li>
* <li>
* <p> Asia Pacific (Singapore)</p>
* </li>
* <li>
* <p>Asia Pacific (Sydney)</p>
* </li>
* <li>
* <p>Asia Pacific (Tokyo)</p>
* </li>
* <li>
* <p>Europe (Ireland)</p>
* </li>
* <li>
* <p>South America (São Paulo)</p>
* </li>
* </ul>
* <p>For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference.</p>
* </note>
*/
EmailAddress?: string;
/**
* <p>The canonical user ID of the grantee.</p>
*/
ID?: string;
/**
* <p>URI of the grantee group.</p>
*/
URI?: string;
/**
* <p>Type of grantee</p>
*/
Type: Type | string | undefined;
}
export namespace Grantee {
/**
* @internal
*/
export const filterSensitiveLog = (obj: Grantee): any => ({
...obj,
});
}
export type Permission = "FULL_CONTROL" | "READ" | "READ_ACP" | "WRITE" | "WRITE_ACP";
/**
* <p>Container for grant information.</p>
*/
export interface Grant {
/**
* <p>The person being granted permissions.</p>
*/
Grantee?: Grantee;
/**
* <p>Specifies the permission given to the grantee.</p>
*/
Permission?: Permission | string;
}
export namespace Grant {
/**
* @internal
*/
export const filterSensitiveLog = (obj: Grant): any => ({
...obj,
});
}
/**
* <p>Container for the owner's display name and ID.</p>
*/
export interface Owner {
/**
* <p>Container for the display name of the owner.</p>
*/
DisplayName?: string;
/**
* <p>Container for the ID of the owner.</p>
*/
ID?: string;
}
export namespace Owner {
/**
* @internal
*/
export const filterSensitiveLog = (obj: Owner): any => ({
...obj,
});
}
/**
* <p>Contains the elements that set the ACL permissions for an object per grantee.</p>
*/
export interface AccessControlPolicy {
/**
* <p>A list of grants.</p>
*/
Grants?: Grant[];
/**
* <p>Container for the bucket owner's display name and ID.</p>
*/
Owner?: Owner;
}
export namespace AccessControlPolicy {
/**
* @internal
*/
export const filterSensitiveLog = (obj: AccessControlPolicy): any => ({
...obj,
});
}
export type OwnerOverride = "Destination";
/**
* <p>A container for information about access control for replicas.</p>
*/
export interface AccessControlTranslation {
/**
* <p>Specifies the replica ownership. For default and valid values, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html">PUT bucket
* replication</a> in the <i>Amazon S3 API Reference</i>.</p>
*/
Owner: OwnerOverride | string | undefined;
}
export namespace AccessControlTranslation {
/**
* @internal
*/
export const filterSensitiveLog = (obj: AccessControlTranslation): any => ({
...obj,
});
}
export type ServerSideEncryption = "AES256" | "aws:kms";
export interface CompleteMultipartUploadOutput {
/**
* <p>The URI that identifies the newly created object.</p>
*/
Location?: string;
/**
* <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>
* <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>
* <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>
* <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>
*/
Bucket?: string;
/**
* <p>The object key of the newly created object.</p>
*/
Key?: string;
/**
* <p>If the object expiration is configured, this will contain the expiration date
* (<code>expiry-date</code>) and rule ID (<code>rule-id</code>). The value of
* <code>rule-id</code> is URL-encoded.</p>
*/
Expiration?: string;
/**
* <p>Entity tag that identifies the newly created object's data. Objects with different
* object data will have different entity tags. The entity tag is an opaque string. The entity
* tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5
* digest of the object data, it will contain one or more nonhexadecimal characters and/or
* will consist of less than 32 or more than 32 hexadecimal digits. For more information about
* how the entity tag is calculated, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking
* object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ETag?: string;
/**
* <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32?: string;
/**
* <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32C?: string;
/**
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA1?: string;
/**
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA256?: string;
/**
* <p>If you specified server-side encryption either with an Amazon S3-managed encryption key or an
* Amazon Web Services KMS key in your initiate multipart upload request, the response
* includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the
* object.</p>
*/
ServerSideEncryption?: ServerSideEncryption | string;
/**
* <p>Version ID of the newly created object, in case the bucket has versioning turned
* on.</p>
*/
VersionId?: string;
/**
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
* customer managed key that was used for the object.</p>
*/
SSEKMSKeyId?: string;
/**
* <p>Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
*/
BucketKeyEnabled?: boolean;
/**
* <p>If present, indicates that the requester was successfully charged for the
* request.</p>
*/
RequestCharged?: RequestCharged | string;
}
export namespace CompleteMultipartUploadOutput {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CompleteMultipartUploadOutput): any => ({
...obj,
...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),
});
}
/**
* <p>Details of the parts that were uploaded.</p>
*/
export interface CompletedPart {
/**
* <p>Entity tag returned when the part was uploaded.</p>
*/
ETag?: string;
/**
* <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32?: string;
/**
* <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32C?: string;
/**
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA1?: string;
/**
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA256?: string;
/**
* <p>Part number that identifies the part. This is a positive integer between 1 and
* 10,000.</p>
*/
PartNumber?: number;
}
export namespace CompletedPart {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CompletedPart): any => ({
...obj,
});
}
/**
* <p>The container for the completed multipart upload details.</p>
*/
export interface CompletedMultipartUpload {
/**
* <p>Array of CompletedPart data types.</p>
* <p>If you do not supply a valid <code>Part</code> with your request, the service sends back an HTTP
* 400 response.</p>
*/
Parts?: CompletedPart[];
}
export namespace CompletedMultipartUpload {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CompletedMultipartUpload): any => ({
...obj,
});
}
export interface CompleteMultipartUploadRequest {
/**
* <p>Name of the bucket to which the multipart upload was initiated.</p>
* <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>
* <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>
* <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>
* <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.
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
*/
Bucket: string | undefined;
/**
* <p>Object key for which the multipart upload was initiated.</p>
*/
Key: string | undefined;
/**
* <p>The container for the multipart upload request information.</p>
*/
MultipartUpload?: CompletedMultipartUpload;
/**
* <p>ID for the initiated multipart upload.</p>
*/
UploadId: string | undefined;
/**
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
* This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32?: string;
/**
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
* This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32C?: string;
/**
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
* This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA1?: string;
/**
* <p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
* This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA256?: string;
/**
* <p>Confirms that the requester knows that they will be charged for the request. Bucket
* owners need not specify this parameter in their requests. For information about downloading
* objects from Requester Pays buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html">Downloading Objects in
* Requester Pays Buckets</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
RequestPayer?: RequestPayer | string;
/**
* <p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>
*/
ExpectedBucketOwner?: string;
/**
* <p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created
* using a checksum algorithm. For more information,
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
SSECustomerAlgorithm?: string;
/**
* <p>The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm.
* For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
SSECustomerKey?: string;
/**
* <p>The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum
* algorithm. For more information,
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the
* <i>Amazon S3 User Guide</i>.</p>
*/
SSECustomerKeyMD5?: string;
}
export namespace CompleteMultipartUploadRequest {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CompleteMultipartUploadRequest): any => ({
...obj,
...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }),
});
}
/**
* <p>Container for all response elements.</p>
*/
export interface CopyObjectResult {
/**
* <p>Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.</p>
*/
ETag?: string;
/**
* <p>Creation date of the object.</p>
*/
LastModified?: Date;
/**
* <p>The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32?: string;
/**
* <p>The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumCRC32C?: string;
/**
* <p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA1?: string;
/**
* <p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded
* with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated
* with multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums">
* Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumSHA256?: string;
}
export namespace CopyObjectResult {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CopyObjectResult): any => ({
...obj,
});
}
export interface CopyObjectOutput {
/**
* <p>Container for all response elements.</p>
*/
CopyObjectResult?: CopyObjectResult;
/**
* <p>If the object expiration is configured, the response includes this header.</p>
*/
Expiration?: string;
/**
* <p>Version of the copied object in the destination bucket.</p>
*/
CopySourceVersionId?: string;
/**
* <p>Version ID of the newly created copy.</p>
*/
VersionId?: string;
/**
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms).</p>
*/
ServerSideEncryption?: ServerSideEncryption | string;
/**
* <p>If server-side encryption with a customer-provided encryption key was requested, the
* response will include this header confirming the encryption algorithm used.</p>
*/
SSECustomerAlgorithm?: string;
/**
* <p>If server-side encryption with a customer-provided encryption key was requested, the
* response will include this header to provide round-trip message integrity verification of
* the customer-provided encryption key.</p>
*/
SSECustomerKeyMD5?: string;
/**
* <p>If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric
* customer managed key that was used for the object.</p>
*/
SSEKMSKeyId?: string;
/**
* <p>If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The
* value of this header is a base64-encoded UTF-8 string holding JSON with the encryption
* context key-value pairs.</p>
*/
SSEKMSEncryptionContext?: string;
/**
* <p>Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).</p>
*/
BucketKeyEnabled?: boolean;
/**
* <p>If present, indicates that the requester was successfully charged for the
* request.</p>
*/
RequestCharged?: RequestCharged | string;
}
export namespace CopyObjectOutput {
/**
* @internal
*/
export const filterSensitiveLog = (obj: CopyObjectOutput): any => ({
...obj,
...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }),
...(obj.SSEKMSEncryptionContext && { SSEKMSEncryptionContext: SENSITIVE_STRING }),
});
}
export type ObjectCannedACL =
| "authenticated-read"
| "aws-exec-read"
| "bucket-owner-full-control"
| "bucket-owner-read"
| "private"
| "public-read"
| "public-read-write";
export enum ChecksumAlgorithm {
CRC32 = "CRC32",
CRC32C = "CRC32C",
SHA1 = "SHA1",
SHA256 = "SHA256",
}
export type MetadataDirective = "COPY" | "REPLACE";
export type ObjectLockLegalHoldStatus = "OFF" | "ON";
export type ObjectLockMode = "COMPLIANCE" | "GOVERNANCE";
export type StorageClass =
| "DEEP_ARCHIVE"
| "GLACIER"
| "GLACIER_IR"
| "INTELLIGENT_TIERING"
| "ONEZONE_IA"
| "OUTPOSTS"
| "REDUCED_REDUNDANCY"
| "STANDARD"
| "STANDARD_IA";
export type TaggingDirective = "COPY" | "REPLACE";
export interface CopyObjectRequest {
/**
* <p>The canned ACL to apply to the object.</p>
* <p>This action is not supported by Amazon S3 on Outposts.</p>
*/
ACL?: ObjectCannedACL | string;
/**
* <p>The name of the destination bucket.</p>
* <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>
* <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>
* <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>
* <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.
* For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues</p>
*/
Bucket: string | undefined;
/**
* <p>Specifies caching behavior along the request/reply chain.</p>
*/
CacheControl?: string;
/**
* <p>Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity</a> in
* the <i>Amazon S3 User Guide</i>.</p>
*/
ChecksumAlgorithm?: ChecksumAlgorithm | string;
/**
* <p>Specifies presentational information for the object.</p>
*/
ContentDisposition?: string;
/**
* <p>Specifies what content encodings have been applied to the object and thus what decoding
* mechanisms must be applied to obtain the media-type referenced by the Content-Type header
* field.</p>
*/
ContentEncoding?: string;
/**
* <p>The language the content is in.</p>
*/
ContentLanguage?: string;
/**
* <p>A standard MIME type describing the format of the object data.</p>
*/
ContentType?: string;
/**
* <p>Specifies the source object for the copy operation. You specify the value in one of two
* formats, depending on whether you want to access the source object through an <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html">access point</a>:</p>
* <ul>
* <li>
* <p>For objects not accessed through an access point, specify the name of the source bucket
* and the key of the source object, separated by a slash (/). For example, to copy the
* object <code>reports/january.pdf</code> from the bucket
* <code>awsexamplebucket</code>, use <code>awsexamplebucket/reports/january.pdf</code>.
* The value must be URL-encoded.</p>
* </li>
* <li>
* <p>For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format <code>arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through access point <code>my-access-point</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf</code>. The value must be URL encoded.</p>
* <note>
* <p>Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.</p>
* </note>
* <p>Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format <code>arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key></code>. For example, to copy the object <code>reports/january.pdf</code> through outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf</code>. The value must be URL-encoded. </p>
* </li>
* </ul>
* <p>To copy a specific version of an object, append <code>?versionId=<version-id></code>
* to the value (for example,
* <code>awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</code>).
* If you don't specify a version ID, Amazon S3 copies the latest version of the source
* object.</p>
*/
CopySource: string | undefined;
/**
* <p>Copies the object if its entity tag (ETag) matches the specified tag.</p>
*/
CopySourceIfMatch?: string;
/**
* <p>Copies the object if it has been modified since the specified time.</p>
*/
CopySourceIfModifiedSince?: Date;
/**
* <p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>
*/
CopySourceIfNoneMatch?: string;
/**
* <p>Copies the object if it hasn't been modified since the specified time.</p>
*/
CopySourceIfUnmodifiedSince?: Date;
/**
* <p>The date and time at which the object is no longer cacheable.</p>
*/
Expires?: Date;
/**
* <p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
* object.</p>
* <p>This action is not supported by Amazon S3 on Outposts.</p>
*/
GrantFullControl?: string;
/**
* <p>Allows grantee to read the object data and its
* metadata.</p>
* <p>This action is not supported by Amazon S3 on Outposts.</p>
*/
GrantRead?: string;
/**
* <p>Allows grantee to read the object ACL.</p>
* <p>This action is not supported by Amazon S3 on Outposts.</p>
*/
GrantReadACP?: string;
/**
* <p>Allows grantee to write the ACL for the applicable
* object.</p>
* <p>This action is not supported by Amazon S3 on Outposts.</p>
*/
GrantWriteACP?: string;
/**
* <p>The key of the destination object.</p>
*/
Key: string | undefined;
/**
* <p>A map of metadata to store with the object in S3.</p>
*/
Metadata?: Record<string, string>;
/**
* <p>Specifies whether the metadata is copied from the source object or replaced with
* metadata provided in the request.</p>
*/
MetadataDirective?: MetadataDirective | string;
/**
* <p>Specifies whether the object tag-set are copied from the source object or replaced with
* tag-set provided in the request.</p>
*/
TaggingDirective?: TaggingDirective | string;
/**
* <p>The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms).</p>
*/
ServerSideEncryption?: ServerSideEncryption | string;
/**
* <p>By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The
* STANDARD storage class provides high durability and high availability. Depending on
* performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses
* 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
* <i>Amazon S3 User Guide</i>.</p>
*/
StorageClass?: StorageClass | string;
/**
* <p>If the bucket is configured as a website, redirects requests for this object to another
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
* the object metadata.</p>
*/
WebsiteRedirectLocation?: string;
/**
* <p>Specifies the algorithm to use to when encrypting the object (for example,
* AES256).</p>
*/
SSECustomerAlgorithm?: string;
/**
* <p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
* value is used to store the object and then it is discarded; Amazon S3 does not store the
* encryption key. The key must be appropriate for use with the algorithm specified in the
* <code>x-amz-server-side-encryption-customer-algorithm</code> header.</p>
*/
SSECustomerKey?: string;
/**
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses
* this header for a message integrity check to ensure that the encryption key was transmitted
* without error.</p>
*/
SSECustomerKeyMD5?: string;
/**
* <p>Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for
* an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For
* information about configuring using any of the officially 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> in the <i>Amazon S3 User Guide</i>.</p>
*/
SSEKMSKeyId?: string;
/**
* <p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this
* header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value
* pairs.</p>
*/
SSEKMSEncryptionContext?: string;
/**
* <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>
* <p>Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.</p>
*/
BucketKeyEnabled?: boolean;
/**
* <p>Specifies the algorithm to use when decrypting the source object (for example,
* AES256).</p>
*/
CopySourceSSECustomerAlgorithm?: string;
/**
* <p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source
* object. The encryption key provided in this header must be one that was used when the
* source object was created.</p>
*/
CopySourceSSECustomerKey?: string;
/**
* <p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses