@aws-sdk/client-glacier 3.379.1 → 3.385.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-types/models/models_0.d.ts +251 -0
- package/package.json +5 -5
|
@@ -11,6 +11,7 @@ import { GlacierServiceException as __BaseException } from "./GlacierServiceExce
|
|
|
11
11
|
*/
|
|
12
12
|
export interface AbortMultipartUploadInput {
|
|
13
13
|
/**
|
|
14
|
+
* @public
|
|
14
15
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
15
16
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
16
17
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -19,10 +20,12 @@ export interface AbortMultipartUploadInput {
|
|
|
19
20
|
*/
|
|
20
21
|
accountId: string | undefined;
|
|
21
22
|
/**
|
|
23
|
+
* @public
|
|
22
24
|
* <p>The name of the vault.</p>
|
|
23
25
|
*/
|
|
24
26
|
vaultName: string | undefined;
|
|
25
27
|
/**
|
|
28
|
+
* @public
|
|
26
29
|
* <p>The upload ID of the multipart upload to delete.</p>
|
|
27
30
|
*/
|
|
28
31
|
uploadId: string | undefined;
|
|
@@ -35,10 +38,12 @@ export declare class InvalidParameterValueException extends __BaseException {
|
|
|
35
38
|
readonly name: "InvalidParameterValueException";
|
|
36
39
|
readonly $fault: "client";
|
|
37
40
|
/**
|
|
41
|
+
* @public
|
|
38
42
|
* <p>Client</p>
|
|
39
43
|
*/
|
|
40
44
|
type?: string;
|
|
41
45
|
/**
|
|
46
|
+
* @public
|
|
42
47
|
* <p>400 Bad Request</p>
|
|
43
48
|
*/
|
|
44
49
|
code?: string;
|
|
@@ -55,10 +60,12 @@ export declare class MissingParameterValueException extends __BaseException {
|
|
|
55
60
|
readonly name: "MissingParameterValueException";
|
|
56
61
|
readonly $fault: "client";
|
|
57
62
|
/**
|
|
63
|
+
* @public
|
|
58
64
|
* <p>Client.</p>
|
|
59
65
|
*/
|
|
60
66
|
type?: string;
|
|
61
67
|
/**
|
|
68
|
+
* @public
|
|
62
69
|
* <p>400 Bad Request</p>
|
|
63
70
|
*/
|
|
64
71
|
code?: string;
|
|
@@ -76,10 +83,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
76
83
|
readonly name: "ResourceNotFoundException";
|
|
77
84
|
readonly $fault: "client";
|
|
78
85
|
/**
|
|
86
|
+
* @public
|
|
79
87
|
* <p>Client</p>
|
|
80
88
|
*/
|
|
81
89
|
type?: string;
|
|
82
90
|
/**
|
|
91
|
+
* @public
|
|
83
92
|
* <p>404 Not Found</p>
|
|
84
93
|
*/
|
|
85
94
|
code?: string;
|
|
@@ -96,10 +105,12 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
96
105
|
readonly name: "ServiceUnavailableException";
|
|
97
106
|
readonly $fault: "server";
|
|
98
107
|
/**
|
|
108
|
+
* @public
|
|
99
109
|
* <p>Server</p>
|
|
100
110
|
*/
|
|
101
111
|
type?: string;
|
|
102
112
|
/**
|
|
113
|
+
* @public
|
|
103
114
|
* <p>500 Internal Server Error</p>
|
|
104
115
|
*/
|
|
105
116
|
code?: string;
|
|
@@ -114,6 +125,7 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
114
125
|
*/
|
|
115
126
|
export interface AbortVaultLockInput {
|
|
116
127
|
/**
|
|
128
|
+
* @public
|
|
117
129
|
* <p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS
|
|
118
130
|
* account ID associated with the credentials used to sign the request. You can either specify
|
|
119
131
|
* an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon
|
|
@@ -122,6 +134,7 @@ export interface AbortVaultLockInput {
|
|
|
122
134
|
*/
|
|
123
135
|
accountId: string | undefined;
|
|
124
136
|
/**
|
|
137
|
+
* @public
|
|
125
138
|
* <p>The name of the vault.</p>
|
|
126
139
|
*/
|
|
127
140
|
vaultName: string | undefined;
|
|
@@ -145,22 +158,27 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
145
158
|
*/
|
|
146
159
|
export interface Grantee {
|
|
147
160
|
/**
|
|
161
|
+
* @public
|
|
148
162
|
* <p>Type of grantee</p>
|
|
149
163
|
*/
|
|
150
164
|
Type: Type | string | undefined;
|
|
151
165
|
/**
|
|
166
|
+
* @public
|
|
152
167
|
* <p>Screen name of the grantee.</p>
|
|
153
168
|
*/
|
|
154
169
|
DisplayName?: string;
|
|
155
170
|
/**
|
|
171
|
+
* @public
|
|
156
172
|
* <p>URI of the grantee group.</p>
|
|
157
173
|
*/
|
|
158
174
|
URI?: string;
|
|
159
175
|
/**
|
|
176
|
+
* @public
|
|
160
177
|
* <p>The canonical user ID of the grantee.</p>
|
|
161
178
|
*/
|
|
162
179
|
ID?: string;
|
|
163
180
|
/**
|
|
181
|
+
* @public
|
|
164
182
|
* <p>Email address of the grantee.</p>
|
|
165
183
|
*/
|
|
166
184
|
EmailAddress?: string;
|
|
@@ -186,10 +204,12 @@ export type Permission = (typeof Permission)[keyof typeof Permission];
|
|
|
186
204
|
*/
|
|
187
205
|
export interface Grant {
|
|
188
206
|
/**
|
|
207
|
+
* @public
|
|
189
208
|
* <p>The grantee.</p>
|
|
190
209
|
*/
|
|
191
210
|
Grantee?: Grantee;
|
|
192
211
|
/**
|
|
212
|
+
* @public
|
|
193
213
|
* <p>Specifies the permission given to the grantee. </p>
|
|
194
214
|
*/
|
|
195
215
|
Permission?: Permission | string;
|
|
@@ -213,6 +233,7 @@ export type ActionCode = (typeof ActionCode)[keyof typeof ActionCode];
|
|
|
213
233
|
*/
|
|
214
234
|
export interface AddTagsToVaultInput {
|
|
215
235
|
/**
|
|
236
|
+
* @public
|
|
216
237
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
217
238
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
218
239
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -221,10 +242,12 @@ export interface AddTagsToVaultInput {
|
|
|
221
242
|
*/
|
|
222
243
|
accountId: string | undefined;
|
|
223
244
|
/**
|
|
245
|
+
* @public
|
|
224
246
|
* <p>The name of the vault.</p>
|
|
225
247
|
*/
|
|
226
248
|
vaultName: string | undefined;
|
|
227
249
|
/**
|
|
250
|
+
* @public
|
|
228
251
|
* <p>The tags to add to the vault. Each tag is composed of a key and a value. The value
|
|
229
252
|
* can be an empty string.</p>
|
|
230
253
|
*/
|
|
@@ -238,10 +261,12 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
238
261
|
readonly name: "LimitExceededException";
|
|
239
262
|
readonly $fault: "client";
|
|
240
263
|
/**
|
|
264
|
+
* @public
|
|
241
265
|
* <p>Client</p>
|
|
242
266
|
*/
|
|
243
267
|
type?: string;
|
|
244
268
|
/**
|
|
269
|
+
* @public
|
|
245
270
|
* <p>400 Bad Request</p>
|
|
246
271
|
*/
|
|
247
272
|
code?: string;
|
|
@@ -259,14 +284,17 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
259
284
|
*/
|
|
260
285
|
export interface ArchiveCreationOutput {
|
|
261
286
|
/**
|
|
287
|
+
* @public
|
|
262
288
|
* <p>The relative URI path of the newly added archive resource.</p>
|
|
263
289
|
*/
|
|
264
290
|
location?: string;
|
|
265
291
|
/**
|
|
292
|
+
* @public
|
|
266
293
|
* <p>The checksum of the archive computed by Amazon S3 Glacier.</p>
|
|
267
294
|
*/
|
|
268
295
|
checksum?: string;
|
|
269
296
|
/**
|
|
297
|
+
* @public
|
|
270
298
|
* <p>The ID of the archive. This value is also included as part of the location.</p>
|
|
271
299
|
*/
|
|
272
300
|
archiveId?: string;
|
|
@@ -297,6 +325,7 @@ export type CannedACL = (typeof CannedACL)[keyof typeof CannedACL];
|
|
|
297
325
|
*/
|
|
298
326
|
export interface CompleteMultipartUploadInput {
|
|
299
327
|
/**
|
|
328
|
+
* @public
|
|
300
329
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
301
330
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
302
331
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -305,19 +334,23 @@ export interface CompleteMultipartUploadInput {
|
|
|
305
334
|
*/
|
|
306
335
|
accountId: string | undefined;
|
|
307
336
|
/**
|
|
337
|
+
* @public
|
|
308
338
|
* <p>The name of the vault.</p>
|
|
309
339
|
*/
|
|
310
340
|
vaultName: string | undefined;
|
|
311
341
|
/**
|
|
342
|
+
* @public
|
|
312
343
|
* <p>The upload ID of the multipart upload.</p>
|
|
313
344
|
*/
|
|
314
345
|
uploadId: string | undefined;
|
|
315
346
|
/**
|
|
347
|
+
* @public
|
|
316
348
|
* <p>The total size, in bytes, of the entire archive. This value should be the sum of all
|
|
317
349
|
* the sizes of the individual parts that you uploaded.</p>
|
|
318
350
|
*/
|
|
319
351
|
archiveSize?: string;
|
|
320
352
|
/**
|
|
353
|
+
* @public
|
|
321
354
|
* <p>The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash
|
|
322
355
|
* of the individual parts. If the value you specify in the request does not match the SHA256
|
|
323
356
|
* tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier),
|
|
@@ -331,6 +364,7 @@ export interface CompleteMultipartUploadInput {
|
|
|
331
364
|
*/
|
|
332
365
|
export interface CompleteVaultLockInput {
|
|
333
366
|
/**
|
|
367
|
+
* @public
|
|
334
368
|
* <p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS
|
|
335
369
|
* account ID associated with the credentials used to sign the request. You can either specify
|
|
336
370
|
* an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon
|
|
@@ -339,10 +373,12 @@ export interface CompleteVaultLockInput {
|
|
|
339
373
|
*/
|
|
340
374
|
accountId: string | undefined;
|
|
341
375
|
/**
|
|
376
|
+
* @public
|
|
342
377
|
* <p>The name of the vault.</p>
|
|
343
378
|
*/
|
|
344
379
|
vaultName: string | undefined;
|
|
345
380
|
/**
|
|
381
|
+
* @public
|
|
346
382
|
* <p>The <code>lockId</code> value is the lock ID obtained from a <a>InitiateVaultLock</a> request.</p>
|
|
347
383
|
*/
|
|
348
384
|
lockId: string | undefined;
|
|
@@ -353,6 +389,7 @@ export interface CompleteVaultLockInput {
|
|
|
353
389
|
*/
|
|
354
390
|
export interface CreateVaultInput {
|
|
355
391
|
/**
|
|
392
|
+
* @public
|
|
356
393
|
* <p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS
|
|
357
394
|
* account ID associated with the credentials used to sign the request. You can either specify
|
|
358
395
|
* an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon S3
|
|
@@ -361,6 +398,7 @@ export interface CreateVaultInput {
|
|
|
361
398
|
*/
|
|
362
399
|
accountId: string | undefined;
|
|
363
400
|
/**
|
|
401
|
+
* @public
|
|
364
402
|
* <p>The name of the vault.</p>
|
|
365
403
|
*/
|
|
366
404
|
vaultName: string | undefined;
|
|
@@ -371,6 +409,7 @@ export interface CreateVaultInput {
|
|
|
371
409
|
*/
|
|
372
410
|
export interface CreateVaultOutput {
|
|
373
411
|
/**
|
|
412
|
+
* @public
|
|
374
413
|
* <p>The URI of the vault that was created.</p>
|
|
375
414
|
*/
|
|
376
415
|
location?: string;
|
|
@@ -394,29 +433,35 @@ export type FileHeaderInfo = (typeof FileHeaderInfo)[keyof typeof FileHeaderInfo
|
|
|
394
433
|
*/
|
|
395
434
|
export interface CSVInput {
|
|
396
435
|
/**
|
|
436
|
+
* @public
|
|
397
437
|
* <p>Describes the first line of input. Valid values are <code>None</code>,
|
|
398
438
|
* <code>Ignore</code>, and <code>Use</code>.</p>
|
|
399
439
|
*/
|
|
400
440
|
FileHeaderInfo?: FileHeaderInfo | string;
|
|
401
441
|
/**
|
|
442
|
+
* @public
|
|
402
443
|
* <p>A single character used to indicate that a row should be ignored when the character is
|
|
403
444
|
* present at the start of that row.</p>
|
|
404
445
|
*/
|
|
405
446
|
Comments?: string;
|
|
406
447
|
/**
|
|
448
|
+
* @public
|
|
407
449
|
* <p>A single character used for escaping the quotation-mark character inside an already
|
|
408
450
|
* escaped value.</p>
|
|
409
451
|
*/
|
|
410
452
|
QuoteEscapeCharacter?: string;
|
|
411
453
|
/**
|
|
454
|
+
* @public
|
|
412
455
|
* <p>A value used to separate individual records from each other.</p>
|
|
413
456
|
*/
|
|
414
457
|
RecordDelimiter?: string;
|
|
415
458
|
/**
|
|
459
|
+
* @public
|
|
416
460
|
* <p>A value used to separate individual fields from each other within a record.</p>
|
|
417
461
|
*/
|
|
418
462
|
FieldDelimiter?: string;
|
|
419
463
|
/**
|
|
464
|
+
* @public
|
|
420
465
|
* <p>A value used as an escape character where the field delimiter is part of the
|
|
421
466
|
* value.</p>
|
|
422
467
|
*/
|
|
@@ -441,24 +486,29 @@ export type QuoteFields = (typeof QuoteFields)[keyof typeof QuoteFields];
|
|
|
441
486
|
*/
|
|
442
487
|
export interface CSVOutput {
|
|
443
488
|
/**
|
|
489
|
+
* @public
|
|
444
490
|
* <p>A value that indicates whether all output fields should be contained within quotation
|
|
445
491
|
* marks.</p>
|
|
446
492
|
*/
|
|
447
493
|
QuoteFields?: QuoteFields | string;
|
|
448
494
|
/**
|
|
495
|
+
* @public
|
|
449
496
|
* <p>A single character used for escaping the quotation-mark character inside an already
|
|
450
497
|
* escaped value.</p>
|
|
451
498
|
*/
|
|
452
499
|
QuoteEscapeCharacter?: string;
|
|
453
500
|
/**
|
|
501
|
+
* @public
|
|
454
502
|
* <p>A value used to separate individual records from each other.</p>
|
|
455
503
|
*/
|
|
456
504
|
RecordDelimiter?: string;
|
|
457
505
|
/**
|
|
506
|
+
* @public
|
|
458
507
|
* <p>A value used to separate individual fields from each other within a record.</p>
|
|
459
508
|
*/
|
|
460
509
|
FieldDelimiter?: string;
|
|
461
510
|
/**
|
|
511
|
+
* @public
|
|
462
512
|
* <p>A value used as an escape character where the field delimiter is part of the
|
|
463
513
|
* value.</p>
|
|
464
514
|
*/
|
|
@@ -470,11 +520,13 @@ export interface CSVOutput {
|
|
|
470
520
|
*/
|
|
471
521
|
export interface DataRetrievalRule {
|
|
472
522
|
/**
|
|
523
|
+
* @public
|
|
473
524
|
* <p>The type of data retrieval policy to set.</p>
|
|
474
525
|
* <p>Valid values: BytesPerHour|FreeTier|None</p>
|
|
475
526
|
*/
|
|
476
527
|
Strategy?: string;
|
|
477
528
|
/**
|
|
529
|
+
* @public
|
|
478
530
|
* <p>The maximum number of bytes that can be retrieved in an hour.</p>
|
|
479
531
|
* <p>This field is required only if the value of the Strategy field is
|
|
480
532
|
* <code>BytesPerHour</code>. Your PUT operation will be rejected if the Strategy field is
|
|
@@ -488,6 +540,7 @@ export interface DataRetrievalRule {
|
|
|
488
540
|
*/
|
|
489
541
|
export interface DataRetrievalPolicy {
|
|
490
542
|
/**
|
|
543
|
+
* @public
|
|
491
544
|
* <p>The policy rule. Although this is a list type, currently there must be only one rule,
|
|
492
545
|
* which contains a Strategy field and optionally a BytesPerHour field.</p>
|
|
493
546
|
*/
|
|
@@ -499,6 +552,7 @@ export interface DataRetrievalPolicy {
|
|
|
499
552
|
*/
|
|
500
553
|
export interface DeleteArchiveInput {
|
|
501
554
|
/**
|
|
555
|
+
* @public
|
|
502
556
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
503
557
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
504
558
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -507,10 +561,12 @@ export interface DeleteArchiveInput {
|
|
|
507
561
|
*/
|
|
508
562
|
accountId: string | undefined;
|
|
509
563
|
/**
|
|
564
|
+
* @public
|
|
510
565
|
* <p>The name of the vault.</p>
|
|
511
566
|
*/
|
|
512
567
|
vaultName: string | undefined;
|
|
513
568
|
/**
|
|
569
|
+
* @public
|
|
514
570
|
* <p>The ID of the archive to delete.</p>
|
|
515
571
|
*/
|
|
516
572
|
archiveId: string | undefined;
|
|
@@ -521,6 +577,7 @@ export interface DeleteArchiveInput {
|
|
|
521
577
|
*/
|
|
522
578
|
export interface DeleteVaultInput {
|
|
523
579
|
/**
|
|
580
|
+
* @public
|
|
524
581
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
525
582
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
526
583
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -529,6 +586,7 @@ export interface DeleteVaultInput {
|
|
|
529
586
|
*/
|
|
530
587
|
accountId: string | undefined;
|
|
531
588
|
/**
|
|
589
|
+
* @public
|
|
532
590
|
* <p>The name of the vault.</p>
|
|
533
591
|
*/
|
|
534
592
|
vaultName: string | undefined;
|
|
@@ -539,6 +597,7 @@ export interface DeleteVaultInput {
|
|
|
539
597
|
*/
|
|
540
598
|
export interface DeleteVaultAccessPolicyInput {
|
|
541
599
|
/**
|
|
600
|
+
* @public
|
|
542
601
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
543
602
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
544
603
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -547,6 +606,7 @@ export interface DeleteVaultAccessPolicyInput {
|
|
|
547
606
|
*/
|
|
548
607
|
accountId: string | undefined;
|
|
549
608
|
/**
|
|
609
|
+
* @public
|
|
550
610
|
* <p>The name of the vault.</p>
|
|
551
611
|
*/
|
|
552
612
|
vaultName: string | undefined;
|
|
@@ -558,6 +618,7 @@ export interface DeleteVaultAccessPolicyInput {
|
|
|
558
618
|
*/
|
|
559
619
|
export interface DeleteVaultNotificationsInput {
|
|
560
620
|
/**
|
|
621
|
+
* @public
|
|
561
622
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
562
623
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
563
624
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -566,6 +627,7 @@ export interface DeleteVaultNotificationsInput {
|
|
|
566
627
|
*/
|
|
567
628
|
accountId: string | undefined;
|
|
568
629
|
/**
|
|
630
|
+
* @public
|
|
569
631
|
* <p>The name of the vault.</p>
|
|
570
632
|
*/
|
|
571
633
|
vaultName: string | undefined;
|
|
@@ -576,6 +638,7 @@ export interface DeleteVaultNotificationsInput {
|
|
|
576
638
|
*/
|
|
577
639
|
export interface DescribeJobInput {
|
|
578
640
|
/**
|
|
641
|
+
* @public
|
|
579
642
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
580
643
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
581
644
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -584,10 +647,12 @@ export interface DescribeJobInput {
|
|
|
584
647
|
*/
|
|
585
648
|
accountId: string | undefined;
|
|
586
649
|
/**
|
|
650
|
+
* @public
|
|
587
651
|
* <p>The name of the vault.</p>
|
|
588
652
|
*/
|
|
589
653
|
vaultName: string | undefined;
|
|
590
654
|
/**
|
|
655
|
+
* @public
|
|
591
656
|
* <p>The ID of the job to describe.</p>
|
|
592
657
|
*/
|
|
593
658
|
jobId: string | undefined;
|
|
@@ -598,11 +663,13 @@ export interface DescribeJobInput {
|
|
|
598
663
|
*/
|
|
599
664
|
export interface InventoryRetrievalJobDescription {
|
|
600
665
|
/**
|
|
666
|
+
* @public
|
|
601
667
|
* <p>The output format for the vault inventory list, which is set by the <b>InitiateJob</b> request when initiating a job to retrieve a vault
|
|
602
668
|
* inventory. Valid values are <code>CSV</code> and <code>JSON</code>.</p>
|
|
603
669
|
*/
|
|
604
670
|
Format?: string;
|
|
605
671
|
/**
|
|
672
|
+
* @public
|
|
606
673
|
* <p>The start of the date range in Universal Coordinated Time (UTC) for vault inventory
|
|
607
674
|
* retrieval that includes archives created on or after this date. This value should be a
|
|
608
675
|
* string in the ISO 8601 date format, for example
|
|
@@ -610,17 +677,20 @@ export interface InventoryRetrievalJobDescription {
|
|
|
610
677
|
*/
|
|
611
678
|
StartDate?: string;
|
|
612
679
|
/**
|
|
680
|
+
* @public
|
|
613
681
|
* <p>The end of the date range in UTC for vault inventory retrieval that includes
|
|
614
682
|
* archives created before this date. This value should be a string in the ISO 8601 date
|
|
615
683
|
* format, for example <code>2013-03-20T17:03:43Z</code>.</p>
|
|
616
684
|
*/
|
|
617
685
|
EndDate?: string;
|
|
618
686
|
/**
|
|
687
|
+
* @public
|
|
619
688
|
* <p>The maximum number of inventory items returned per vault inventory retrieval
|
|
620
689
|
* request. This limit is set when initiating the job with the a <b>InitiateJob</b> request. </p>
|
|
621
690
|
*/
|
|
622
691
|
Limit?: string;
|
|
623
692
|
/**
|
|
693
|
+
* @public
|
|
624
694
|
* <p>An opaque string that represents where to continue pagination of the vault
|
|
625
695
|
* inventory retrieval results. You use the marker in a new <b>InitiateJob</b> request to obtain additional inventory items. If there are
|
|
626
696
|
* no more inventory items, this value is <code>null</code>. For more information, see
|
|
@@ -646,17 +716,20 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
|
|
|
646
716
|
*/
|
|
647
717
|
export interface Encryption {
|
|
648
718
|
/**
|
|
719
|
+
* @public
|
|
649
720
|
* <p>The server-side encryption algorithm used when storing job results in Amazon S3, for
|
|
650
721
|
* example <code>AES256</code> or <code>aws:kms</code>.</p>
|
|
651
722
|
*/
|
|
652
723
|
EncryptionType?: EncryptionType | string;
|
|
653
724
|
/**
|
|
725
|
+
* @public
|
|
654
726
|
* <p>The AWS KMS key ID to use for object encryption. All GET and PUT requests for an
|
|
655
727
|
* object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or
|
|
656
728
|
* Signature Version 4. </p>
|
|
657
729
|
*/
|
|
658
730
|
KMSKeyId?: string;
|
|
659
731
|
/**
|
|
732
|
+
* @public
|
|
660
733
|
* <p>Optional. If the encryption type is <code>aws:kms</code>, you can use this value to
|
|
661
734
|
* specify the encryption context for the job results.</p>
|
|
662
735
|
*/
|
|
@@ -681,34 +754,42 @@ export type StorageClass = (typeof StorageClass)[keyof typeof StorageClass];
|
|
|
681
754
|
*/
|
|
682
755
|
export interface S3Location {
|
|
683
756
|
/**
|
|
757
|
+
* @public
|
|
684
758
|
* <p>The name of the Amazon S3 bucket where the job results are stored.</p>
|
|
685
759
|
*/
|
|
686
760
|
BucketName?: string;
|
|
687
761
|
/**
|
|
762
|
+
* @public
|
|
688
763
|
* <p>The prefix that is prepended to the results for this request.</p>
|
|
689
764
|
*/
|
|
690
765
|
Prefix?: string;
|
|
691
766
|
/**
|
|
767
|
+
* @public
|
|
692
768
|
* <p>Contains information about the encryption used to store the job results in Amazon S3.</p>
|
|
693
769
|
*/
|
|
694
770
|
Encryption?: Encryption;
|
|
695
771
|
/**
|
|
772
|
+
* @public
|
|
696
773
|
* <p>The canned access control list (ACL) to apply to the job results.</p>
|
|
697
774
|
*/
|
|
698
775
|
CannedACL?: CannedACL | string;
|
|
699
776
|
/**
|
|
777
|
+
* @public
|
|
700
778
|
* <p>A list of grants that control access to the staged results.</p>
|
|
701
779
|
*/
|
|
702
780
|
AccessControlList?: Grant[];
|
|
703
781
|
/**
|
|
782
|
+
* @public
|
|
704
783
|
* <p>The tag-set that is applied to the job results.</p>
|
|
705
784
|
*/
|
|
706
785
|
Tagging?: Record<string, string>;
|
|
707
786
|
/**
|
|
787
|
+
* @public
|
|
708
788
|
* <p>A map of metadata to store with the job results in Amazon S3.</p>
|
|
709
789
|
*/
|
|
710
790
|
UserMetadata?: Record<string, string>;
|
|
711
791
|
/**
|
|
792
|
+
* @public
|
|
712
793
|
* <p>The storage class used to store the job results.</p>
|
|
713
794
|
*/
|
|
714
795
|
StorageClass?: StorageClass | string;
|
|
@@ -719,6 +800,7 @@ export interface S3Location {
|
|
|
719
800
|
*/
|
|
720
801
|
export interface OutputLocation {
|
|
721
802
|
/**
|
|
803
|
+
* @public
|
|
722
804
|
* <p>Describes an S3 location that will receive the results of the job request.</p>
|
|
723
805
|
*/
|
|
724
806
|
S3?: S3Location;
|
|
@@ -740,6 +822,7 @@ export type ExpressionType = (typeof ExpressionType)[keyof typeof ExpressionType
|
|
|
740
822
|
*/
|
|
741
823
|
export interface InputSerialization {
|
|
742
824
|
/**
|
|
825
|
+
* @public
|
|
743
826
|
* <p>Describes the serialization of a CSV-encoded object.</p>
|
|
744
827
|
*/
|
|
745
828
|
csv?: CSVInput;
|
|
@@ -750,6 +833,7 @@ export interface InputSerialization {
|
|
|
750
833
|
*/
|
|
751
834
|
export interface OutputSerialization {
|
|
752
835
|
/**
|
|
836
|
+
* @public
|
|
753
837
|
* <p>Describes the serialization of CSV-encoded query results.</p>
|
|
754
838
|
*/
|
|
755
839
|
csv?: CSVOutput;
|
|
@@ -760,18 +844,22 @@ export interface OutputSerialization {
|
|
|
760
844
|
*/
|
|
761
845
|
export interface SelectParameters {
|
|
762
846
|
/**
|
|
847
|
+
* @public
|
|
763
848
|
* <p>Describes the serialization format of the object.</p>
|
|
764
849
|
*/
|
|
765
850
|
InputSerialization?: InputSerialization;
|
|
766
851
|
/**
|
|
852
|
+
* @public
|
|
767
853
|
* <p>The type of the provided expression, for example <code>SQL</code>.</p>
|
|
768
854
|
*/
|
|
769
855
|
ExpressionType?: ExpressionType | string;
|
|
770
856
|
/**
|
|
857
|
+
* @public
|
|
771
858
|
* <p>The expression that is used to select the object.</p>
|
|
772
859
|
*/
|
|
773
860
|
Expression?: string;
|
|
774
861
|
/**
|
|
862
|
+
* @public
|
|
775
863
|
* <p>Describes how the results of the select job are serialized.</p>
|
|
776
864
|
*/
|
|
777
865
|
OutputSerialization?: OutputSerialization;
|
|
@@ -795,70 +883,84 @@ export type StatusCode = (typeof StatusCode)[keyof typeof StatusCode];
|
|
|
795
883
|
*/
|
|
796
884
|
export interface GlacierJobDescription {
|
|
797
885
|
/**
|
|
886
|
+
* @public
|
|
798
887
|
* <p>An opaque string that identifies an Amazon S3 Glacier job.</p>
|
|
799
888
|
*/
|
|
800
889
|
JobId?: string;
|
|
801
890
|
/**
|
|
891
|
+
* @public
|
|
802
892
|
* <p>The job description provided when initiating the job.</p>
|
|
803
893
|
*/
|
|
804
894
|
JobDescription?: string;
|
|
805
895
|
/**
|
|
896
|
+
* @public
|
|
806
897
|
* <p>The job type. This value is either <code>ArchiveRetrieval</code>,
|
|
807
898
|
* <code>InventoryRetrieval</code>, or
|
|
808
899
|
* <code>Select</code>. </p>
|
|
809
900
|
*/
|
|
810
901
|
Action?: ActionCode | string;
|
|
811
902
|
/**
|
|
903
|
+
* @public
|
|
812
904
|
* <p>The archive ID requested for a select job or archive retrieval. Otherwise, this
|
|
813
905
|
* field is null.</p>
|
|
814
906
|
*/
|
|
815
907
|
ArchiveId?: string;
|
|
816
908
|
/**
|
|
909
|
+
* @public
|
|
817
910
|
* <p>The Amazon Resource Name (ARN) of the vault from which an archive retrieval was
|
|
818
911
|
* requested.</p>
|
|
819
912
|
*/
|
|
820
913
|
VaultARN?: string;
|
|
821
914
|
/**
|
|
915
|
+
* @public
|
|
822
916
|
* <p>The UTC date when the job was created. This value is a string representation of ISO
|
|
823
917
|
* 8601 date format, for example <code>"2012-03-20T17:03:43.221Z"</code>.</p>
|
|
824
918
|
*/
|
|
825
919
|
CreationDate?: string;
|
|
826
920
|
/**
|
|
921
|
+
* @public
|
|
827
922
|
* <p>The job status. When a job is completed, you get the job's output using Get Job
|
|
828
923
|
* Output (GET output).</p>
|
|
829
924
|
*/
|
|
830
925
|
Completed?: boolean;
|
|
831
926
|
/**
|
|
927
|
+
* @public
|
|
832
928
|
* <p>The status code can be <code>InProgress</code>, <code>Succeeded</code>, or
|
|
833
929
|
* <code>Failed</code>, and indicates the status of the job.</p>
|
|
834
930
|
*/
|
|
835
931
|
StatusCode?: StatusCode | string;
|
|
836
932
|
/**
|
|
933
|
+
* @public
|
|
837
934
|
* <p>A friendly message that describes the job status.</p>
|
|
838
935
|
*/
|
|
839
936
|
StatusMessage?: string;
|
|
840
937
|
/**
|
|
938
|
+
* @public
|
|
841
939
|
* <p>For an archive retrieval job, this value is the size in bytes of the archive being
|
|
842
940
|
* requested for download. For an inventory retrieval or select job, this value is
|
|
843
941
|
* null.</p>
|
|
844
942
|
*/
|
|
845
943
|
ArchiveSizeInBytes?: number;
|
|
846
944
|
/**
|
|
945
|
+
* @public
|
|
847
946
|
* <p>For an inventory retrieval job, this value is the size in bytes of the inventory
|
|
848
947
|
* requested for download. For an archive retrieval or select job, this value is
|
|
849
948
|
* null.</p>
|
|
850
949
|
*/
|
|
851
950
|
InventorySizeInBytes?: number;
|
|
852
951
|
/**
|
|
952
|
+
* @public
|
|
853
953
|
* <p>An Amazon SNS topic that receives notification.</p>
|
|
854
954
|
*/
|
|
855
955
|
SNSTopic?: string;
|
|
856
956
|
/**
|
|
957
|
+
* @public
|
|
857
958
|
* <p>The UTC time that the job request completed. While the job is in progress, the
|
|
858
959
|
* value is null.</p>
|
|
859
960
|
*/
|
|
860
961
|
CompletionDate?: string;
|
|
861
962
|
/**
|
|
963
|
+
* @public
|
|
862
964
|
* <p>For an archive retrieval job, this value is the checksum of the archive. Otherwise,
|
|
863
965
|
* this value is null.</p>
|
|
864
966
|
* <p>The SHA256 tree hash value for the requested range of an archive. If the <b>InitiateJob</b> request for an archive specified a tree-hash
|
|
@@ -890,11 +992,13 @@ export interface GlacierJobDescription {
|
|
|
890
992
|
*/
|
|
891
993
|
SHA256TreeHash?: string;
|
|
892
994
|
/**
|
|
995
|
+
* @public
|
|
893
996
|
* <p>The SHA256 tree hash of the entire archive for an archive retrieval. For inventory
|
|
894
997
|
* retrieval or select jobs, this field is null.</p>
|
|
895
998
|
*/
|
|
896
999
|
ArchiveSHA256TreeHash?: string;
|
|
897
1000
|
/**
|
|
1001
|
+
* @public
|
|
898
1002
|
* <p>The retrieved byte range for archive retrieval jobs in the form
|
|
899
1003
|
* <i>StartByteValue</i>-<i>EndByteValue</i>. If no range
|
|
900
1004
|
* was specified in the archive retrieval, then the whole archive is retrieved. In this
|
|
@@ -904,24 +1008,29 @@ export interface GlacierJobDescription {
|
|
|
904
1008
|
*/
|
|
905
1009
|
RetrievalByteRange?: string;
|
|
906
1010
|
/**
|
|
1011
|
+
* @public
|
|
907
1012
|
* <p>The tier to use for a select or an archive retrieval. Valid values are
|
|
908
1013
|
* <code>Expedited</code>, <code>Standard</code>, or <code>Bulk</code>.
|
|
909
1014
|
* <code>Standard</code> is the default.</p>
|
|
910
1015
|
*/
|
|
911
1016
|
Tier?: string;
|
|
912
1017
|
/**
|
|
1018
|
+
* @public
|
|
913
1019
|
* <p>Parameters used for range inventory retrieval.</p>
|
|
914
1020
|
*/
|
|
915
1021
|
InventoryRetrievalParameters?: InventoryRetrievalJobDescription;
|
|
916
1022
|
/**
|
|
1023
|
+
* @public
|
|
917
1024
|
* <p>Contains the job output location.</p>
|
|
918
1025
|
*/
|
|
919
1026
|
JobOutputPath?: string;
|
|
920
1027
|
/**
|
|
1028
|
+
* @public
|
|
921
1029
|
* <p>Contains the parameters used for a select.</p>
|
|
922
1030
|
*/
|
|
923
1031
|
SelectParameters?: SelectParameters;
|
|
924
1032
|
/**
|
|
1033
|
+
* @public
|
|
925
1034
|
* <p>Contains the location where the data from the select job is stored.</p>
|
|
926
1035
|
*/
|
|
927
1036
|
OutputLocation?: OutputLocation;
|
|
@@ -933,6 +1042,7 @@ export interface GlacierJobDescription {
|
|
|
933
1042
|
*/
|
|
934
1043
|
export interface DescribeVaultInput {
|
|
935
1044
|
/**
|
|
1045
|
+
* @public
|
|
936
1046
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
937
1047
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
938
1048
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -941,6 +1051,7 @@ export interface DescribeVaultInput {
|
|
|
941
1051
|
*/
|
|
942
1052
|
accountId: string | undefined;
|
|
943
1053
|
/**
|
|
1054
|
+
* @public
|
|
944
1055
|
* <p>The name of the vault.</p>
|
|
945
1056
|
*/
|
|
946
1057
|
vaultName: string | undefined;
|
|
@@ -951,32 +1062,38 @@ export interface DescribeVaultInput {
|
|
|
951
1062
|
*/
|
|
952
1063
|
export interface DescribeVaultOutput {
|
|
953
1064
|
/**
|
|
1065
|
+
* @public
|
|
954
1066
|
* <p>The Amazon Resource Name (ARN) of the vault.</p>
|
|
955
1067
|
*/
|
|
956
1068
|
VaultARN?: string;
|
|
957
1069
|
/**
|
|
1070
|
+
* @public
|
|
958
1071
|
* <p>The name of the vault.</p>
|
|
959
1072
|
*/
|
|
960
1073
|
VaultName?: string;
|
|
961
1074
|
/**
|
|
1075
|
+
* @public
|
|
962
1076
|
* <p>The Universal Coordinated Time (UTC) date when the vault was created. This value
|
|
963
1077
|
* should be a string in the ISO 8601 date format, for example
|
|
964
1078
|
* <code>2012-03-20T17:03:43.221Z</code>.</p>
|
|
965
1079
|
*/
|
|
966
1080
|
CreationDate?: string;
|
|
967
1081
|
/**
|
|
1082
|
+
* @public
|
|
968
1083
|
* <p>The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last
|
|
969
1084
|
* vault inventory. This value should be a string in the ISO 8601 date format, for example
|
|
970
1085
|
* <code>2012-03-20T17:03:43.221Z</code>.</p>
|
|
971
1086
|
*/
|
|
972
1087
|
LastInventoryDate?: string;
|
|
973
1088
|
/**
|
|
1089
|
+
* @public
|
|
974
1090
|
* <p>The number of archives in the vault as of the last inventory date. This field will
|
|
975
1091
|
* return <code>null</code> if an inventory has not yet run on the vault, for example if you
|
|
976
1092
|
* just created the vault.</p>
|
|
977
1093
|
*/
|
|
978
1094
|
NumberOfArchives?: number;
|
|
979
1095
|
/**
|
|
1096
|
+
* @public
|
|
980
1097
|
* <p>Total size, in bytes, of the archives in the vault as of the last inventory date.
|
|
981
1098
|
* This field will return null if an inventory has not yet run on the vault, for example if
|
|
982
1099
|
* you just created the vault.</p>
|
|
@@ -989,6 +1106,7 @@ export interface DescribeVaultOutput {
|
|
|
989
1106
|
*/
|
|
990
1107
|
export interface GetDataRetrievalPolicyInput {
|
|
991
1108
|
/**
|
|
1109
|
+
* @public
|
|
992
1110
|
* <p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS
|
|
993
1111
|
* account ID associated with the credentials used to sign the request. You can either specify
|
|
994
1112
|
* an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon
|
|
@@ -1004,6 +1122,7 @@ export interface GetDataRetrievalPolicyInput {
|
|
|
1004
1122
|
*/
|
|
1005
1123
|
export interface GetDataRetrievalPolicyOutput {
|
|
1006
1124
|
/**
|
|
1125
|
+
* @public
|
|
1007
1126
|
* <p>Contains the returned data retrieval policy in JSON format.</p>
|
|
1008
1127
|
*/
|
|
1009
1128
|
Policy?: DataRetrievalPolicy;
|
|
@@ -1014,6 +1133,7 @@ export interface GetDataRetrievalPolicyOutput {
|
|
|
1014
1133
|
*/
|
|
1015
1134
|
export interface GetJobOutputInput {
|
|
1016
1135
|
/**
|
|
1136
|
+
* @public
|
|
1017
1137
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1018
1138
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1019
1139
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1022,14 +1142,17 @@ export interface GetJobOutputInput {
|
|
|
1022
1142
|
*/
|
|
1023
1143
|
accountId: string | undefined;
|
|
1024
1144
|
/**
|
|
1145
|
+
* @public
|
|
1025
1146
|
* <p>The name of the vault.</p>
|
|
1026
1147
|
*/
|
|
1027
1148
|
vaultName: string | undefined;
|
|
1028
1149
|
/**
|
|
1150
|
+
* @public
|
|
1029
1151
|
* <p>The job ID whose data is downloaded.</p>
|
|
1030
1152
|
*/
|
|
1031
1153
|
jobId: string | undefined;
|
|
1032
1154
|
/**
|
|
1155
|
+
* @public
|
|
1033
1156
|
* <p>The range of bytes to retrieve from the output. For example, if you want to download
|
|
1034
1157
|
* the first 1,048,576 bytes, specify the range as <code>bytes=0-1048575</code>. By default, this operation
|
|
1035
1158
|
* downloads the entire output.</p>
|
|
@@ -1075,10 +1198,12 @@ export interface GetJobOutputInput {
|
|
|
1075
1198
|
*/
|
|
1076
1199
|
export interface GetJobOutputOutput {
|
|
1077
1200
|
/**
|
|
1201
|
+
* @public
|
|
1078
1202
|
* <p>The job data, either archive data or inventory data.</p>
|
|
1079
1203
|
*/
|
|
1080
1204
|
body?: StreamingBlobTypes;
|
|
1081
1205
|
/**
|
|
1206
|
+
* @public
|
|
1082
1207
|
* <p>The checksum of the data in the response. This header is returned only when
|
|
1083
1208
|
* retrieving the output for an archive retrieval job. Furthermore, this header appears only
|
|
1084
1209
|
* under the following conditions:</p>
|
|
@@ -1102,21 +1227,25 @@ export interface GetJobOutputOutput {
|
|
|
1102
1227
|
*/
|
|
1103
1228
|
checksum?: string;
|
|
1104
1229
|
/**
|
|
1230
|
+
* @public
|
|
1105
1231
|
* <p>The HTTP response code for a job output request. The value depends on whether a range
|
|
1106
1232
|
* was specified in the request.</p>
|
|
1107
1233
|
*/
|
|
1108
1234
|
status?: number;
|
|
1109
1235
|
/**
|
|
1236
|
+
* @public
|
|
1110
1237
|
* <p>The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded,
|
|
1111
1238
|
* the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes
|
|
1112
1239
|
* 0-1048575/8388608 returns the first 1 MB from 8 MB.</p>
|
|
1113
1240
|
*/
|
|
1114
1241
|
contentRange?: string;
|
|
1115
1242
|
/**
|
|
1243
|
+
* @public
|
|
1116
1244
|
* <p>Indicates the range units accepted. For more information, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">RFC2616</a>. </p>
|
|
1117
1245
|
*/
|
|
1118
1246
|
acceptRanges?: string;
|
|
1119
1247
|
/**
|
|
1248
|
+
* @public
|
|
1120
1249
|
* <p>The Content-Type depends on whether the job output is an archive or a vault
|
|
1121
1250
|
* inventory. For archive data, the Content-Type is application/octet-stream. For vault
|
|
1122
1251
|
* inventory, if you requested CSV format when you initiated the job, the Content-Type is
|
|
@@ -1125,6 +1254,7 @@ export interface GetJobOutputOutput {
|
|
|
1125
1254
|
*/
|
|
1126
1255
|
contentType?: string;
|
|
1127
1256
|
/**
|
|
1257
|
+
* @public
|
|
1128
1258
|
* <p>The description of an archive.</p>
|
|
1129
1259
|
*/
|
|
1130
1260
|
archiveDescription?: string;
|
|
@@ -1135,6 +1265,7 @@ export interface GetJobOutputOutput {
|
|
|
1135
1265
|
*/
|
|
1136
1266
|
export interface GetVaultAccessPolicyInput {
|
|
1137
1267
|
/**
|
|
1268
|
+
* @public
|
|
1138
1269
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1139
1270
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1140
1271
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1143,6 +1274,7 @@ export interface GetVaultAccessPolicyInput {
|
|
|
1143
1274
|
*/
|
|
1144
1275
|
accountId: string | undefined;
|
|
1145
1276
|
/**
|
|
1277
|
+
* @public
|
|
1146
1278
|
* <p>The name of the vault.</p>
|
|
1147
1279
|
*/
|
|
1148
1280
|
vaultName: string | undefined;
|
|
@@ -1153,6 +1285,7 @@ export interface GetVaultAccessPolicyInput {
|
|
|
1153
1285
|
*/
|
|
1154
1286
|
export interface VaultAccessPolicy {
|
|
1155
1287
|
/**
|
|
1288
|
+
* @public
|
|
1156
1289
|
* <p>The vault access policy.</p>
|
|
1157
1290
|
*/
|
|
1158
1291
|
Policy?: string;
|
|
@@ -1163,6 +1296,7 @@ export interface VaultAccessPolicy {
|
|
|
1163
1296
|
*/
|
|
1164
1297
|
export interface GetVaultAccessPolicyOutput {
|
|
1165
1298
|
/**
|
|
1299
|
+
* @public
|
|
1166
1300
|
* <p>Contains the returned vault access policy as a JSON string.</p>
|
|
1167
1301
|
*/
|
|
1168
1302
|
policy?: VaultAccessPolicy;
|
|
@@ -1173,6 +1307,7 @@ export interface GetVaultAccessPolicyOutput {
|
|
|
1173
1307
|
*/
|
|
1174
1308
|
export interface GetVaultLockInput {
|
|
1175
1309
|
/**
|
|
1310
|
+
* @public
|
|
1176
1311
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1177
1312
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1178
1313
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1181,6 +1316,7 @@ export interface GetVaultLockInput {
|
|
|
1181
1316
|
*/
|
|
1182
1317
|
accountId: string | undefined;
|
|
1183
1318
|
/**
|
|
1319
|
+
* @public
|
|
1184
1320
|
* <p>The name of the vault.</p>
|
|
1185
1321
|
*/
|
|
1186
1322
|
vaultName: string | undefined;
|
|
@@ -1191,21 +1327,25 @@ export interface GetVaultLockInput {
|
|
|
1191
1327
|
*/
|
|
1192
1328
|
export interface GetVaultLockOutput {
|
|
1193
1329
|
/**
|
|
1330
|
+
* @public
|
|
1194
1331
|
* <p>The vault lock policy as a JSON string, which uses "\" as an escape
|
|
1195
1332
|
* character.</p>
|
|
1196
1333
|
*/
|
|
1197
1334
|
Policy?: string;
|
|
1198
1335
|
/**
|
|
1336
|
+
* @public
|
|
1199
1337
|
* <p>The state of the vault lock. <code>InProgress</code> or
|
|
1200
1338
|
* <code>Locked</code>.</p>
|
|
1201
1339
|
*/
|
|
1202
1340
|
State?: string;
|
|
1203
1341
|
/**
|
|
1342
|
+
* @public
|
|
1204
1343
|
* <p>The UTC date and time at which the lock ID expires. This value can be
|
|
1205
1344
|
* <code>null</code> if the vault lock is in a <code>Locked</code> state.</p>
|
|
1206
1345
|
*/
|
|
1207
1346
|
ExpirationDate?: string;
|
|
1208
1347
|
/**
|
|
1348
|
+
* @public
|
|
1209
1349
|
* <p>The UTC date and time at which the vault lock was put into the
|
|
1210
1350
|
* <code>InProgress</code> state.</p>
|
|
1211
1351
|
*/
|
|
@@ -1218,6 +1358,7 @@ export interface GetVaultLockOutput {
|
|
|
1218
1358
|
*/
|
|
1219
1359
|
export interface GetVaultNotificationsInput {
|
|
1220
1360
|
/**
|
|
1361
|
+
* @public
|
|
1221
1362
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1222
1363
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1223
1364
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1226,6 +1367,7 @@ export interface GetVaultNotificationsInput {
|
|
|
1226
1367
|
*/
|
|
1227
1368
|
accountId: string | undefined;
|
|
1228
1369
|
/**
|
|
1370
|
+
* @public
|
|
1229
1371
|
* <p>The name of the vault.</p>
|
|
1230
1372
|
*/
|
|
1231
1373
|
vaultName: string | undefined;
|
|
@@ -1236,11 +1378,13 @@ export interface GetVaultNotificationsInput {
|
|
|
1236
1378
|
*/
|
|
1237
1379
|
export interface VaultNotificationConfig {
|
|
1238
1380
|
/**
|
|
1381
|
+
* @public
|
|
1239
1382
|
* <p>The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name
|
|
1240
1383
|
* (ARN).</p>
|
|
1241
1384
|
*/
|
|
1242
1385
|
SNSTopic?: string;
|
|
1243
1386
|
/**
|
|
1387
|
+
* @public
|
|
1244
1388
|
* <p>A list of one or more events for which Amazon S3 Glacier will send a notification to the
|
|
1245
1389
|
* specified Amazon SNS topic.</p>
|
|
1246
1390
|
*/
|
|
@@ -1252,6 +1396,7 @@ export interface VaultNotificationConfig {
|
|
|
1252
1396
|
*/
|
|
1253
1397
|
export interface GetVaultNotificationsOutput {
|
|
1254
1398
|
/**
|
|
1399
|
+
* @public
|
|
1255
1400
|
* <p>Returns the notification configuration set on the vault.</p>
|
|
1256
1401
|
*/
|
|
1257
1402
|
vaultNotificationConfig?: VaultNotificationConfig;
|
|
@@ -1262,23 +1407,27 @@ export interface GetVaultNotificationsOutput {
|
|
|
1262
1407
|
*/
|
|
1263
1408
|
export interface InventoryRetrievalJobInput {
|
|
1264
1409
|
/**
|
|
1410
|
+
* @public
|
|
1265
1411
|
* <p>The start of the date range in UTC for vault inventory retrieval that includes
|
|
1266
1412
|
* archives created on or after this date. This value should be a string in the ISO 8601 date
|
|
1267
1413
|
* format, for example <code>2013-03-20T17:03:43Z</code>.</p>
|
|
1268
1414
|
*/
|
|
1269
1415
|
StartDate?: string;
|
|
1270
1416
|
/**
|
|
1417
|
+
* @public
|
|
1271
1418
|
* <p>The end of the date range in UTC for vault inventory retrieval that includes archives
|
|
1272
1419
|
* created before this date. This value should be a string in the ISO 8601 date format, for
|
|
1273
1420
|
* example <code>2013-03-20T17:03:43Z</code>.</p>
|
|
1274
1421
|
*/
|
|
1275
1422
|
EndDate?: string;
|
|
1276
1423
|
/**
|
|
1424
|
+
* @public
|
|
1277
1425
|
* <p>Specifies the maximum number of inventory items returned per vault inventory
|
|
1278
1426
|
* retrieval request. Valid values are greater than or equal to 1.</p>
|
|
1279
1427
|
*/
|
|
1280
1428
|
Limit?: string;
|
|
1281
1429
|
/**
|
|
1430
|
+
* @public
|
|
1282
1431
|
* <p>An opaque string that represents where to continue pagination of the vault inventory
|
|
1283
1432
|
* retrieval results. You use the marker in a new <b>InitiateJob</b>
|
|
1284
1433
|
* request to obtain additional inventory items. If there are no more inventory items, this
|
|
@@ -1292,6 +1441,7 @@ export interface InventoryRetrievalJobInput {
|
|
|
1292
1441
|
*/
|
|
1293
1442
|
export interface JobParameters {
|
|
1294
1443
|
/**
|
|
1444
|
+
* @public
|
|
1295
1445
|
* <p>When initiating a job to retrieve a vault inventory, you can optionally add this
|
|
1296
1446
|
* parameter to your request to specify the output format. If you are initiating an inventory
|
|
1297
1447
|
* job and do not specify a Format field, JSON is the default format. Valid values are "CSV"
|
|
@@ -1299,12 +1449,14 @@ export interface JobParameters {
|
|
|
1299
1449
|
*/
|
|
1300
1450
|
Format?: string;
|
|
1301
1451
|
/**
|
|
1452
|
+
* @public
|
|
1302
1453
|
* <p>The job type. You can initiate a job to perform a select query on an archive,
|
|
1303
1454
|
* retrieve an archive, or get an inventory of a vault.
|
|
1304
1455
|
* Valid values are "select", "archive-retrieval" and "inventory-retrieval".</p>
|
|
1305
1456
|
*/
|
|
1306
1457
|
Type?: string;
|
|
1307
1458
|
/**
|
|
1459
|
+
* @public
|
|
1308
1460
|
* <p>The ID of the archive that you want to retrieve. This field is required only if
|
|
1309
1461
|
* <code>Type</code> is set to <code>select</code> or <code>archive-retrieval</code>code>.
|
|
1310
1462
|
* An error occurs if you specify this
|
|
@@ -1312,18 +1464,21 @@ export interface JobParameters {
|
|
|
1312
1464
|
*/
|
|
1313
1465
|
ArchiveId?: string;
|
|
1314
1466
|
/**
|
|
1467
|
+
* @public
|
|
1315
1468
|
* <p>The optional description for the job. The description must be less than or equal to
|
|
1316
1469
|
* 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically,
|
|
1317
1470
|
* ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.</p>
|
|
1318
1471
|
*/
|
|
1319
1472
|
Description?: string;
|
|
1320
1473
|
/**
|
|
1474
|
+
* @public
|
|
1321
1475
|
* <p>The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is
|
|
1322
1476
|
* completed and the output is ready for you to download. The specified topic publishes the
|
|
1323
1477
|
* notification to its subscribers. The SNS topic must exist.</p>
|
|
1324
1478
|
*/
|
|
1325
1479
|
SNSTopic?: string;
|
|
1326
1480
|
/**
|
|
1481
|
+
* @public
|
|
1327
1482
|
* <p>The byte range to retrieve for an archive retrieval. in the form
|
|
1328
1483
|
* "<i>StartByteValue</i>-<i>EndByteValue</i>" If not
|
|
1329
1484
|
* specified, the whole archive is retrieved. If specified, the byte range must be megabyte
|
|
@@ -1336,20 +1491,24 @@ export interface JobParameters {
|
|
|
1336
1491
|
*/
|
|
1337
1492
|
RetrievalByteRange?: string;
|
|
1338
1493
|
/**
|
|
1494
|
+
* @public
|
|
1339
1495
|
* <p>The tier to use for a select or an archive retrieval job. Valid values are
|
|
1340
1496
|
* <code>Expedited</code>, <code>Standard</code>, or <code>Bulk</code>.
|
|
1341
1497
|
* <code>Standard</code> is the default.</p>
|
|
1342
1498
|
*/
|
|
1343
1499
|
Tier?: string;
|
|
1344
1500
|
/**
|
|
1501
|
+
* @public
|
|
1345
1502
|
* <p>Input parameters used for range inventory retrieval.</p>
|
|
1346
1503
|
*/
|
|
1347
1504
|
InventoryRetrievalParameters?: InventoryRetrievalJobInput;
|
|
1348
1505
|
/**
|
|
1506
|
+
* @public
|
|
1349
1507
|
* <p>Contains the parameters that define a job.</p>
|
|
1350
1508
|
*/
|
|
1351
1509
|
SelectParameters?: SelectParameters;
|
|
1352
1510
|
/**
|
|
1511
|
+
* @public
|
|
1353
1512
|
* <p>Contains information about the location where the select job results are stored.</p>
|
|
1354
1513
|
*/
|
|
1355
1514
|
OutputLocation?: OutputLocation;
|
|
@@ -1360,6 +1519,7 @@ export interface JobParameters {
|
|
|
1360
1519
|
*/
|
|
1361
1520
|
export interface InitiateJobInput {
|
|
1362
1521
|
/**
|
|
1522
|
+
* @public
|
|
1363
1523
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1364
1524
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1365
1525
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1368,10 +1528,12 @@ export interface InitiateJobInput {
|
|
|
1368
1528
|
*/
|
|
1369
1529
|
accountId: string | undefined;
|
|
1370
1530
|
/**
|
|
1531
|
+
* @public
|
|
1371
1532
|
* <p>The name of the vault.</p>
|
|
1372
1533
|
*/
|
|
1373
1534
|
vaultName: string | undefined;
|
|
1374
1535
|
/**
|
|
1536
|
+
* @public
|
|
1375
1537
|
* <p>Provides options for specifying job information.</p>
|
|
1376
1538
|
*/
|
|
1377
1539
|
jobParameters?: JobParameters;
|
|
@@ -1382,14 +1544,17 @@ export interface InitiateJobInput {
|
|
|
1382
1544
|
*/
|
|
1383
1545
|
export interface InitiateJobOutput {
|
|
1384
1546
|
/**
|
|
1547
|
+
* @public
|
|
1385
1548
|
* <p>The relative URI path of the job.</p>
|
|
1386
1549
|
*/
|
|
1387
1550
|
location?: string;
|
|
1388
1551
|
/**
|
|
1552
|
+
* @public
|
|
1389
1553
|
* <p>The ID of the job.</p>
|
|
1390
1554
|
*/
|
|
1391
1555
|
jobId?: string;
|
|
1392
1556
|
/**
|
|
1557
|
+
* @public
|
|
1393
1558
|
* <p>The path to the location of where the select results are stored.</p>
|
|
1394
1559
|
*/
|
|
1395
1560
|
jobOutputPath?: string;
|
|
@@ -1419,10 +1584,12 @@ export declare class PolicyEnforcedException extends __BaseException {
|
|
|
1419
1584
|
readonly name: "PolicyEnforcedException";
|
|
1420
1585
|
readonly $fault: "client";
|
|
1421
1586
|
/**
|
|
1587
|
+
* @public
|
|
1422
1588
|
* <p>Client</p>
|
|
1423
1589
|
*/
|
|
1424
1590
|
type?: string;
|
|
1425
1591
|
/**
|
|
1592
|
+
* @public
|
|
1426
1593
|
* <p>PolicyEnforcedException</p>
|
|
1427
1594
|
*/
|
|
1428
1595
|
code?: string;
|
|
@@ -1438,6 +1605,7 @@ export declare class PolicyEnforcedException extends __BaseException {
|
|
|
1438
1605
|
*/
|
|
1439
1606
|
export interface InitiateMultipartUploadInput {
|
|
1440
1607
|
/**
|
|
1608
|
+
* @public
|
|
1441
1609
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1442
1610
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1443
1611
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1446,10 +1614,12 @@ export interface InitiateMultipartUploadInput {
|
|
|
1446
1614
|
*/
|
|
1447
1615
|
accountId: string | undefined;
|
|
1448
1616
|
/**
|
|
1617
|
+
* @public
|
|
1449
1618
|
* <p>The name of the vault.</p>
|
|
1450
1619
|
*/
|
|
1451
1620
|
vaultName: string | undefined;
|
|
1452
1621
|
/**
|
|
1622
|
+
* @public
|
|
1453
1623
|
* <p>The archive description that you are uploading in parts.</p>
|
|
1454
1624
|
* <p>The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example
|
|
1455
1625
|
* 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum
|
|
@@ -1457,6 +1627,7 @@ export interface InitiateMultipartUploadInput {
|
|
|
1457
1627
|
*/
|
|
1458
1628
|
archiveDescription?: string;
|
|
1459
1629
|
/**
|
|
1630
|
+
* @public
|
|
1460
1631
|
* <p>The size of each part except the last, in bytes. The last part can be smaller than
|
|
1461
1632
|
* this part size.</p>
|
|
1462
1633
|
*/
|
|
@@ -1468,10 +1639,12 @@ export interface InitiateMultipartUploadInput {
|
|
|
1468
1639
|
*/
|
|
1469
1640
|
export interface InitiateMultipartUploadOutput {
|
|
1470
1641
|
/**
|
|
1642
|
+
* @public
|
|
1471
1643
|
* <p>The relative URI path of the multipart upload ID Amazon S3 Glacier created.</p>
|
|
1472
1644
|
*/
|
|
1473
1645
|
location?: string;
|
|
1474
1646
|
/**
|
|
1647
|
+
* @public
|
|
1475
1648
|
* <p>The ID of the multipart upload. This value is also included as part of the
|
|
1476
1649
|
* location.</p>
|
|
1477
1650
|
*/
|
|
@@ -1483,6 +1656,7 @@ export interface InitiateMultipartUploadOutput {
|
|
|
1483
1656
|
*/
|
|
1484
1657
|
export interface VaultLockPolicy {
|
|
1485
1658
|
/**
|
|
1659
|
+
* @public
|
|
1486
1660
|
* <p>The vault lock policy.</p>
|
|
1487
1661
|
*/
|
|
1488
1662
|
Policy?: string;
|
|
@@ -1493,6 +1667,7 @@ export interface VaultLockPolicy {
|
|
|
1493
1667
|
*/
|
|
1494
1668
|
export interface InitiateVaultLockInput {
|
|
1495
1669
|
/**
|
|
1670
|
+
* @public
|
|
1496
1671
|
* <p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS
|
|
1497
1672
|
* account ID associated with the credentials used to sign the request. You can either specify
|
|
1498
1673
|
* an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon
|
|
@@ -1501,10 +1676,12 @@ export interface InitiateVaultLockInput {
|
|
|
1501
1676
|
*/
|
|
1502
1677
|
accountId: string | undefined;
|
|
1503
1678
|
/**
|
|
1679
|
+
* @public
|
|
1504
1680
|
* <p>The name of the vault.</p>
|
|
1505
1681
|
*/
|
|
1506
1682
|
vaultName: string | undefined;
|
|
1507
1683
|
/**
|
|
1684
|
+
* @public
|
|
1508
1685
|
* <p>The vault lock policy as a JSON string, which uses "\" as an escape
|
|
1509
1686
|
* character.</p>
|
|
1510
1687
|
*/
|
|
@@ -1516,6 +1693,7 @@ export interface InitiateVaultLockInput {
|
|
|
1516
1693
|
*/
|
|
1517
1694
|
export interface InitiateVaultLockOutput {
|
|
1518
1695
|
/**
|
|
1696
|
+
* @public
|
|
1519
1697
|
* <p>The lock ID, which is used to complete the vault locking process.</p>
|
|
1520
1698
|
*/
|
|
1521
1699
|
lockId?: string;
|
|
@@ -1526,6 +1704,7 @@ export interface InitiateVaultLockOutput {
|
|
|
1526
1704
|
*/
|
|
1527
1705
|
export interface ListJobsInput {
|
|
1528
1706
|
/**
|
|
1707
|
+
* @public
|
|
1529
1708
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1530
1709
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1531
1710
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1534,16 +1713,19 @@ export interface ListJobsInput {
|
|
|
1534
1713
|
*/
|
|
1535
1714
|
accountId: string | undefined;
|
|
1536
1715
|
/**
|
|
1716
|
+
* @public
|
|
1537
1717
|
* <p>The name of the vault.</p>
|
|
1538
1718
|
*/
|
|
1539
1719
|
vaultName: string | undefined;
|
|
1540
1720
|
/**
|
|
1721
|
+
* @public
|
|
1541
1722
|
* <p>The maximum number of jobs to be returned. The default limit is 50. The number of
|
|
1542
1723
|
* jobs returned might be fewer than the specified limit, but the number of returned jobs
|
|
1543
1724
|
* never exceeds the limit.</p>
|
|
1544
1725
|
*/
|
|
1545
1726
|
limit?: number;
|
|
1546
1727
|
/**
|
|
1728
|
+
* @public
|
|
1547
1729
|
* <p>An opaque string used for pagination. This value specifies the job at which the
|
|
1548
1730
|
* listing of jobs should begin. Get the marker value from a previous List Jobs response. You
|
|
1549
1731
|
* only need to include the marker if you are continuing the pagination of results started in
|
|
@@ -1551,11 +1733,13 @@ export interface ListJobsInput {
|
|
|
1551
1733
|
*/
|
|
1552
1734
|
marker?: string;
|
|
1553
1735
|
/**
|
|
1736
|
+
* @public
|
|
1554
1737
|
* <p>The type of job status to return. You can specify the following values:
|
|
1555
1738
|
* <code>InProgress</code>, <code>Succeeded</code>, or <code>Failed</code>.</p>
|
|
1556
1739
|
*/
|
|
1557
1740
|
statuscode?: string;
|
|
1558
1741
|
/**
|
|
1742
|
+
* @public
|
|
1559
1743
|
* <p>The state of the jobs to return. You can specify <code>true</code> or
|
|
1560
1744
|
* <code>false</code>.</p>
|
|
1561
1745
|
*/
|
|
@@ -1567,11 +1751,13 @@ export interface ListJobsInput {
|
|
|
1567
1751
|
*/
|
|
1568
1752
|
export interface ListJobsOutput {
|
|
1569
1753
|
/**
|
|
1754
|
+
* @public
|
|
1570
1755
|
* <p>A list of job objects. Each job object contains metadata describing the
|
|
1571
1756
|
* job.</p>
|
|
1572
1757
|
*/
|
|
1573
1758
|
JobList?: GlacierJobDescription[];
|
|
1574
1759
|
/**
|
|
1760
|
+
* @public
|
|
1575
1761
|
* <p>
|
|
1576
1762
|
* An opaque string used for pagination that specifies the job at which the listing of jobs should begin.
|
|
1577
1763
|
* You get the <code>marker</code> value from a previous List Jobs response.
|
|
@@ -1587,6 +1773,7 @@ export interface ListJobsOutput {
|
|
|
1587
1773
|
*/
|
|
1588
1774
|
export interface ListMultipartUploadsInput {
|
|
1589
1775
|
/**
|
|
1776
|
+
* @public
|
|
1590
1777
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1591
1778
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1592
1779
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1595,15 +1782,18 @@ export interface ListMultipartUploadsInput {
|
|
|
1595
1782
|
*/
|
|
1596
1783
|
accountId: string | undefined;
|
|
1597
1784
|
/**
|
|
1785
|
+
* @public
|
|
1598
1786
|
* <p>The name of the vault.</p>
|
|
1599
1787
|
*/
|
|
1600
1788
|
vaultName: string | undefined;
|
|
1601
1789
|
/**
|
|
1790
|
+
* @public
|
|
1602
1791
|
* <p>Specifies the maximum number of uploads returned in the response body. If this value
|
|
1603
1792
|
* is not specified, the List Uploads operation returns up to 50 uploads.</p>
|
|
1604
1793
|
*/
|
|
1605
1794
|
limit?: number;
|
|
1606
1795
|
/**
|
|
1796
|
+
* @public
|
|
1607
1797
|
* <p>An opaque string used for pagination. This value specifies the upload at which the
|
|
1608
1798
|
* listing of uploads should begin. Get the marker value from a previous List Uploads
|
|
1609
1799
|
* response. You need only include the marker if you are continuing the pagination of results
|
|
@@ -1617,25 +1807,30 @@ export interface ListMultipartUploadsInput {
|
|
|
1617
1807
|
*/
|
|
1618
1808
|
export interface UploadListElement {
|
|
1619
1809
|
/**
|
|
1810
|
+
* @public
|
|
1620
1811
|
* <p>The ID of a multipart upload.</p>
|
|
1621
1812
|
*/
|
|
1622
1813
|
MultipartUploadId?: string;
|
|
1623
1814
|
/**
|
|
1815
|
+
* @public
|
|
1624
1816
|
* <p>The Amazon Resource Name (ARN) of the vault that contains the archive.</p>
|
|
1625
1817
|
*/
|
|
1626
1818
|
VaultARN?: string;
|
|
1627
1819
|
/**
|
|
1820
|
+
* @public
|
|
1628
1821
|
* <p>The description of the archive that was specified in the Initiate Multipart Upload
|
|
1629
1822
|
* request.</p>
|
|
1630
1823
|
*/
|
|
1631
1824
|
ArchiveDescription?: string;
|
|
1632
1825
|
/**
|
|
1826
|
+
* @public
|
|
1633
1827
|
* <p>The part size, in bytes, specified in the Initiate Multipart Upload request. This is
|
|
1634
1828
|
* the size of all the parts in the upload except the last part, which may be smaller than
|
|
1635
1829
|
* this size.</p>
|
|
1636
1830
|
*/
|
|
1637
1831
|
PartSizeInBytes?: number;
|
|
1638
1832
|
/**
|
|
1833
|
+
* @public
|
|
1639
1834
|
* <p>The UTC time at which the multipart upload was initiated.</p>
|
|
1640
1835
|
*/
|
|
1641
1836
|
CreationDate?: string;
|
|
@@ -1646,10 +1841,12 @@ export interface UploadListElement {
|
|
|
1646
1841
|
*/
|
|
1647
1842
|
export interface ListMultipartUploadsOutput {
|
|
1648
1843
|
/**
|
|
1844
|
+
* @public
|
|
1649
1845
|
* <p>A list of in-progress multipart uploads.</p>
|
|
1650
1846
|
*/
|
|
1651
1847
|
UploadsList?: UploadListElement[];
|
|
1652
1848
|
/**
|
|
1849
|
+
* @public
|
|
1653
1850
|
* <p>An opaque string that represents where to continue pagination of the results. You use
|
|
1654
1851
|
* the marker in a new List Multipart Uploads request to obtain more uploads in the list. If
|
|
1655
1852
|
* there are no more uploads, this value is <code>null</code>.</p>
|
|
@@ -1663,6 +1860,7 @@ export interface ListMultipartUploadsOutput {
|
|
|
1663
1860
|
*/
|
|
1664
1861
|
export interface ListPartsInput {
|
|
1665
1862
|
/**
|
|
1863
|
+
* @public
|
|
1666
1864
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1667
1865
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1668
1866
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1671,14 +1869,17 @@ export interface ListPartsInput {
|
|
|
1671
1869
|
*/
|
|
1672
1870
|
accountId: string | undefined;
|
|
1673
1871
|
/**
|
|
1872
|
+
* @public
|
|
1674
1873
|
* <p>The name of the vault.</p>
|
|
1675
1874
|
*/
|
|
1676
1875
|
vaultName: string | undefined;
|
|
1677
1876
|
/**
|
|
1877
|
+
* @public
|
|
1678
1878
|
* <p>The upload ID of the multipart upload.</p>
|
|
1679
1879
|
*/
|
|
1680
1880
|
uploadId: string | undefined;
|
|
1681
1881
|
/**
|
|
1882
|
+
* @public
|
|
1682
1883
|
* <p>An opaque string used for pagination. This value specifies the part at which the
|
|
1683
1884
|
* listing of parts should begin. Get the marker value from the response of a previous List
|
|
1684
1885
|
* Parts response. You need only include the marker if you are continuing the pagination of
|
|
@@ -1686,6 +1887,7 @@ export interface ListPartsInput {
|
|
|
1686
1887
|
*/
|
|
1687
1888
|
marker?: string;
|
|
1688
1889
|
/**
|
|
1890
|
+
* @public
|
|
1689
1891
|
* <p>The maximum number of parts to be returned. The default limit is 50. The number of
|
|
1690
1892
|
* parts returned might be fewer than the specified limit, but the number of returned parts
|
|
1691
1893
|
* never exceeds the limit.</p>
|
|
@@ -1698,10 +1900,12 @@ export interface ListPartsInput {
|
|
|
1698
1900
|
*/
|
|
1699
1901
|
export interface PartListElement {
|
|
1700
1902
|
/**
|
|
1903
|
+
* @public
|
|
1701
1904
|
* <p>The byte range of a part, inclusive of the upper value of the range.</p>
|
|
1702
1905
|
*/
|
|
1703
1906
|
RangeInBytes?: string;
|
|
1704
1907
|
/**
|
|
1908
|
+
* @public
|
|
1705
1909
|
* <p>The SHA256 tree hash value that Amazon S3 Glacier calculated for the part. This field is
|
|
1706
1910
|
* never <code>null</code>.</p>
|
|
1707
1911
|
*/
|
|
@@ -1713,35 +1917,42 @@ export interface PartListElement {
|
|
|
1713
1917
|
*/
|
|
1714
1918
|
export interface ListPartsOutput {
|
|
1715
1919
|
/**
|
|
1920
|
+
* @public
|
|
1716
1921
|
* <p>The ID of the upload to which the parts are associated.</p>
|
|
1717
1922
|
*/
|
|
1718
1923
|
MultipartUploadId?: string;
|
|
1719
1924
|
/**
|
|
1925
|
+
* @public
|
|
1720
1926
|
* <p>The Amazon Resource Name (ARN) of the vault to which the multipart upload was
|
|
1721
1927
|
* initiated.</p>
|
|
1722
1928
|
*/
|
|
1723
1929
|
VaultARN?: string;
|
|
1724
1930
|
/**
|
|
1931
|
+
* @public
|
|
1725
1932
|
* <p>The description of the archive that was specified in the Initiate Multipart Upload
|
|
1726
1933
|
* request.</p>
|
|
1727
1934
|
*/
|
|
1728
1935
|
ArchiveDescription?: string;
|
|
1729
1936
|
/**
|
|
1937
|
+
* @public
|
|
1730
1938
|
* <p>The part size in bytes. This is the same value that you specified in the Initiate
|
|
1731
1939
|
* Multipart Upload request.</p>
|
|
1732
1940
|
*/
|
|
1733
1941
|
PartSizeInBytes?: number;
|
|
1734
1942
|
/**
|
|
1943
|
+
* @public
|
|
1735
1944
|
* <p>The UTC time at which the multipart upload was initiated.</p>
|
|
1736
1945
|
*/
|
|
1737
1946
|
CreationDate?: string;
|
|
1738
1947
|
/**
|
|
1948
|
+
* @public
|
|
1739
1949
|
* <p>A list of the part sizes of the multipart upload. Each object in the array contains a
|
|
1740
1950
|
* <code>RangeBytes</code> and <code>sha256-tree-hash</code> name/value
|
|
1741
1951
|
* pair.</p>
|
|
1742
1952
|
*/
|
|
1743
1953
|
Parts?: PartListElement[];
|
|
1744
1954
|
/**
|
|
1955
|
+
* @public
|
|
1745
1956
|
* <p>An opaque string that represents where to continue pagination of the results. You use
|
|
1746
1957
|
* the marker in a new List Parts request to obtain more jobs in the list. If there are no
|
|
1747
1958
|
* more parts, this value is <code>null</code>.</p>
|
|
@@ -1753,6 +1964,7 @@ export interface ListPartsOutput {
|
|
|
1753
1964
|
*/
|
|
1754
1965
|
export interface ListProvisionedCapacityInput {
|
|
1755
1966
|
/**
|
|
1967
|
+
* @public
|
|
1756
1968
|
* <p>The AWS account ID of the account that owns the vault. You can either specify an AWS
|
|
1757
1969
|
* account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
|
|
1758
1970
|
* account ID associated with the credentials used to sign the request. If you use an account
|
|
@@ -1766,14 +1978,17 @@ export interface ListProvisionedCapacityInput {
|
|
|
1766
1978
|
*/
|
|
1767
1979
|
export interface ProvisionedCapacityDescription {
|
|
1768
1980
|
/**
|
|
1981
|
+
* @public
|
|
1769
1982
|
* <p>The ID that identifies the provisioned capacity unit.</p>
|
|
1770
1983
|
*/
|
|
1771
1984
|
CapacityId?: string;
|
|
1772
1985
|
/**
|
|
1986
|
+
* @public
|
|
1773
1987
|
* <p>The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).</p>
|
|
1774
1988
|
*/
|
|
1775
1989
|
StartDate?: string;
|
|
1776
1990
|
/**
|
|
1991
|
+
* @public
|
|
1777
1992
|
* <p>The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).</p>
|
|
1778
1993
|
*/
|
|
1779
1994
|
ExpirationDate?: string;
|
|
@@ -1783,6 +1998,7 @@ export interface ProvisionedCapacityDescription {
|
|
|
1783
1998
|
*/
|
|
1784
1999
|
export interface ListProvisionedCapacityOutput {
|
|
1785
2000
|
/**
|
|
2001
|
+
* @public
|
|
1786
2002
|
* <p>The response body contains the following JSON fields.</p>
|
|
1787
2003
|
*/
|
|
1788
2004
|
ProvisionedCapacityList?: ProvisionedCapacityDescription[];
|
|
@@ -1793,6 +2009,7 @@ export interface ListProvisionedCapacityOutput {
|
|
|
1793
2009
|
*/
|
|
1794
2010
|
export interface ListTagsForVaultInput {
|
|
1795
2011
|
/**
|
|
2012
|
+
* @public
|
|
1796
2013
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1797
2014
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1798
2015
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1801,6 +2018,7 @@ export interface ListTagsForVaultInput {
|
|
|
1801
2018
|
*/
|
|
1802
2019
|
accountId: string | undefined;
|
|
1803
2020
|
/**
|
|
2021
|
+
* @public
|
|
1804
2022
|
* <p>The name of the vault.</p>
|
|
1805
2023
|
*/
|
|
1806
2024
|
vaultName: string | undefined;
|
|
@@ -1811,6 +2029,7 @@ export interface ListTagsForVaultInput {
|
|
|
1811
2029
|
*/
|
|
1812
2030
|
export interface ListTagsForVaultOutput {
|
|
1813
2031
|
/**
|
|
2032
|
+
* @public
|
|
1814
2033
|
* <p>The tags attached to the vault. Each tag is composed of a key and a value.</p>
|
|
1815
2034
|
*/
|
|
1816
2035
|
Tags?: Record<string, string>;
|
|
@@ -1822,6 +2041,7 @@ export interface ListTagsForVaultOutput {
|
|
|
1822
2041
|
*/
|
|
1823
2042
|
export interface ListVaultsInput {
|
|
1824
2043
|
/**
|
|
2044
|
+
* @public
|
|
1825
2045
|
* <p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS
|
|
1826
2046
|
* account ID associated with the credentials used to sign the request. You can either specify
|
|
1827
2047
|
* an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon
|
|
@@ -1830,11 +2050,13 @@ export interface ListVaultsInput {
|
|
|
1830
2050
|
*/
|
|
1831
2051
|
accountId: string | undefined;
|
|
1832
2052
|
/**
|
|
2053
|
+
* @public
|
|
1833
2054
|
* <p>A string used for pagination. The marker specifies the vault ARN after which the
|
|
1834
2055
|
* listing of vaults should begin.</p>
|
|
1835
2056
|
*/
|
|
1836
2057
|
marker?: string;
|
|
1837
2058
|
/**
|
|
2059
|
+
* @public
|
|
1838
2060
|
* <p>The maximum number of vaults to be returned. The default limit is 10. The number of
|
|
1839
2061
|
* vaults returned might be fewer than the specified limit, but the number of returned vaults
|
|
1840
2062
|
* never exceeds the limit.</p>
|
|
@@ -1847,10 +2069,12 @@ export interface ListVaultsInput {
|
|
|
1847
2069
|
*/
|
|
1848
2070
|
export interface ListVaultsOutput {
|
|
1849
2071
|
/**
|
|
2072
|
+
* @public
|
|
1850
2073
|
* <p>List of vaults.</p>
|
|
1851
2074
|
*/
|
|
1852
2075
|
VaultList?: DescribeVaultOutput[];
|
|
1853
2076
|
/**
|
|
2077
|
+
* @public
|
|
1854
2078
|
* <p>The vault ARN at which to continue pagination of the results. You use the marker in
|
|
1855
2079
|
* another List Vaults request to obtain more vaults in the list.</p>
|
|
1856
2080
|
*/
|
|
@@ -1861,6 +2085,7 @@ export interface ListVaultsOutput {
|
|
|
1861
2085
|
*/
|
|
1862
2086
|
export interface PurchaseProvisionedCapacityInput {
|
|
1863
2087
|
/**
|
|
2088
|
+
* @public
|
|
1864
2089
|
* <p>The AWS account ID of the account that owns the vault. You can either specify an AWS
|
|
1865
2090
|
* account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
|
|
1866
2091
|
* account ID associated with the credentials used to sign the request. If you use an account
|
|
@@ -1873,6 +2098,7 @@ export interface PurchaseProvisionedCapacityInput {
|
|
|
1873
2098
|
*/
|
|
1874
2099
|
export interface PurchaseProvisionedCapacityOutput {
|
|
1875
2100
|
/**
|
|
2101
|
+
* @public
|
|
1876
2102
|
* <p>The ID that identifies the provisioned capacity unit.</p>
|
|
1877
2103
|
*/
|
|
1878
2104
|
capacityId?: string;
|
|
@@ -1883,6 +2109,7 @@ export interface PurchaseProvisionedCapacityOutput {
|
|
|
1883
2109
|
*/
|
|
1884
2110
|
export interface RemoveTagsFromVaultInput {
|
|
1885
2111
|
/**
|
|
2112
|
+
* @public
|
|
1886
2113
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1887
2114
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1888
2115
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1891,10 +2118,12 @@ export interface RemoveTagsFromVaultInput {
|
|
|
1891
2118
|
*/
|
|
1892
2119
|
accountId: string | undefined;
|
|
1893
2120
|
/**
|
|
2121
|
+
* @public
|
|
1894
2122
|
* <p>The name of the vault.</p>
|
|
1895
2123
|
*/
|
|
1896
2124
|
vaultName: string | undefined;
|
|
1897
2125
|
/**
|
|
2126
|
+
* @public
|
|
1898
2127
|
* <p>A list of tag keys. Each corresponding tag is removed from the vault.</p>
|
|
1899
2128
|
*/
|
|
1900
2129
|
TagKeys?: string[];
|
|
@@ -1905,6 +2134,7 @@ export interface RemoveTagsFromVaultInput {
|
|
|
1905
2134
|
*/
|
|
1906
2135
|
export interface SetDataRetrievalPolicyInput {
|
|
1907
2136
|
/**
|
|
2137
|
+
* @public
|
|
1908
2138
|
* <p>The <code>AccountId</code> value is the AWS account ID. This value must match the AWS
|
|
1909
2139
|
* account ID associated with the credentials used to sign the request. You can either specify
|
|
1910
2140
|
* an AWS account ID or optionally a single '<code>-</code>' (hyphen), in which case Amazon
|
|
@@ -1913,6 +2143,7 @@ export interface SetDataRetrievalPolicyInput {
|
|
|
1913
2143
|
*/
|
|
1914
2144
|
accountId: string | undefined;
|
|
1915
2145
|
/**
|
|
2146
|
+
* @public
|
|
1916
2147
|
* <p>The data retrieval policy in JSON format.</p>
|
|
1917
2148
|
*/
|
|
1918
2149
|
Policy?: DataRetrievalPolicy;
|
|
@@ -1923,6 +2154,7 @@ export interface SetDataRetrievalPolicyInput {
|
|
|
1923
2154
|
*/
|
|
1924
2155
|
export interface SetVaultAccessPolicyInput {
|
|
1925
2156
|
/**
|
|
2157
|
+
* @public
|
|
1926
2158
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1927
2159
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1928
2160
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1931,10 +2163,12 @@ export interface SetVaultAccessPolicyInput {
|
|
|
1931
2163
|
*/
|
|
1932
2164
|
accountId: string | undefined;
|
|
1933
2165
|
/**
|
|
2166
|
+
* @public
|
|
1934
2167
|
* <p>The name of the vault.</p>
|
|
1935
2168
|
*/
|
|
1936
2169
|
vaultName: string | undefined;
|
|
1937
2170
|
/**
|
|
2171
|
+
* @public
|
|
1938
2172
|
* <p>The vault access policy as a JSON string.</p>
|
|
1939
2173
|
*/
|
|
1940
2174
|
policy?: VaultAccessPolicy;
|
|
@@ -1946,6 +2180,7 @@ export interface SetVaultAccessPolicyInput {
|
|
|
1946
2180
|
*/
|
|
1947
2181
|
export interface SetVaultNotificationsInput {
|
|
1948
2182
|
/**
|
|
2183
|
+
* @public
|
|
1949
2184
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1950
2185
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1951
2186
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -1954,10 +2189,12 @@ export interface SetVaultNotificationsInput {
|
|
|
1954
2189
|
*/
|
|
1955
2190
|
accountId: string | undefined;
|
|
1956
2191
|
/**
|
|
2192
|
+
* @public
|
|
1957
2193
|
* <p>The name of the vault.</p>
|
|
1958
2194
|
*/
|
|
1959
2195
|
vaultName: string | undefined;
|
|
1960
2196
|
/**
|
|
2197
|
+
* @public
|
|
1961
2198
|
* <p>Provides options for specifying notification configuration.</p>
|
|
1962
2199
|
*/
|
|
1963
2200
|
vaultNotificationConfig?: VaultNotificationConfig;
|
|
@@ -1971,10 +2208,12 @@ export declare class RequestTimeoutException extends __BaseException {
|
|
|
1971
2208
|
readonly name: "RequestTimeoutException";
|
|
1972
2209
|
readonly $fault: "client";
|
|
1973
2210
|
/**
|
|
2211
|
+
* @public
|
|
1974
2212
|
* <p>Client</p>
|
|
1975
2213
|
*/
|
|
1976
2214
|
type?: string;
|
|
1977
2215
|
/**
|
|
2216
|
+
* @public
|
|
1978
2217
|
* <p>408 Request Timeout</p>
|
|
1979
2218
|
*/
|
|
1980
2219
|
code?: string;
|
|
@@ -1989,10 +2228,12 @@ export declare class RequestTimeoutException extends __BaseException {
|
|
|
1989
2228
|
*/
|
|
1990
2229
|
export interface UploadArchiveInput {
|
|
1991
2230
|
/**
|
|
2231
|
+
* @public
|
|
1992
2232
|
* <p>The name of the vault.</p>
|
|
1993
2233
|
*/
|
|
1994
2234
|
vaultName: string | undefined;
|
|
1995
2235
|
/**
|
|
2236
|
+
* @public
|
|
1996
2237
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
1997
2238
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
1998
2239
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -2001,14 +2242,17 @@ export interface UploadArchiveInput {
|
|
|
2001
2242
|
*/
|
|
2002
2243
|
accountId: string | undefined;
|
|
2003
2244
|
/**
|
|
2245
|
+
* @public
|
|
2004
2246
|
* <p>The optional description of the archive you are uploading.</p>
|
|
2005
2247
|
*/
|
|
2006
2248
|
archiveDescription?: string;
|
|
2007
2249
|
/**
|
|
2250
|
+
* @public
|
|
2008
2251
|
* <p>The SHA256 tree hash of the data being uploaded.</p>
|
|
2009
2252
|
*/
|
|
2010
2253
|
checksum?: string;
|
|
2011
2254
|
/**
|
|
2255
|
+
* @public
|
|
2012
2256
|
* <p>The data to upload.</p>
|
|
2013
2257
|
*/
|
|
2014
2258
|
body?: StreamingBlobTypes;
|
|
@@ -2020,6 +2264,7 @@ export interface UploadArchiveInput {
|
|
|
2020
2264
|
*/
|
|
2021
2265
|
export interface UploadMultipartPartInput {
|
|
2022
2266
|
/**
|
|
2267
|
+
* @public
|
|
2023
2268
|
* <p>The <code>AccountId</code> value is the AWS account ID of the account that owns the
|
|
2024
2269
|
* vault. You can either specify an AWS account ID or optionally a single '<code>-</code>'
|
|
2025
2270
|
* (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the
|
|
@@ -2028,18 +2273,22 @@ export interface UploadMultipartPartInput {
|
|
|
2028
2273
|
*/
|
|
2029
2274
|
accountId: string | undefined;
|
|
2030
2275
|
/**
|
|
2276
|
+
* @public
|
|
2031
2277
|
* <p>The name of the vault.</p>
|
|
2032
2278
|
*/
|
|
2033
2279
|
vaultName: string | undefined;
|
|
2034
2280
|
/**
|
|
2281
|
+
* @public
|
|
2035
2282
|
* <p>The upload ID of the multipart upload.</p>
|
|
2036
2283
|
*/
|
|
2037
2284
|
uploadId: string | undefined;
|
|
2038
2285
|
/**
|
|
2286
|
+
* @public
|
|
2039
2287
|
* <p>The SHA256 tree hash of the data being uploaded.</p>
|
|
2040
2288
|
*/
|
|
2041
2289
|
checksum?: string;
|
|
2042
2290
|
/**
|
|
2291
|
+
* @public
|
|
2043
2292
|
* <p>Identifies the range of bytes in the assembled archive that will be uploaded in this
|
|
2044
2293
|
* part. Amazon S3 Glacier uses this information to assemble the archive in the proper sequence.
|
|
2045
2294
|
* The format of this header follows RFC 2616. An example header is Content-Range:bytes
|
|
@@ -2047,6 +2296,7 @@ export interface UploadMultipartPartInput {
|
|
|
2047
2296
|
*/
|
|
2048
2297
|
range?: string;
|
|
2049
2298
|
/**
|
|
2299
|
+
* @public
|
|
2050
2300
|
* <p>The data to upload.</p>
|
|
2051
2301
|
*/
|
|
2052
2302
|
body?: StreamingBlobTypes;
|
|
@@ -2057,6 +2307,7 @@ export interface UploadMultipartPartInput {
|
|
|
2057
2307
|
*/
|
|
2058
2308
|
export interface UploadMultipartPartOutput {
|
|
2059
2309
|
/**
|
|
2310
|
+
* @public
|
|
2060
2311
|
* <p>The SHA256 tree hash that Amazon S3 Glacier computed for the uploaded part.</p>
|
|
2061
2312
|
*/
|
|
2062
2313
|
checksum?: string;
|