/
models_1.ts
2069 lines (1804 loc) · 77.1 KB
/
models_1.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 {
ChecksumAlgorithm,
Grant,
ObjectCannedACL,
ObjectLockLegalHoldStatus,
ObjectLockMode,
ObjectLockRetention,
PublicAccessBlockConfiguration,
ReplicationStatus,
RequestCharged,
RequestPayer,
ServerSideEncryption,
StorageClass,
Tagging,
} from "./models_0";
import { S3ServiceException as __BaseException } from "./S3ServiceException";
export interface PutObjectRetentionOutput {
/**
* <p>If present, indicates that the requester was successfully charged for the
* request.</p>
*/
RequestCharged?: RequestCharged | string;
}
export interface PutObjectRetentionRequest {
/**
* <p>The bucket name that contains the object you want to apply this Object Retention
* configuration to. </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>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>The key name for the object that you want to apply this Object Retention configuration
* to.</p>
*/
Key: string | undefined;
/**
* <p>The container element for the Object Retention configuration.</p>
*/
Retention?: ObjectLockRetention;
/**
* <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 version ID for the object that you want to apply this Object Retention configuration
* to.</p>
*/
VersionId?: string;
/**
* <p>Indicates whether this action should bypass Governance-mode restrictions.</p>
*/
BypassGovernanceRetention?: boolean;
/**
* <p>The MD5 hash for the request body.</p>
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
*/
ContentMD5?: string;
/**
* <p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any
* additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. 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>
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
* <code>ChecksumAlgorithm</code> parameter.</p>
*/
ChecksumAlgorithm?: ChecksumAlgorithm | 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 interface PutObjectTaggingOutput {
/**
* <p>The versionId of the object the tag-set was added to.</p>
*/
VersionId?: string;
}
export interface PutObjectTaggingRequest {
/**
* <p>The bucket name containing the object. </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>Name of the object key.</p>
*/
Key: string | undefined;
/**
* <p>The versionId of the object that the tag-set will be added to.</p>
*/
VersionId?: string;
/**
* <p>The MD5 hash for the request body.</p>
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
*/
ContentMD5?: string;
/**
* <p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any
* additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. 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>
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
* <code>ChecksumAlgorithm</code> parameter.</p>
*/
ChecksumAlgorithm?: ChecksumAlgorithm | string;
/**
* <p>Container for the <code>TagSet</code> and <code>Tag</code> elements</p>
*/
Tagging: Tagging | undefined;
/**
* <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>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;
}
export interface PutPublicAccessBlockRequest {
/**
* <p>The name of the Amazon S3 bucket whose <code>PublicAccessBlock</code> configuration you want
* to set.</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>The MD5 hash of the <code>PutPublicAccessBlock</code> request body. </p>
* <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>
*/
ContentMD5?: string;
/**
* <p>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any
* additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. 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>
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
* <code>ChecksumAlgorithm</code> parameter.</p>
*/
ChecksumAlgorithm?: ChecksumAlgorithm | string;
/**
* <p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3
* bucket. You can enable the configuration options in any combination. For more information
* about when Amazon S3 considers a bucket or object public, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status">The Meaning of "Public"</a> in the <i>Amazon S3 User Guide</i>.</p>
*/
PublicAccessBlockConfiguration: PublicAccessBlockConfiguration | undefined;
/**
* <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>This action is not allowed against this storage tier.</p>
*/
export class ObjectAlreadyInActiveTierError extends __BaseException {
readonly name: "ObjectAlreadyInActiveTierError" = "ObjectAlreadyInActiveTierError";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ObjectAlreadyInActiveTierError, __BaseException>) {
super({
name: "ObjectAlreadyInActiveTierError",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ObjectAlreadyInActiveTierError.prototype);
}
}
export interface RestoreObjectOutput {
/**
* <p>If present, indicates that the requester was successfully charged for the
* request.</p>
*/
RequestCharged?: RequestCharged | string;
/**
* <p>Indicates the path in the provided S3 output location where Select results will be
* restored to.</p>
*/
RestoreOutputPath?: string;
}
export type Tier = "Bulk" | "Expedited" | "Standard";
/**
* <p>Container for S3 Glacier job parameters.</p>
*/
export interface GlacierJobParameters {
/**
* <p>Retrieval tier at which the restore will be processed.</p>
*/
Tier: Tier | string | undefined;
}
/**
* <p>Contains the type of server-side encryption used.</p>
*/
export interface Encryption {
/**
* <p>The server-side encryption algorithm used when storing job results in Amazon S3 (for example,
* AES256, aws:kms).</p>
*/
EncryptionType: ServerSideEncryption | string | undefined;
/**
* <p>If the encryption type is <code>aws:kms</code>, this optional value specifies the ID of
* the symmetric customer managed key to use for encryption of job results. Amazon S3 only
* supports symmetric keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and
* asymmetric keys</a> in the <i>Amazon Web Services Key Management Service Developer
* Guide</i>.</p>
*/
KMSKeyId?: string;
/**
* <p>If the encryption type is <code>aws:kms</code>, this optional value can be used to
* specify the encryption context for the restore results.</p>
*/
KMSContext?: string;
}
/**
* <p>A metadata key-value pair to store with an object.</p>
*/
export interface MetadataEntry {
/**
* <p>Name of the Object.</p>
*/
Name?: string;
/**
* <p>Value of the Object.</p>
*/
Value?: string;
}
/**
* <p>Describes an Amazon S3 location that will receive the results of the restore request.</p>
*/
export interface S3Location {
/**
* <p>The name of the bucket where the restore results will be placed.</p>
*/
BucketName: string | undefined;
/**
* <p>The prefix that is prepended to the restore results for this request.</p>
*/
Prefix: string | undefined;
/**
* <p>Contains the type of server-side encryption used.</p>
*/
Encryption?: Encryption;
/**
* <p>The canned ACL to apply to the restore results.</p>
*/
CannedACL?: ObjectCannedACL | string;
/**
* <p>A list of grants that control access to the staged results.</p>
*/
AccessControlList?: Grant[];
/**
* <p>The tag-set that is applied to the restore results.</p>
*/
Tagging?: Tagging;
/**
* <p>A list of metadata to store with the restore results in S3.</p>
*/
UserMetadata?: MetadataEntry[];
/**
* <p>The class of storage used to store the restore results.</p>
*/
StorageClass?: StorageClass | string;
}
/**
* <p>Describes the location where the restore job's output is stored.</p>
*/
export interface OutputLocation {
/**
* <p>Describes an S3 location that will receive the results of the restore request.</p>
*/
S3?: S3Location;
}
export type ExpressionType = "SQL";
export type CompressionType = "BZIP2" | "GZIP" | "NONE";
export enum FileHeaderInfo {
IGNORE = "IGNORE",
NONE = "NONE",
USE = "USE",
}
/**
* <p>Describes how an uncompressed comma-separated values (CSV)-formatted input object is
* formatted.</p>
*/
export interface CSVInput {
/**
* <p>Describes the first line of input. Valid values are:</p>
* <ul>
* <li>
* <p>
* <code>NONE</code>: First line is not a header.</p>
* </li>
* <li>
* <p>
* <code>IGNORE</code>: First line is a header, but you can't use the header values
* to indicate the column in an expression. You can use column position (such as _1, _2,
* …) to indicate the column (<code>SELECT s._1 FROM OBJECT s</code>).</p>
* </li>
* <li>
* <p>
* <code>Use</code>: First line is a header, and you can use the header value to
* identify a column in an expression (<code>SELECT "name" FROM OBJECT</code>). </p>
* </li>
* </ul>
*/
FileHeaderInfo?: FileHeaderInfo | string;
/**
* <p>A single character used to indicate that a row should be ignored when the character is
* present at the start of that row. You can specify any character to indicate a comment
* line.</p>
*/
Comments?: string;
/**
* <p>A single character used for escaping the quotation mark character inside an already
* escaped value. For example, the value <code>""" a , b """</code> is parsed as <code>" a , b
* "</code>.</p>
*/
QuoteEscapeCharacter?: string;
/**
* <p>A single character used to separate individual records in the input. Instead of the
* default value, you can specify an arbitrary delimiter.</p>
*/
RecordDelimiter?: string;
/**
* <p>A single character used to separate individual fields in a record. You can specify an
* arbitrary delimiter.</p>
*/
FieldDelimiter?: string;
/**
* <p>A single character used for escaping when the field delimiter is part of the value. For
* example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks,
* as follows: <code>" a , b "</code>.</p>
* <p>Type: String</p>
* <p>Default: <code>"</code>
* </p>
* <p>Ancestors: <code>CSV</code>
* </p>
*/
QuoteCharacter?: string;
/**
* <p>Specifies that CSV field values may contain quoted record delimiters and such records
* should be allowed. Default value is FALSE. Setting this value to TRUE may lower
* performance.</p>
*/
AllowQuotedRecordDelimiter?: boolean;
}
export enum JSONType {
DOCUMENT = "DOCUMENT",
LINES = "LINES",
}
/**
* <p>Specifies JSON as object's input serialization format.</p>
*/
export interface JSONInput {
/**
* <p>The type of JSON. Valid values: Document, Lines.</p>
*/
Type?: JSONType | string;
}
/**
* <p>Container for Parquet.</p>
*/
export interface ParquetInput {}
/**
* <p>Describes the serialization format of the object.</p>
*/
export interface InputSerialization {
/**
* <p>Describes the serialization of a CSV-encoded object.</p>
*/
CSV?: CSVInput;
/**
* <p>Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:
* NONE.</p>
*/
CompressionType?: CompressionType | string;
/**
* <p>Specifies JSON as object's input serialization format.</p>
*/
JSON?: JSONInput;
/**
* <p>Specifies Parquet as object's input serialization format.</p>
*/
Parquet?: ParquetInput;
}
export enum QuoteFields {
ALWAYS = "ALWAYS",
ASNEEDED = "ASNEEDED",
}
/**
* <p>Describes how uncompressed comma-separated values (CSV)-formatted results are
* formatted.</p>
*/
export interface CSVOutput {
/**
* <p>Indicates whether to use quotation marks around output fields. </p>
* <ul>
* <li>
* <p>
* <code>ALWAYS</code>: Always use quotation marks for output fields.</p>
* </li>
* <li>
* <p>
* <code>ASNEEDED</code>: Use quotation marks for output fields when needed.</p>
* </li>
* </ul>
*/
QuoteFields?: QuoteFields | string;
/**
* <p>The single character used for escaping the quote character inside an already escaped
* value.</p>
*/
QuoteEscapeCharacter?: string;
/**
* <p>A single character used to separate individual records in the output. Instead of the
* default value, you can specify an arbitrary delimiter.</p>
*/
RecordDelimiter?: string;
/**
* <p>The value used to separate individual fields in a record. You can specify an arbitrary
* delimiter.</p>
*/
FieldDelimiter?: string;
/**
* <p>A single character used for escaping when the field delimiter is part of the value. For
* example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks,
* as follows: <code>" a , b "</code>.</p>
*/
QuoteCharacter?: string;
}
/**
* <p>Specifies JSON as request's output serialization format.</p>
*/
export interface JSONOutput {
/**
* <p>The value used to separate individual records in the output. If no value is specified,
* Amazon S3 uses a newline character ('\n').</p>
*/
RecordDelimiter?: string;
}
/**
* <p>Describes how results of the Select job are serialized.</p>
*/
export interface OutputSerialization {
/**
* <p>Describes the serialization of CSV-encoded Select results.</p>
*/
CSV?: CSVOutput;
/**
* <p>Specifies JSON as request's output serialization format.</p>
*/
JSON?: JSONOutput;
}
/**
* <p>Describes the parameters for Select job types.</p>
*/
export interface SelectParameters {
/**
* <p>Describes the serialization format of the object.</p>
*/
InputSerialization: InputSerialization | undefined;
/**
* <p>The type of the provided expression (for example, SQL).</p>
*/
ExpressionType: ExpressionType | string | undefined;
/**
* <p>The expression that is used to query the object.</p>
*/
Expression: string | undefined;
/**
* <p>Describes how the results of the Select job are serialized.</p>
*/
OutputSerialization: OutputSerialization | undefined;
}
export enum RestoreRequestType {
SELECT = "SELECT",
}
/**
* <p>Container for restore job parameters.</p>
*/
export interface RestoreRequest {
/**
* <p>Lifetime of the active copy in days. Do not use with restores that specify
* <code>OutputLocation</code>.</p>
* <p>The Days element is required for regular restores, and must not be provided for select
* requests.</p>
*/
Days?: number;
/**
* <p>S3 Glacier related parameters pertaining to this job. Do not use with restores that
* specify <code>OutputLocation</code>.</p>
*/
GlacierJobParameters?: GlacierJobParameters;
/**
* <p>Type of restore request.</p>
*/
Type?: RestoreRequestType | string;
/**
* <p>Retrieval tier at which the restore will be processed.</p>
*/
Tier?: Tier | string;
/**
* <p>The optional description for the job.</p>
*/
Description?: string;
/**
* <p>Describes the parameters for Select job types.</p>
*/
SelectParameters?: SelectParameters;
/**
* <p>Describes the location where the restore job's output is stored.</p>
*/
OutputLocation?: OutputLocation;
}
export interface RestoreObjectRequest {
/**
* <p>The bucket name containing the object to restore. </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 action was initiated.</p>
*/
Key: string | undefined;
/**
* <p>VersionId used to reference a specific version of the object.</p>
*/
VersionId?: string;
/**
* <p>Container for restore job parameters.</p>
*/
RestoreRequest?: RestoreRequest;
/**
* <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>Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any
* additional functionality if not using the SDK. When sending this header, there must be a corresponding <code>x-amz-checksum</code> or
* <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. 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>
* <p>If you provide an individual checksum, Amazon S3 ignores any provided
* <code>ChecksumAlgorithm</code> parameter.</p>
*/
ChecksumAlgorithm?: ChecksumAlgorithm | 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></p>
*/
export interface ContinuationEvent {}
/**
* <p>A message that indicates the request is complete and no more messages will be sent. You
* should not assume that the request is complete until the client receives an
* <code>EndEvent</code>.</p>
*/
export interface EndEvent {}
/**
* <p>This data type contains information about progress of an operation.</p>
*/
export interface Progress {
/**
* <p>The current number of object bytes scanned.</p>
*/
BytesScanned?: number;
/**
* <p>The current number of uncompressed object bytes processed.</p>
*/
BytesProcessed?: number;
/**
* <p>The current number of bytes of records payload data returned.</p>
*/
BytesReturned?: number;
}
/**
* <p>This data type contains information about the progress event of an operation.</p>
*/
export interface ProgressEvent {
/**
* <p>The Progress event details.</p>
*/
Details?: Progress;
}
/**
* <p>The container for the records event.</p>
*/
export interface RecordsEvent {
/**
* <p>The byte array of partial, one or more result records.</p>
*/
Payload?: Uint8Array;
}
/**
* <p>Container for the stats details.</p>
*/
export interface Stats {
/**
* <p>The total number of object bytes scanned.</p>
*/
BytesScanned?: number;
/**
* <p>The total number of uncompressed object bytes processed.</p>
*/
BytesProcessed?: number;
/**
* <p>The total number of bytes of records payload data returned.</p>
*/
BytesReturned?: number;
}
/**
* <p>Container for the Stats Event.</p>
*/
export interface StatsEvent {
/**
* <p>The Stats event details.</p>
*/
Details?: Stats;
}
/**
* <p>The container for selecting objects from a content event stream.</p>
*/
export type SelectObjectContentEventStream =
| SelectObjectContentEventStream.ContMember
| SelectObjectContentEventStream.EndMember
| SelectObjectContentEventStream.ProgressMember
| SelectObjectContentEventStream.RecordsMember
| SelectObjectContentEventStream.StatsMember
| SelectObjectContentEventStream.$UnknownMember;
export namespace SelectObjectContentEventStream {
/**
* <p>The Records Event.</p>
*/
export interface RecordsMember {
Records: RecordsEvent;
Stats?: never;
Progress?: never;
Cont?: never;
End?: never;
$unknown?: never;
}
/**
* <p>The Stats Event.</p>
*/
export interface StatsMember {
Records?: never;
Stats: StatsEvent;
Progress?: never;
Cont?: never;
End?: never;
$unknown?: never;
}
/**
* <p>The Progress Event.</p>
*/
export interface ProgressMember {
Records?: never;
Stats?: never;
Progress: ProgressEvent;
Cont?: never;
End?: never;
$unknown?: never;
}
/**
* <p>The Continuation Event.</p>
*/
export interface ContMember {
Records?: never;
Stats?: never;
Progress?: never;
Cont: ContinuationEvent;
End?: never;
$unknown?: never;
}
/**
* <p>The End Event.</p>
*/
export interface EndMember {
Records?: never;
Stats?: never;
Progress?: never;
Cont?: never;
End: EndEvent;
$unknown?: never;
}
export interface $UnknownMember {
Records?: never;
Stats?: never;
Progress?: never;
Cont?: never;
End?: never;
$unknown: [string, any];
}
export interface Visitor<T> {
Records: (value: RecordsEvent) => T;
Stats: (value: StatsEvent) => T;
Progress: (value: ProgressEvent) => T;
Cont: (value: ContinuationEvent) => T;
End: (value: EndEvent) => T;
_: (name: string, value: any) => T;
}
export const visit = <T>(value: SelectObjectContentEventStream, visitor: Visitor<T>): T => {
if (value.Records !== undefined) return visitor.Records(value.Records);
if (value.Stats !== undefined) return visitor.Stats(value.Stats);
if (value.Progress !== undefined) return visitor.Progress(value.Progress);
if (value.Cont !== undefined) return visitor.Cont(value.Cont);
if (value.End !== undefined) return visitor.End(value.End);
return visitor._(value.$unknown[0], value.$unknown[1]);
};
}
export interface SelectObjectContentOutput {
/**
* <p>The array of results.</p>
*/
Payload?: AsyncIterable<SelectObjectContentEventStream>;
}
/**
* <p>Container for specifying if periodic <code>QueryProgress</code> messages should be
* sent.</p>
*/
export interface RequestProgress {
/**
* <p>Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,
* FALSE. Default value: FALSE.</p>
*/
Enabled?: boolean;
}
/**
* <p>Specifies the byte range of the object to get the records from. A record is processed
* when its first byte is contained by the range. This parameter is optional, but when
* specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the
* start and end of the range.</p>
*/
export interface ScanRange {
/**
* <p>Specifies the start of the byte range. This parameter is optional. Valid values:
* non-negative integers. The default value is 0. If only <code>start</code> is supplied, it
* means scan from that point to the end of the file. For example,
* <code><scanrange><start>50</start></scanrange></code> means scan
* from byte 50 until the end of the file.</p>
*/
Start?: number;
/**
* <p>Specifies the end of the byte range. This parameter is optional. Valid values:
* non-negative integers. The default value is one less than the size of the object being
* queried. If only the End parameter is supplied, it is interpreted to mean scan the last N
* bytes of the file. For example,
* <code><scanrange><end>50</end></scanrange></code> means scan the
* last 50 bytes.</p>
*/
End?: number;
}
/**
* <p>Request to filter the contents of an Amazon S3 object based on a simple Structured Query
* Language (SQL) statement. In the request, along with the SQL expression, you must specify a
* data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data
* into records. It returns only records that match the specified SQL expression. You must
* also specify the data serialization format for the response. For more information, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html">S3Select API Documentation</a>.</p>
*/
export interface SelectObjectContentRequest {
/**
* <p>The S3 bucket.</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>The object key.</p>
*/
Key: string | undefined;
/**
* <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;
/**
* <p>The expression that is used to query the object.</p>
*/
Expression: string | undefined;
/**
* <p>The type of the provided expression (for example, SQL).</p>
*/
ExpressionType: ExpressionType | string | undefined;
/**
* <p>Specifies if periodic request progress information should be enabled.</p>
*/
RequestProgress?: RequestProgress;
/**
* <p>Describes the format of the data in the object that is being queried.</p>
*/
InputSerialization: InputSerialization | undefined;
/**
* <p>Describes the format of the data that you want Amazon S3 to return in response.</p>
*/
OutputSerialization: OutputSerialization | undefined;
/**
* <p>Specifies the byte range of the object to get the records from. A record is processed
* when its first byte is contained by the range. This parameter is optional, but when
* specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the
* start and end of the range.</p>
* <p>
* <code>ScanRange</code>may be used in the following ways:</p>
* <ul>
* <li>
* <p>
* <code><scanrange><start>50</start><end>100</end></scanrange></code>
* - process only the records starting between the bytes 50 and 100 (inclusive, counting
* from zero)</p>
* </li>
* <li>
* <p>
* <code><scanrange><start>50</start></scanrange></code> -
* process only the records starting after the byte 50</p>
* </li>
* <li>
* <p>
* <code><scanrange><end>50</end></scanrange></code> -
* process only the records within the last 50 bytes of the file.</p>
* </li>
* </ul>
*/
ScanRange?: ScanRange;
/**
* <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 interface UploadPartOutput {
/**