-
Notifications
You must be signed in to change notification settings - Fork 576
/
models_0.ts
3141 lines (2880 loc) · 101 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
import { KinesisServiceException as __BaseException } from "./KinesisServiceException";
/**
* @public
* <p>Specifies that you do not have the permissions required to perform this
* operation.</p>
*/
export class AccessDeniedException extends __BaseException {
readonly name: "AccessDeniedException" = "AccessDeniedException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) {
super({
name: "AccessDeniedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AccessDeniedException.prototype);
}
}
/**
* @public
* <p>Represents the input for <code>AddTagsToStream</code>.</p>
*/
export interface AddTagsToStreamInput {
/**
* @public
* <p>The name of the stream.</p>
*/
StreamName?: string;
/**
* @public
* <p>A set of up to 10 key-value pairs to use to create the tags.</p>
*/
Tags: Record<string, string> | undefined;
/**
* @public
* <p>The ARN of the stream.</p>
*/
StreamARN?: string;
}
/**
* @public
* <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
* For more information, see the returned message.</p>
*/
export class InvalidArgumentException extends __BaseException {
readonly name: "InvalidArgumentException" = "InvalidArgumentException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>) {
super({
name: "InvalidArgumentException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidArgumentException.prototype);
}
}
/**
* @public
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
* stream requests exceeds the maximum number allowed. </p>
*/
export class LimitExceededException extends __BaseException {
readonly name: "LimitExceededException" = "LimitExceededException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>) {
super({
name: "LimitExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, LimitExceededException.prototype);
}
}
/**
* @public
* <p>The resource is not available for this operation. For successful operation, the
* resource must be in the <code>ACTIVE</code> state.</p>
*/
export class ResourceInUseException extends __BaseException {
readonly name: "ResourceInUseException" = "ResourceInUseException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>) {
super({
name: "ResourceInUseException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceInUseException.prototype);
}
}
/**
* @public
* <p>The requested resource could not be found. The stream might not be specified
* correctly.</p>
*/
export class ResourceNotFoundException extends __BaseException {
readonly name: "ResourceNotFoundException" = "ResourceNotFoundException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) {
super({
name: "ResourceNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
}
}
/**
* @public
* <p>The range of possible hash key values for the shard, which is a set of ordered
* contiguous positive integers.</p>
*/
export interface HashKeyRange {
/**
* @public
* <p>The starting hash key of the hash key range.</p>
*/
StartingHashKey: string | undefined;
/**
* @public
* <p>The ending hash key of the hash key range.</p>
*/
EndingHashKey: string | undefined;
}
/**
* @public
* <p>Output parameter of the GetRecords API. The existing child shard of the current
* shard.</p>
*/
export interface ChildShard {
/**
* @public
* <p>The shard ID of the existing child shard of the current shard.</p>
*/
ShardId: string | undefined;
/**
* @public
* <p>The current shard that is the parent of the existing child shard.</p>
*/
ParentShards: string[] | undefined;
/**
* @public
* <p>The range of possible hash key values for the shard, which is a set of ordered
* contiguous positive integers.</p>
*/
HashKeyRange: HashKeyRange | undefined;
}
/**
* @public
* @enum
*/
export const ConsumerStatus = {
ACTIVE: "ACTIVE",
CREATING: "CREATING",
DELETING: "DELETING",
} as const;
/**
* @public
*/
export type ConsumerStatus = (typeof ConsumerStatus)[keyof typeof ConsumerStatus];
/**
* @public
* <p>An object that represents the details of the consumer you registered. This type of
* object is returned by <a>RegisterStreamConsumer</a>.</p>
*/
export interface Consumer {
/**
* @public
* <p>The name of the consumer is something you choose when you register the
* consumer.</p>
*/
ConsumerName: string | undefined;
/**
* @public
* <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
* this ARN to be able to call <a>SubscribeToShard</a>.</p>
* <p>If you delete a consumer and then create a new one with the same name, it won't have
* the same ARN. That's because consumer ARNs contain the creation timestamp. This is
* important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
*/
ConsumerARN: string | undefined;
/**
* @public
* <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
* states.</p>
*/
ConsumerStatus: ConsumerStatus | string | undefined;
/**
* @public
* <p></p>
*/
ConsumerCreationTimestamp: Date | undefined;
}
/**
* @public
* <p>An object that represents the details of a registered consumer. This type of object is
* returned by <a>DescribeStreamConsumer</a>.</p>
*/
export interface ConsumerDescription {
/**
* @public
* <p>The name of the consumer is something you choose when you register the
* consumer.</p>
*/
ConsumerName: string | undefined;
/**
* @public
* <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
* this ARN to be able to call <a>SubscribeToShard</a>.</p>
* <p>If you delete a consumer and then create a new one with the same name, it won't have
* the same ARN. That's because consumer ARNs contain the creation timestamp. This is
* important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
*/
ConsumerARN: string | undefined;
/**
* @public
* <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
* states.</p>
*/
ConsumerStatus: ConsumerStatus | string | undefined;
/**
* @public
* <p></p>
*/
ConsumerCreationTimestamp: Date | undefined;
/**
* @public
* <p>The ARN of the stream with which you registered the consumer.</p>
*/
StreamARN: string | undefined;
}
/**
* @public
* @enum
*/
export const StreamMode = {
ON_DEMAND: "ON_DEMAND",
PROVISIONED: "PROVISIONED",
} as const;
/**
* @public
*/
export type StreamMode = (typeof StreamMode)[keyof typeof StreamMode];
/**
* @public
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
*/
export interface StreamModeDetails {
/**
* @public
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
*/
StreamMode: StreamMode | string | undefined;
}
/**
* @public
* <p>Represents the input for <code>CreateStream</code>.</p>
*/
export interface CreateStreamInput {
/**
* @public
* <p>A name to identify the stream. The stream name is scoped to the Amazon Web Services
* account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts
* can have the same name. Two streams in the same Amazon Web Services account but in two
* different Regions can also have the same name.</p>
*/
StreamName: string | undefined;
/**
* @public
* <p>The number of shards that the stream will use. The throughput of the stream is a
* function of the number of shards; more shards are required for greater provisioned
* throughput.</p>
*/
ShardCount?: number;
/**
* @public
* <p> Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,
* you can choose between an <b>on-demand</b> capacity mode and a
* <b>provisioned</b> capacity mode for your data
* streams.</p>
*/
StreamModeDetails?: StreamModeDetails;
}
/**
* @public
* <p>Represents the input for <a>DecreaseStreamRetentionPeriod</a>.</p>
*/
export interface DecreaseStreamRetentionPeriodInput {
/**
* @public
* <p>The name of the stream to modify.</p>
*/
StreamName?: string;
/**
* @public
* <p>The new retention period of the stream, in hours. Must be less than the current
* retention period.</p>
*/
RetentionPeriodHours: number | undefined;
/**
* @public
* <p>The ARN of the stream.</p>
*/
StreamARN?: string;
}
/**
* @public
* <p>Represents the input for <a>DeleteStream</a>.</p>
*/
export interface DeleteStreamInput {
/**
* @public
* <p>The name of the stream to delete.</p>
*/
StreamName?: string;
/**
* @public
* <p>If this parameter is unset (<code>null</code>) or if you set it to <code>false</code>,
* and the stream has registered consumers, the call to <code>DeleteStream</code> fails
* with a <code>ResourceInUseException</code>. </p>
*/
EnforceConsumerDeletion?: boolean;
/**
* @public
* <p>The ARN of the stream.</p>
*/
StreamARN?: string;
}
/**
* @public
*/
export interface DeregisterStreamConsumerInput {
/**
* @public
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service
* Namespaces</a>.</p>
*/
StreamARN?: string;
/**
* @public
* <p>The name that you gave to the consumer.</p>
*/
ConsumerName?: string;
/**
* @public
* <p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you
* don't know the ARN of the consumer that you want to deregister, you can use the
* ListStreamConsumers operation to get a list of the descriptions of all the consumers
* that are currently registered with a given data stream. The description of a consumer
* contains its ARN.</p>
*/
ConsumerARN?: string;
}
/**
* @public
*/
export interface DescribeLimitsInput {}
/**
* @public
*/
export interface DescribeLimitsOutput {
/**
* @public
* <p>The maximum number of shards.</p>
*/
ShardLimit: number | undefined;
/**
* @public
* <p>The number of open shards.</p>
*/
OpenShardCount: number | undefined;
/**
* @public
* <p> Indicates the number of data streams with the on-demand capacity mode.</p>
*/
OnDemandStreamCount: number | undefined;
/**
* @public
* <p> The maximum number of data streams with the on-demand capacity mode. </p>
*/
OnDemandStreamCountLimit: number | undefined;
}
/**
* @public
* <p>Represents the input for <code>DescribeStream</code>.</p>
*/
export interface DescribeStreamInput {
/**
* @public
* <p>The name of the stream to describe.</p>
*/
StreamName?: string;
/**
* @public
* <p>The maximum number of shards to return in a single call. The default value is 100. If
* you specify a value greater than 100, at most 100 results are returned.</p>
*/
Limit?: number;
/**
* @public
* <p>The shard ID of the shard to start with.</p>
* <p>Specify this parameter to indicate that you want to describe the stream starting with
* the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
* <p>If you don't specify this parameter, the default behavior for
* <code>DescribeStream</code> is to describe the stream starting with the first shard
* in the stream.</p>
*/
ExclusiveStartShardId?: string;
/**
* @public
* <p>The ARN of the stream.</p>
*/
StreamARN?: string;
}
/**
* @public
* @enum
*/
export const EncryptionType = {
KMS: "KMS",
NONE: "NONE",
} as const;
/**
* @public
*/
export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
/**
* @public
* @enum
*/
export const MetricsName = {
ALL: "ALL",
INCOMING_BYTES: "IncomingBytes",
INCOMING_RECORDS: "IncomingRecords",
ITERATOR_AGE_MILLISECONDS: "IteratorAgeMilliseconds",
OUTGOING_BYTES: "OutgoingBytes",
OUTGOING_RECORDS: "OutgoingRecords",
READ_PROVISIONED_THROUGHPUT_EXCEEDED: "ReadProvisionedThroughputExceeded",
WRITE_PROVISIONED_THROUGHPUT_EXCEEDED: "WriteProvisionedThroughputExceeded",
} as const;
/**
* @public
*/
export type MetricsName = (typeof MetricsName)[keyof typeof MetricsName];
/**
* @public
* <p>Represents enhanced metrics types.</p>
*/
export interface EnhancedMetrics {
/**
* @public
* <p>List of shard-level metrics.</p>
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enhances
* every metric.</p>
* <ul>
* <li>
* <p>
* <code>IncomingBytes</code>
* </p>
* </li>
* <li>
* <p>
* <code>IncomingRecords</code>
* </p>
* </li>
* <li>
* <p>
* <code>OutgoingBytes</code>
* </p>
* </li>
* <li>
* <p>
* <code>OutgoingRecords</code>
* </p>
* </li>
* <li>
* <p>
* <code>WriteProvisionedThroughputExceeded</code>
* </p>
* </li>
* <li>
* <p>
* <code>ReadProvisionedThroughputExceeded</code>
* </p>
* </li>
* <li>
* <p>
* <code>IteratorAgeMilliseconds</code>
* </p>
* </li>
* <li>
* <p>
* <code>ALL</code>
* </p>
* </li>
* </ul>
* <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
* Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
* Kinesis Data Streams Developer Guide</i>.</p>
*/
ShardLevelMetrics?: (MetricsName | string)[];
}
/**
* @public
* <p>The range of possible sequence numbers for the shard.</p>
*/
export interface SequenceNumberRange {
/**
* @public
* <p>The starting sequence number for the range.</p>
*/
StartingSequenceNumber: string | undefined;
/**
* @public
* <p>The ending sequence number for the range. Shards that are in the OPEN state have an
* ending sequence number of <code>null</code>.</p>
*/
EndingSequenceNumber?: string;
}
/**
* @public
* <p>A uniquely identified group of data records in a Kinesis data stream.</p>
*/
export interface Shard {
/**
* @public
* <p>The unique identifier of the shard within the stream.</p>
*/
ShardId: string | undefined;
/**
* @public
* <p>The shard ID of the shard's parent.</p>
*/
ParentShardId?: string;
/**
* @public
* <p>The shard ID of the shard adjacent to the shard's parent.</p>
*/
AdjacentParentShardId?: string;
/**
* @public
* <p>The range of possible hash key values for the shard, which is a set of ordered
* contiguous positive integers.</p>
*/
HashKeyRange: HashKeyRange | undefined;
/**
* @public
* <p>The range of possible sequence numbers for the shard.</p>
*/
SequenceNumberRange: SequenceNumberRange | undefined;
}
/**
* @public
* @enum
*/
export const StreamStatus = {
ACTIVE: "ACTIVE",
CREATING: "CREATING",
DELETING: "DELETING",
UPDATING: "UPDATING",
} as const;
/**
* @public
*/
export type StreamStatus = (typeof StreamStatus)[keyof typeof StreamStatus];
/**
* @public
* <p>Represents the output for <a>DescribeStream</a>.</p>
*/
export interface StreamDescription {
/**
* @public
* <p>The name of the stream being described.</p>
*/
StreamName: string | undefined;
/**
* @public
* <p>The Amazon Resource Name (ARN) for the stream being described.</p>
*/
StreamARN: string | undefined;
/**
* @public
* <p>The current status of the stream being described. The stream status is one of the
* following states:</p>
* <ul>
* <li>
* <p>
* <code>CREATING</code> - The stream is being created. Kinesis Data Streams
* immediately returns and sets <code>StreamStatus</code> to
* <code>CREATING</code>.</p>
* </li>
* <li>
* <p>
* <code>DELETING</code> - The stream is being deleted. The specified stream is in
* the <code>DELETING</code> state until Kinesis Data Streams completes the
* deletion.</p>
* </li>
* <li>
* <p>
* <code>ACTIVE</code> - The stream exists and is ready for read and write
* operations or deletion. You should perform read and write operations only on an
* <code>ACTIVE</code> stream.</p>
* </li>
* <li>
* <p>
* <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
* write operations continue to work while the stream is in the
* <code>UPDATING</code> state.</p>
* </li>
* </ul>
*/
StreamStatus: StreamStatus | string | undefined;
/**
* @public
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
*/
StreamModeDetails?: StreamModeDetails;
/**
* @public
* <p>The shards that comprise the stream.</p>
*/
Shards: Shard[] | undefined;
/**
* @public
* <p>If set to <code>true</code>, more shards in the stream are available to
* describe.</p>
*/
HasMoreShards: boolean | undefined;
/**
* @public
* <p>The current retention period, in hours. Minimum value of 24. Maximum value of
* 168.</p>
*/
RetentionPeriodHours: number | undefined;
/**
* @public
* <p>The approximate time that the stream was created.</p>
*/
StreamCreationTimestamp: Date | undefined;
/**
* @public
* <p>Represents the current enhanced monitoring settings of the stream.</p>
*/
EnhancedMonitoring: EnhancedMetrics[] | undefined;
/**
* @public
* <p>The server-side encryption type used on the stream. This parameter can be one of the
* following values:</p>
* <ul>
* <li>
* <p>
* <code>NONE</code>: Do not encrypt the records in the stream.</p>
* </li>
* <li>
* <p>
* <code>KMS</code>: Use server-side encryption on the records in the stream
* using a customer-managed Amazon Web Services KMS key.</p>
* </li>
* </ul>
*/
EncryptionType?: EncryptionType | string;
/**
* @public
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
* This value can be a globally unique identifier, a fully specified ARN to either an alias
* or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
* Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
* <ul>
* <li>
* <p>Key ARN example:
* <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
* </p>
* </li>
* <li>
* <p>Alias ARN example:
* <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
* </p>
* </li>
* <li>
* <p>Globally unique key ID example:
* <code>12345678-1234-1234-1234-123456789012</code>
* </p>
* </li>
* <li>
* <p>Alias name example: <code>alias/MyAliasName</code>
* </p>
* </li>
* <li>
* <p>Master key owned by Kinesis Data Streams:
* <code>alias/aws/kinesis</code>
* </p>
* </li>
* </ul>
*/
KeyId?: string;
}
/**
* @public
* <p>Represents the output for <code>DescribeStream</code>.</p>
*/
export interface DescribeStreamOutput {
/**
* @public
* <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of
* shard objects that comprise the stream, and whether there are more shards
* available.</p>
*/
StreamDescription: StreamDescription | undefined;
}
/**
* @public
*/
export interface DescribeStreamConsumerInput {
/**
* @public
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service
* Namespaces</a>.</p>
*/
StreamARN?: string;
/**
* @public
* <p>The name that you gave to the consumer.</p>
*/
ConsumerName?: string;
/**
* @public
* <p>The ARN returned by Kinesis Data Streams when you registered the consumer.</p>
*/
ConsumerARN?: string;
}
/**
* @public
*/
export interface DescribeStreamConsumerOutput {
/**
* @public
* <p>An object that represents the details of the consumer.</p>
*/
ConsumerDescription: ConsumerDescription | undefined;
}
/**
* @public
*/
export interface DescribeStreamSummaryInput {
/**
* @public
* <p>The name of the stream to describe.</p>
*/
StreamName?: string;
/**
* @public
* <p>The ARN of the stream.</p>
*/
StreamARN?: string;
}
/**
* @public
* <p>Represents the output for <a>DescribeStreamSummary</a>
* </p>
*/
export interface StreamDescriptionSummary {
/**
* @public
* <p>The name of the stream being described.</p>
*/
StreamName: string | undefined;
/**
* @public
* <p>The Amazon Resource Name (ARN) for the stream being described.</p>
*/
StreamARN: string | undefined;
/**
* @public
* <p>The current status of the stream being described. The stream status is one of the
* following states:</p>
* <ul>
* <li>
* <p>
* <code>CREATING</code> - The stream is being created. Kinesis Data Streams
* immediately returns and sets <code>StreamStatus</code> to
* <code>CREATING</code>.</p>
* </li>
* <li>
* <p>
* <code>DELETING</code> - The stream is being deleted. The specified stream is in
* the <code>DELETING</code> state until Kinesis Data Streams completes the
* deletion.</p>
* </li>
* <li>
* <p>
* <code>ACTIVE</code> - The stream exists and is ready for read and write
* operations or deletion. You should perform read and write operations only on an
* <code>ACTIVE</code> stream.</p>
* </li>
* <li>
* <p>
* <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
* write operations continue to work while the stream is in the
* <code>UPDATING</code> state.</p>
* </li>
* </ul>
*/
StreamStatus: StreamStatus | string | undefined;
/**
* @public
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
* Kinesis Data Streams, you can choose between an <b>on-demand</b> ycapacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
*/
StreamModeDetails?: StreamModeDetails;
/**
* @public
* <p>The current retention period, in hours.</p>
*/
RetentionPeriodHours: number | undefined;
/**
* @public
* <p>The approximate time that the stream was created.</p>
*/
StreamCreationTimestamp: Date | undefined;
/**
* @public
* <p>Represents the current enhanced monitoring settings of the stream.</p>
*/
EnhancedMonitoring: EnhancedMetrics[] | undefined;
/**
* @public
* <p>The encryption type used. This value is one of the following:</p>
* <ul>
* <li>
* <p>
* <code>KMS</code>
* </p>
* </li>
* <li>
* <p>
* <code>NONE</code>
* </p>
* </li>
* </ul>
*/
EncryptionType?: EncryptionType | string;
/**
* @public
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
* This value can be a globally unique identifier, a fully specified ARN to either an alias
* or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
* Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
* <ul>
* <li>
* <p>Key ARN example:
* <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
* </p>
* </li>
* <li>
* <p>Alias ARN example: <code>
* arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
* </p>
* </li>
* <li>
* <p>Globally unique key ID example:
* <code>12345678-1234-1234-1234-123456789012</code>
* </p>
* </li>
* <li>
* <p>Alias name example: <code>alias/MyAliasName</code>
* </p>
* </li>
* <li>
* <p>Master key owned by Kinesis Data Streams:
* <code>alias/aws/kinesis</code>
* </p>
* </li>
* </ul>
*/
KeyId?: string;
/**
* @public
* <p>The number of open shards in the stream.</p>
*/
OpenShardCount: number | undefined;
/**
* @public
* <p>The number of enhanced fan-out consumers registered with the stream.</p>
*/
ConsumerCount?: number;
}