qldb.d.ts
43.5 KB
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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class QLDB extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: QLDB.Types.ClientConfiguration)
config: Config & QLDB.Types.ClientConfiguration;
/**
* Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE. You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
*/
cancelJournalKinesisStream(params: QLDB.Types.CancelJournalKinesisStreamRequest, callback?: (err: AWSError, data: QLDB.Types.CancelJournalKinesisStreamResponse) => void): Request<QLDB.Types.CancelJournalKinesisStreamResponse, AWSError>;
/**
* Ends a given Amazon QLDB journal stream. Before a stream can be canceled, its current status must be ACTIVE. You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
*/
cancelJournalKinesisStream(callback?: (err: AWSError, data: QLDB.Types.CancelJournalKinesisStreamResponse) => void): Request<QLDB.Types.CancelJournalKinesisStreamResponse, AWSError>;
/**
* Creates a new ledger in your AWS account.
*/
createLedger(params: QLDB.Types.CreateLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.CreateLedgerResponse) => void): Request<QLDB.Types.CreateLedgerResponse, AWSError>;
/**
* Creates a new ledger in your AWS account.
*/
createLedger(callback?: (err: AWSError, data: QLDB.Types.CreateLedgerResponse) => void): Request<QLDB.Types.CreateLedgerResponse, AWSError>;
/**
* Deletes a ledger and all of its contents. This action is irreversible. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
*/
deleteLedger(params: QLDB.Types.DeleteLedgerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a ledger and all of its contents. This action is irreversible. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
*/
deleteLedger(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of your original stream creation request.
*/
describeJournalKinesisStream(params: QLDB.Types.DescribeJournalKinesisStreamRequest, callback?: (err: AWSError, data: QLDB.Types.DescribeJournalKinesisStreamResponse) => void): Request<QLDB.Types.DescribeJournalKinesisStreamResponse, AWSError>;
/**
* Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of your original stream creation request.
*/
describeJournalKinesisStream(callback?: (err: AWSError, data: QLDB.Types.DescribeJournalKinesisStreamResponse) => void): Request<QLDB.Types.DescribeJournalKinesisStreamResponse, AWSError>;
/**
* Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide. If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
*/
describeJournalS3Export(params: QLDB.Types.DescribeJournalS3ExportRequest, callback?: (err: AWSError, data: QLDB.Types.DescribeJournalS3ExportResponse) => void): Request<QLDB.Types.DescribeJournalS3ExportResponse, AWSError>;
/**
* Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide. If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.
*/
describeJournalS3Export(callback?: (err: AWSError, data: QLDB.Types.DescribeJournalS3ExportResponse) => void): Request<QLDB.Types.DescribeJournalS3ExportResponse, AWSError>;
/**
* Returns information about a ledger, including its state and when it was created.
*/
describeLedger(params: QLDB.Types.DescribeLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.DescribeLedgerResponse) => void): Request<QLDB.Types.DescribeLedgerResponse, AWSError>;
/**
* Returns information about a ledger, including its state and when it was created.
*/
describeLedger(callback?: (err: AWSError, data: QLDB.Types.DescribeLedgerResponse) => void): Request<QLDB.Types.DescribeLedgerResponse, AWSError>;
/**
* Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.
*/
exportJournalToS3(params: QLDB.Types.ExportJournalToS3Request, callback?: (err: AWSError, data: QLDB.Types.ExportJournalToS3Response) => void): Request<QLDB.Types.ExportJournalToS3Response, AWSError>;
/**
* Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format. If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException. If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException. You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.
*/
exportJournalToS3(callback?: (err: AWSError, data: QLDB.Types.ExportJournalToS3Response) => void): Request<QLDB.Types.ExportJournalToS3Response, AWSError>;
/**
* Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided. For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide. If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException. If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException. If no block exists with the specified address, then throws InvalidParameterException.
*/
getBlock(params: QLDB.Types.GetBlockRequest, callback?: (err: AWSError, data: QLDB.Types.GetBlockResponse) => void): Request<QLDB.Types.GetBlockResponse, AWSError>;
/**
* Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided. For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide. If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException. If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException. If no block exists with the specified address, then throws InvalidParameterException.
*/
getBlock(callback?: (err: AWSError, data: QLDB.Types.GetBlockResponse) => void): Request<QLDB.Types.GetBlockResponse, AWSError>;
/**
* Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.
*/
getDigest(params: QLDB.Types.GetDigestRequest, callback?: (err: AWSError, data: QLDB.Types.GetDigestResponse) => void): Request<QLDB.Types.GetDigestResponse, AWSError>;
/**
* Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.
*/
getDigest(callback?: (err: AWSError, data: QLDB.Types.GetDigestResponse) => void): Request<QLDB.Types.GetDigestResponse, AWSError>;
/**
* Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.
*/
getRevision(params: QLDB.Types.GetRevisionRequest, callback?: (err: AWSError, data: QLDB.Types.GetRevisionResponse) => void): Request<QLDB.Types.GetRevisionResponse, AWSError>;
/**
* Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.
*/
getRevision(callback?: (err: AWSError, data: QLDB.Types.GetRevisionResponse) => void): Request<QLDB.Types.GetRevisionResponse, AWSError>;
/**
* Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream. This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.
*/
listJournalKinesisStreamsForLedger(params: QLDB.Types.ListJournalKinesisStreamsForLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.ListJournalKinesisStreamsForLedgerResponse) => void): Request<QLDB.Types.ListJournalKinesisStreamsForLedgerResponse, AWSError>;
/**
* Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream. This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.
*/
listJournalKinesisStreamsForLedger(callback?: (err: AWSError, data: QLDB.Types.ListJournalKinesisStreamsForLedgerResponse) => void): Request<QLDB.Types.ListJournalKinesisStreamsForLedgerResponse, AWSError>;
/**
* Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.
*/
listJournalS3Exports(params: QLDB.Types.ListJournalS3ExportsRequest, callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsResponse) => void): Request<QLDB.Types.ListJournalS3ExportsResponse, AWSError>;
/**
* Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.
*/
listJournalS3Exports(callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsResponse) => void): Request<QLDB.Types.ListJournalS3ExportsResponse, AWSError>;
/**
* Returns an array of journal export job descriptions for a specified ledger. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.
*/
listJournalS3ExportsForLedger(params: QLDB.Types.ListJournalS3ExportsForLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsForLedgerResponse) => void): Request<QLDB.Types.ListJournalS3ExportsForLedgerResponse, AWSError>;
/**
* Returns an array of journal export job descriptions for a specified ledger. This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times. This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.
*/
listJournalS3ExportsForLedger(callback?: (err: AWSError, data: QLDB.Types.ListJournalS3ExportsForLedgerResponse) => void): Request<QLDB.Types.ListJournalS3ExportsForLedgerResponse, AWSError>;
/**
* Returns an array of ledger summaries that are associated with the current AWS account and Region. This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.
*/
listLedgers(params: QLDB.Types.ListLedgersRequest, callback?: (err: AWSError, data: QLDB.Types.ListLedgersResponse) => void): Request<QLDB.Types.ListLedgersResponse, AWSError>;
/**
* Returns an array of ledger summaries that are associated with the current AWS account and Region. This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.
*/
listLedgers(callback?: (err: AWSError, data: QLDB.Types.ListLedgersResponse) => void): Request<QLDB.Types.ListLedgersResponse, AWSError>;
/**
* Returns all tags for a specified Amazon QLDB resource.
*/
listTagsForResource(params: QLDB.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: QLDB.Types.ListTagsForResourceResponse) => void): Request<QLDB.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns all tags for a specified Amazon QLDB resource.
*/
listTagsForResource(callback?: (err: AWSError, data: QLDB.Types.ListTagsForResourceResponse) => void): Request<QLDB.Types.ListTagsForResourceResponse, AWSError>;
/**
* Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
*/
streamJournalToKinesis(params: QLDB.Types.StreamJournalToKinesisRequest, callback?: (err: AWSError, data: QLDB.Types.StreamJournalToKinesisResponse) => void): Request<QLDB.Types.StreamJournalToKinesisResponse, AWSError>;
/**
* Creates a journal stream for a given Amazon QLDB ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.
*/
streamJournalToKinesis(callback?: (err: AWSError, data: QLDB.Types.StreamJournalToKinesisResponse) => void): Request<QLDB.Types.StreamJournalToKinesisResponse, AWSError>;
/**
* Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.
*/
tagResource(params: QLDB.Types.TagResourceRequest, callback?: (err: AWSError, data: QLDB.Types.TagResourceResponse) => void): Request<QLDB.Types.TagResourceResponse, AWSError>;
/**
* Adds one or more tags to a specified Amazon QLDB resource. A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.
*/
tagResource(callback?: (err: AWSError, data: QLDB.Types.TagResourceResponse) => void): Request<QLDB.Types.TagResourceResponse, AWSError>;
/**
* Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
*/
untagResource(params: QLDB.Types.UntagResourceRequest, callback?: (err: AWSError, data: QLDB.Types.UntagResourceResponse) => void): Request<QLDB.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.
*/
untagResource(callback?: (err: AWSError, data: QLDB.Types.UntagResourceResponse) => void): Request<QLDB.Types.UntagResourceResponse, AWSError>;
/**
* Updates properties on a ledger.
*/
updateLedger(params: QLDB.Types.UpdateLedgerRequest, callback?: (err: AWSError, data: QLDB.Types.UpdateLedgerResponse) => void): Request<QLDB.Types.UpdateLedgerResponse, AWSError>;
/**
* Updates properties on a ledger.
*/
updateLedger(callback?: (err: AWSError, data: QLDB.Types.UpdateLedgerResponse) => void): Request<QLDB.Types.UpdateLedgerResponse, AWSError>;
}
declare namespace QLDB {
export type Arn = string;
export type Boolean = boolean;
export interface CancelJournalKinesisStreamRequest {
/**
* The name of the ledger.
*/
LedgerName: LedgerName;
/**
* The unique ID that QLDB assigns to each QLDB journal stream.
*/
StreamId: UniqueId;
}
export interface CancelJournalKinesisStreamResponse {
/**
* The unique ID that QLDB assigns to each QLDB journal stream.
*/
StreamId?: UniqueId;
}
export interface CreateLedgerRequest {
/**
* The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region. Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
*/
Name: LedgerName;
/**
* The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.
*/
Tags?: Tags;
/**
* The permissions mode to assign to the ledger that you want to create.
*/
PermissionsMode: PermissionsMode;
/**
* The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
*/
DeletionProtection?: DeletionProtection;
}
export interface CreateLedgerResponse {
/**
* The name of the ledger.
*/
Name?: LedgerName;
/**
* The Amazon Resource Name (ARN) for the ledger.
*/
Arn?: Arn;
/**
* The current status of the ledger.
*/
State?: LedgerState;
/**
* The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*/
CreationDateTime?: Timestamp;
/**
* The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
*/
DeletionProtection?: DeletionProtection;
}
export interface DeleteLedgerRequest {
/**
* The name of the ledger that you want to delete.
*/
Name: LedgerName;
}
export type DeletionProtection = boolean;
export interface DescribeJournalKinesisStreamRequest {
/**
* The name of the ledger.
*/
LedgerName: LedgerName;
/**
* The unique ID that QLDB assigns to each QLDB journal stream.
*/
StreamId: UniqueId;
}
export interface DescribeJournalKinesisStreamResponse {
/**
* Information about the QLDB journal stream returned by a DescribeJournalS3Export request.
*/
Stream?: JournalKinesisStreamDescription;
}
export interface DescribeJournalS3ExportRequest {
/**
* The name of the ledger.
*/
Name: LedgerName;
/**
* The unique ID of the journal export job that you want to describe.
*/
ExportId: UniqueId;
}
export interface DescribeJournalS3ExportResponse {
/**
* Information about the journal export job returned by a DescribeJournalS3Export request.
*/
ExportDescription: JournalS3ExportDescription;
}
export interface DescribeLedgerRequest {
/**
* The name of the ledger that you want to describe.
*/
Name: LedgerName;
}
export interface DescribeLedgerResponse {
/**
* The name of the ledger.
*/
Name?: LedgerName;
/**
* The Amazon Resource Name (ARN) for the ledger.
*/
Arn?: Arn;
/**
* The current status of the ledger.
*/
State?: LedgerState;
/**
* The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*/
CreationDateTime?: Timestamp;
/**
* The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
*/
DeletionProtection?: DeletionProtection;
}
export type Digest = Buffer|Uint8Array|Blob|string;
export type ErrorCause = "KINESIS_STREAM_NOT_FOUND"|"IAM_PERMISSION_REVOKED"|string;
export interface ExportJournalToS3Request {
/**
* The name of the ledger.
*/
Name: LedgerName;
/**
* The inclusive start date and time for the range of journal contents that you want to export. The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z The InclusiveStartTime must be before ExclusiveEndTime. If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.
*/
InclusiveStartTime: Timestamp;
/**
* The exclusive end date and time for the range of journal contents that you want to export. The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z The ExclusiveEndTime must be less than or equal to the current UTC date and time.
*/
ExclusiveEndTime: Timestamp;
/**
* The configuration settings of the Amazon S3 bucket destination for your export request.
*/
S3ExportConfiguration: S3ExportConfiguration;
/**
* The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following: Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.
*/
RoleArn: Arn;
}
export interface ExportJournalToS3Response {
/**
* The unique ID that QLDB assigns to each journal export job. To describe your export request and check the status of the job, you can use ExportId to call DescribeJournalS3Export.
*/
ExportId: UniqueId;
}
export type ExportStatus = "IN_PROGRESS"|"COMPLETED"|"CANCELLED"|string;
export interface GetBlockRequest {
/**
* The name of the ledger.
*/
Name: LedgerName;
/**
* The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}
*/
BlockAddress: ValueHolder;
/**
* The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}
*/
DigestTipAddress?: ValueHolder;
}
export interface GetBlockResponse {
/**
* The block data object in Amazon Ion format.
*/
Block: ValueHolder;
/**
* The proof object in Amazon Ion format returned by a GetBlock request. A proof contains the list of hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block.
*/
Proof?: ValueHolder;
}
export interface GetDigestRequest {
/**
* The name of the ledger.
*/
Name: LedgerName;
}
export interface GetDigestResponse {
/**
* The 256-bit hash value representing the digest returned by a GetDigest request.
*/
Digest: Digest;
/**
* The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.
*/
DigestTipAddress: ValueHolder;
}
export interface GetRevisionRequest {
/**
* The name of the ledger.
*/
Name: LedgerName;
/**
* The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}
*/
BlockAddress: ValueHolder;
/**
* The unique ID of the document to be verified.
*/
DocumentId: UniqueId;
/**
* The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo. For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}
*/
DigestTipAddress?: ValueHolder;
}
export interface GetRevisionResponse {
/**
* The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.
*/
Proof?: ValueHolder;
/**
* The document revision data object in Amazon Ion format.
*/
Revision: ValueHolder;
}
export type IonText = string;
export interface JournalKinesisStreamDescription {
/**
* The name of the ledger.
*/
LedgerName: LedgerName;
/**
* The date and time, in epoch time format, when the QLDB journal stream was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*/
CreationTime?: Timestamp;
/**
* The inclusive start date and time from which to start streaming journal data.
*/
InclusiveStartTime?: Timestamp;
/**
* The exclusive date and time that specifies when the stream ends. If this parameter is blank, the stream runs indefinitely until you cancel it.
*/
ExclusiveEndTime?: Timestamp;
/**
* The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
*/
RoleArn: Arn;
/**
* The unique ID that QLDB assigns to each QLDB journal stream.
*/
StreamId: UniqueId;
/**
* The Amazon Resource Name (ARN) of the QLDB journal stream.
*/
Arn?: Arn;
/**
* The current state of the QLDB journal stream.
*/
Status: StreamStatus;
/**
* The configuration settings of the Amazon Kinesis Data Streams destination for your QLDB journal stream.
*/
KinesisConfiguration: KinesisConfiguration;
/**
* The error message that describes the reason that a stream has a status of IMPAIRED or FAILED. This is not applicable to streams that have other status values.
*/
ErrorCause?: ErrorCause;
/**
* The user-defined name of the QLDB journal stream.
*/
StreamName: StreamName;
}
export type JournalKinesisStreamDescriptionList = JournalKinesisStreamDescription[];
export interface JournalS3ExportDescription {
/**
* The name of the ledger.
*/
LedgerName: LedgerName;
/**
* The unique ID of the journal export job.
*/
ExportId: UniqueId;
/**
* The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*/
ExportCreationTime: Timestamp;
/**
* The current state of the journal export job.
*/
Status: ExportStatus;
/**
* The inclusive start date and time for the range of journal contents that are specified in the original export request.
*/
InclusiveStartTime: Timestamp;
/**
* The exclusive end date and time for the range of journal contents that are specified in the original export request.
*/
ExclusiveEndTime: Timestamp;
S3ExportConfiguration: S3ExportConfiguration;
/**
* The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following: Write objects into your Amazon Simple Storage Service (Amazon S3) bucket. (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.
*/
RoleArn: Arn;
}
export type JournalS3ExportList = JournalS3ExportDescription[];
export interface KinesisConfiguration {
/**
* The Amazon Resource Name (ARN) of the Kinesis data stream resource.
*/
StreamArn: Arn;
/**
* Enables QLDB to publish multiple data records in a single Kinesis Data Streams record. To learn more, see KPL Key Concepts in the Amazon Kinesis Data Streams Developer Guide.
*/
AggregationEnabled?: Boolean;
}
export type LedgerList = LedgerSummary[];
export type LedgerName = string;
export type LedgerState = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|string;
export interface LedgerSummary {
/**
* The name of the ledger.
*/
Name?: LedgerName;
/**
* The current status of the ledger.
*/
State?: LedgerState;
/**
* The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*/
CreationDateTime?: Timestamp;
}
export interface ListJournalKinesisStreamsForLedgerRequest {
/**
* The name of the ledger.
*/
LedgerName: LedgerName;
/**
* The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)
*/
MaxResults?: MaxResults;
/**
* A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalKinesisStreamsForLedger call, you should use that value as input here.
*/
NextToken?: NextToken;
}
export interface ListJournalKinesisStreamsForLedgerResponse {
/**
* The array of QLDB journal stream descriptors that are associated with the given ledger.
*/
Streams?: JournalKinesisStreamDescriptionList;
/**
* If NextToken is empty, the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, more results are available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalKinesisStreamsForLedger call.
*/
NextToken?: NextToken;
}
export interface ListJournalS3ExportsForLedgerRequest {
/**
* The name of the ledger.
*/
Name: LedgerName;
/**
* The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)
*/
MaxResults?: MaxResults;
/**
* A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3ExportsForLedger call, then you should use that value as input here.
*/
NextToken?: NextToken;
}
export interface ListJournalS3ExportsForLedgerResponse {
/**
* The array of journal export job descriptions that are associated with the specified ledger.
*/
JournalS3Exports?: JournalS3ExportList;
/**
* If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3ExportsForLedger call.
*/
NextToken?: NextToken;
}
export interface ListJournalS3ExportsRequest {
/**
* The maximum number of results to return in a single ListJournalS3Exports request. (The actual number of results returned might be fewer.)
*/
MaxResults?: MaxResults;
/**
* A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3Exports call, then you should use that value as input here.
*/
NextToken?: NextToken;
}
export interface ListJournalS3ExportsResponse {
/**
* The array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.
*/
JournalS3Exports?: JournalS3ExportList;
/**
* If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3Exports call.
*/
NextToken?: NextToken;
}
export interface ListLedgersRequest {
/**
* The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.)
*/
MaxResults?: MaxResults;
/**
* A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListLedgers call, then you should use that value as input here.
*/
NextToken?: NextToken;
}
export interface ListLedgersResponse {
/**
* The array of ledger summaries that are associated with the current AWS account and Region.
*/
Ledgers?: LedgerList;
/**
* A pagination token, indicating whether there are more results available: If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved. If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListLedgers call.
*/
NextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) for which you want to list the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
*/
ResourceArn: Arn;
}
export interface ListTagsForResourceResponse {
/**
* The tags that are currently associated with the specified Amazon QLDB resource.
*/
Tags?: Tags;
}
export type MaxResults = number;
export type NextToken = string;
export type PermissionsMode = "ALLOW_ALL"|string;
export type S3Bucket = string;
export interface S3EncryptionConfiguration {
/**
* The Amazon S3 object encryption type. To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.
*/
ObjectEncryptionType: S3ObjectEncryptionType;
/**
* The Amazon Resource Name (ARN) for a symmetric customer master key (CMK) in AWS Key Management Service (AWS KMS). Amazon QLDB does not support asymmetric CMKs. You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType. KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.
*/
KmsKeyArn?: Arn;
}
export interface S3ExportConfiguration {
/**
* The Amazon S3 bucket name in which a journal export job writes the journal contents. The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.
*/
Bucket: S3Bucket;
/**
* The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents. The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide. The following are examples of valid Prefix values: JournalExports-ForMyLedger/Testing/ JournalExports My:Tests/
*/
Prefix: S3Prefix;
/**
* The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.
*/
EncryptionConfiguration: S3EncryptionConfiguration;
}
export type S3ObjectEncryptionType = "SSE_KMS"|"SSE_S3"|"NO_ENCRYPTION"|string;
export type S3Prefix = string;
export interface StreamJournalToKinesisRequest {
/**
* The name of the ledger.
*/
LedgerName: LedgerName;
/**
* The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource.
*/
RoleArn: Arn;
/**
* The key-value pairs to add as tags to the stream that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.
*/
Tags?: Tags;
/**
* The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime. If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, QLDB effectively defaults it to the ledger's CreationDateTime.
*/
InclusiveStartTime: Timestamp;
/**
* The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it. The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z
*/
ExclusiveEndTime?: Timestamp;
/**
* The configuration settings of the Kinesis Data Streams destination for your stream request.
*/
KinesisConfiguration: KinesisConfiguration;
/**
* The name that you want to assign to the QLDB journal stream. User-defined names can help identify and indicate the purpose of a stream. Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
*/
StreamName: StreamName;
}
export interface StreamJournalToKinesisResponse {
/**
* The unique ID that QLDB assigns to each QLDB journal stream.
*/
StreamId?: UniqueId;
}
export type StreamName = string;
export type StreamStatus = "ACTIVE"|"COMPLETED"|"CANCELED"|"FAILED"|"IMPAIRED"|string;
export type TagKey = string;
export type TagKeyList = TagKey[];
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) to which you want to add the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
*/
ResourceArn: Arn;
/**
* The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.
*/
Tags: Tags;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Tags = {[key: string]: TagValue};
export type Timestamp = Date;
export type UniqueId = string;
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) from which you want to remove the tags. For example: arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger
*/
ResourceArn: Arn;
/**
* The list of tag keys that you want to remove.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateLedgerRequest {
/**
* The name of the ledger.
*/
Name: LedgerName;
/**
* The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
*/
DeletionProtection?: DeletionProtection;
}
export interface UpdateLedgerResponse {
/**
* The name of the ledger.
*/
Name?: LedgerName;
/**
* The Amazon Resource Name (ARN) for the ledger.
*/
Arn?: Arn;
/**
* The current status of the ledger.
*/
State?: LedgerState;
/**
* The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*/
CreationDateTime?: Timestamp;
/**
* The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default. If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.
*/
DeletionProtection?: DeletionProtection;
}
export interface ValueHolder {
/**
* An Amazon Ion plaintext value contained in a ValueHolder structure.
*/
IonText?: IonText;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-01-02"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the QLDB client.
*/
export import Types = QLDB;
}
export = QLDB;