@aws-sdk/client-kinesis 3.379.1 → 3.382.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.
@@ -19,14 +19,17 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  */
20
20
  export interface AddTagsToStreamInput {
21
21
  /**
22
+ * @public
22
23
  * <p>The name of the stream.</p>
23
24
  */
24
25
  StreamName?: string;
25
26
  /**
27
+ * @public
26
28
  * <p>A set of up to 10 key-value pairs to use to create the tags.</p>
27
29
  */
28
30
  Tags: Record<string, string> | undefined;
29
31
  /**
32
+ * @public
30
33
  * <p>The ARN of the stream.</p>
31
34
  */
32
35
  StreamARN?: string;
@@ -90,10 +93,12 @@ export declare class ResourceNotFoundException extends __BaseException {
90
93
  */
91
94
  export interface HashKeyRange {
92
95
  /**
96
+ * @public
93
97
  * <p>The starting hash key of the hash key range.</p>
94
98
  */
95
99
  StartingHashKey: string | undefined;
96
100
  /**
101
+ * @public
97
102
  * <p>The ending hash key of the hash key range.</p>
98
103
  */
99
104
  EndingHashKey: string | undefined;
@@ -105,14 +110,17 @@ export interface HashKeyRange {
105
110
  */
106
111
  export interface ChildShard {
107
112
  /**
113
+ * @public
108
114
  * <p>The shard ID of the existing child shard of the current shard.</p>
109
115
  */
110
116
  ShardId: string | undefined;
111
117
  /**
118
+ * @public
112
119
  * <p>The current shard that is the parent of the existing child shard.</p>
113
120
  */
114
121
  ParentShards: string[] | undefined;
115
122
  /**
123
+ * @public
116
124
  * <p>The range of possible hash key values for the shard, which is a set of ordered
117
125
  * contiguous positive integers.</p>
118
126
  */
@@ -138,11 +146,13 @@ export type ConsumerStatus = (typeof ConsumerStatus)[keyof typeof ConsumerStatus
138
146
  */
139
147
  export interface Consumer {
140
148
  /**
149
+ * @public
141
150
  * <p>The name of the consumer is something you choose when you register the
142
151
  * consumer.</p>
143
152
  */
144
153
  ConsumerName: string | undefined;
145
154
  /**
155
+ * @public
146
156
  * <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
147
157
  * this ARN to be able to call <a>SubscribeToShard</a>.</p>
148
158
  * <p>If you delete a consumer and then create a new one with the same name, it won't have
@@ -151,11 +161,13 @@ export interface Consumer {
151
161
  */
152
162
  ConsumerARN: string | undefined;
153
163
  /**
164
+ * @public
154
165
  * <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
155
166
  * states.</p>
156
167
  */
157
168
  ConsumerStatus: ConsumerStatus | string | undefined;
158
169
  /**
170
+ * @public
159
171
  * <p></p>
160
172
  */
161
173
  ConsumerCreationTimestamp: Date | undefined;
@@ -167,11 +179,13 @@ export interface Consumer {
167
179
  */
168
180
  export interface ConsumerDescription {
169
181
  /**
182
+ * @public
170
183
  * <p>The name of the consumer is something you choose when you register the
171
184
  * consumer.</p>
172
185
  */
173
186
  ConsumerName: string | undefined;
174
187
  /**
188
+ * @public
175
189
  * <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
176
190
  * this ARN to be able to call <a>SubscribeToShard</a>.</p>
177
191
  * <p>If you delete a consumer and then create a new one with the same name, it won't have
@@ -180,15 +194,18 @@ export interface ConsumerDescription {
180
194
  */
181
195
  ConsumerARN: string | undefined;
182
196
  /**
197
+ * @public
183
198
  * <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
184
199
  * states.</p>
185
200
  */
186
201
  ConsumerStatus: ConsumerStatus | string | undefined;
187
202
  /**
203
+ * @public
188
204
  * <p></p>
189
205
  */
190
206
  ConsumerCreationTimestamp: Date | undefined;
191
207
  /**
208
+ * @public
192
209
  * <p>The ARN of the stream with which you registered the consumer.</p>
193
210
  */
194
211
  StreamARN: string | undefined;
@@ -212,6 +229,7 @@ export type StreamMode = (typeof StreamMode)[keyof typeof StreamMode];
212
229
  */
213
230
  export interface StreamModeDetails {
214
231
  /**
232
+ * @public
215
233
  * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
216
234
  * 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>
217
235
  */
@@ -223,6 +241,7 @@ export interface StreamModeDetails {
223
241
  */
224
242
  export interface CreateStreamInput {
225
243
  /**
244
+ * @public
226
245
  * <p>A name to identify the stream. The stream name is scoped to the Amazon Web Services
227
246
  * 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
228
247
  * can have the same name. Two streams in the same Amazon Web Services account but in two
@@ -230,12 +249,14 @@ export interface CreateStreamInput {
230
249
  */
231
250
  StreamName: string | undefined;
232
251
  /**
252
+ * @public
233
253
  * <p>The number of shards that the stream will use. The throughput of the stream is a
234
254
  * function of the number of shards; more shards are required for greater provisioned
235
255
  * throughput.</p>
236
256
  */
237
257
  ShardCount?: number;
238
258
  /**
259
+ * @public
239
260
  * <p> Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,
240
261
  * you can choose between an <b>on-demand</b> capacity mode and a
241
262
  * <b>provisioned</b> capacity mode for your data
@@ -249,15 +270,18 @@ export interface CreateStreamInput {
249
270
  */
250
271
  export interface DecreaseStreamRetentionPeriodInput {
251
272
  /**
273
+ * @public
252
274
  * <p>The name of the stream to modify.</p>
253
275
  */
254
276
  StreamName?: string;
255
277
  /**
278
+ * @public
256
279
  * <p>The new retention period of the stream, in hours. Must be less than the current
257
280
  * retention period.</p>
258
281
  */
259
282
  RetentionPeriodHours: number | undefined;
260
283
  /**
284
+ * @public
261
285
  * <p>The ARN of the stream.</p>
262
286
  */
263
287
  StreamARN?: string;
@@ -268,16 +292,19 @@ export interface DecreaseStreamRetentionPeriodInput {
268
292
  */
269
293
  export interface DeleteStreamInput {
270
294
  /**
295
+ * @public
271
296
  * <p>The name of the stream to delete.</p>
272
297
  */
273
298
  StreamName?: string;
274
299
  /**
300
+ * @public
275
301
  * <p>If this parameter is unset (<code>null</code>) or if you set it to <code>false</code>,
276
302
  * and the stream has registered consumers, the call to <code>DeleteStream</code> fails
277
303
  * with a <code>ResourceInUseException</code>. </p>
278
304
  */
279
305
  EnforceConsumerDeletion?: boolean;
280
306
  /**
307
+ * @public
281
308
  * <p>The ARN of the stream.</p>
282
309
  */
283
310
  StreamARN?: string;
@@ -287,16 +314,19 @@ export interface DeleteStreamInput {
287
314
  */
288
315
  export interface DeregisterStreamConsumerInput {
289
316
  /**
317
+ * @public
290
318
  * <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
291
319
  * 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
292
320
  * Namespaces</a>.</p>
293
321
  */
294
322
  StreamARN?: string;
295
323
  /**
324
+ * @public
296
325
  * <p>The name that you gave to the consumer.</p>
297
326
  */
298
327
  ConsumerName?: string;
299
328
  /**
329
+ * @public
300
330
  * <p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you
301
331
  * don't know the ARN of the consumer that you want to deregister, you can use the
302
332
  * ListStreamConsumers operation to get a list of the descriptions of all the consumers
@@ -315,18 +345,22 @@ export interface DescribeLimitsInput {
315
345
  */
316
346
  export interface DescribeLimitsOutput {
317
347
  /**
348
+ * @public
318
349
  * <p>The maximum number of shards.</p>
319
350
  */
320
351
  ShardLimit: number | undefined;
321
352
  /**
353
+ * @public
322
354
  * <p>The number of open shards.</p>
323
355
  */
324
356
  OpenShardCount: number | undefined;
325
357
  /**
358
+ * @public
326
359
  * <p> Indicates the number of data streams with the on-demand capacity mode.</p>
327
360
  */
328
361
  OnDemandStreamCount: number | undefined;
329
362
  /**
363
+ * @public
330
364
  * <p> The maximum number of data streams with the on-demand capacity mode. </p>
331
365
  */
332
366
  OnDemandStreamCountLimit: number | undefined;
@@ -337,15 +371,18 @@ export interface DescribeLimitsOutput {
337
371
  */
338
372
  export interface DescribeStreamInput {
339
373
  /**
374
+ * @public
340
375
  * <p>The name of the stream to describe.</p>
341
376
  */
342
377
  StreamName?: string;
343
378
  /**
379
+ * @public
344
380
  * <p>The maximum number of shards to return in a single call. The default value is 100. If
345
381
  * you specify a value greater than 100, at most 100 results are returned.</p>
346
382
  */
347
383
  Limit?: number;
348
384
  /**
385
+ * @public
349
386
  * <p>The shard ID of the shard to start with.</p>
350
387
  * <p>Specify this parameter to indicate that you want to describe the stream starting with
351
388
  * the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
@@ -355,6 +392,7 @@ export interface DescribeStreamInput {
355
392
  */
356
393
  ExclusiveStartShardId?: string;
357
394
  /**
395
+ * @public
358
396
  * <p>The ARN of the stream.</p>
359
397
  */
360
398
  StreamARN?: string;
@@ -395,6 +433,7 @@ export type MetricsName = (typeof MetricsName)[keyof typeof MetricsName];
395
433
  */
396
434
  export interface EnhancedMetrics {
397
435
  /**
436
+ * @public
398
437
  * <p>List of shard-level metrics.</p>
399
438
  * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enhances
400
439
  * every metric.</p>
@@ -452,10 +491,12 @@ export interface EnhancedMetrics {
452
491
  */
453
492
  export interface SequenceNumberRange {
454
493
  /**
494
+ * @public
455
495
  * <p>The starting sequence number for the range.</p>
456
496
  */
457
497
  StartingSequenceNumber: string | undefined;
458
498
  /**
499
+ * @public
459
500
  * <p>The ending sequence number for the range. Shards that are in the OPEN state have an
460
501
  * ending sequence number of <code>null</code>.</p>
461
502
  */
@@ -467,23 +508,28 @@ export interface SequenceNumberRange {
467
508
  */
468
509
  export interface Shard {
469
510
  /**
511
+ * @public
470
512
  * <p>The unique identifier of the shard within the stream.</p>
471
513
  */
472
514
  ShardId: string | undefined;
473
515
  /**
516
+ * @public
474
517
  * <p>The shard ID of the shard's parent.</p>
475
518
  */
476
519
  ParentShardId?: string;
477
520
  /**
521
+ * @public
478
522
  * <p>The shard ID of the shard adjacent to the shard's parent.</p>
479
523
  */
480
524
  AdjacentParentShardId?: string;
481
525
  /**
526
+ * @public
482
527
  * <p>The range of possible hash key values for the shard, which is a set of ordered
483
528
  * contiguous positive integers.</p>
484
529
  */
485
530
  HashKeyRange: HashKeyRange | undefined;
486
531
  /**
532
+ * @public
487
533
  * <p>The range of possible sequence numbers for the shard.</p>
488
534
  */
489
535
  SequenceNumberRange: SequenceNumberRange | undefined;
@@ -508,14 +554,17 @@ export type StreamStatus = (typeof StreamStatus)[keyof typeof StreamStatus];
508
554
  */
509
555
  export interface StreamDescription {
510
556
  /**
557
+ * @public
511
558
  * <p>The name of the stream being described.</p>
512
559
  */
513
560
  StreamName: string | undefined;
514
561
  /**
562
+ * @public
515
563
  * <p>The Amazon Resource Name (ARN) for the stream being described.</p>
516
564
  */
517
565
  StreamARN: string | undefined;
518
566
  /**
567
+ * @public
519
568
  * <p>The current status of the stream being described. The stream status is one of the
520
569
  * following states:</p>
521
570
  * <ul>
@@ -547,33 +596,40 @@ export interface StreamDescription {
547
596
  */
548
597
  StreamStatus: StreamStatus | string | undefined;
549
598
  /**
599
+ * @public
550
600
  * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
551
601
  * 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>
552
602
  */
553
603
  StreamModeDetails?: StreamModeDetails;
554
604
  /**
605
+ * @public
555
606
  * <p>The shards that comprise the stream.</p>
556
607
  */
557
608
  Shards: Shard[] | undefined;
558
609
  /**
610
+ * @public
559
611
  * <p>If set to <code>true</code>, more shards in the stream are available to
560
612
  * describe.</p>
561
613
  */
562
614
  HasMoreShards: boolean | undefined;
563
615
  /**
616
+ * @public
564
617
  * <p>The current retention period, in hours. Minimum value of 24. Maximum value of
565
618
  * 168.</p>
566
619
  */
567
620
  RetentionPeriodHours: number | undefined;
568
621
  /**
622
+ * @public
569
623
  * <p>The approximate time that the stream was created.</p>
570
624
  */
571
625
  StreamCreationTimestamp: Date | undefined;
572
626
  /**
627
+ * @public
573
628
  * <p>Represents the current enhanced monitoring settings of the stream.</p>
574
629
  */
575
630
  EnhancedMonitoring: EnhancedMetrics[] | undefined;
576
631
  /**
632
+ * @public
577
633
  * <p>The server-side encryption type used on the stream. This parameter can be one of the
578
634
  * following values:</p>
579
635
  * <ul>
@@ -590,6 +646,7 @@ export interface StreamDescription {
590
646
  */
591
647
  EncryptionType?: EncryptionType | string;
592
648
  /**
649
+ * @public
593
650
  * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
594
651
  * This value can be a globally unique identifier, a fully specified ARN to either an alias
595
652
  * or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
@@ -629,6 +686,7 @@ export interface StreamDescription {
629
686
  */
630
687
  export interface DescribeStreamOutput {
631
688
  /**
689
+ * @public
632
690
  * <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of
633
691
  * shard objects that comprise the stream, and whether there are more shards
634
692
  * available.</p>
@@ -640,16 +698,19 @@ export interface DescribeStreamOutput {
640
698
  */
641
699
  export interface DescribeStreamConsumerInput {
642
700
  /**
701
+ * @public
643
702
  * <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
644
703
  * 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
645
704
  * Namespaces</a>.</p>
646
705
  */
647
706
  StreamARN?: string;
648
707
  /**
708
+ * @public
649
709
  * <p>The name that you gave to the consumer.</p>
650
710
  */
651
711
  ConsumerName?: string;
652
712
  /**
713
+ * @public
653
714
  * <p>The ARN returned by Kinesis Data Streams when you registered the consumer.</p>
654
715
  */
655
716
  ConsumerARN?: string;
@@ -659,6 +720,7 @@ export interface DescribeStreamConsumerInput {
659
720
  */
660
721
  export interface DescribeStreamConsumerOutput {
661
722
  /**
723
+ * @public
662
724
  * <p>An object that represents the details of the consumer.</p>
663
725
  */
664
726
  ConsumerDescription: ConsumerDescription | undefined;
@@ -668,10 +730,12 @@ export interface DescribeStreamConsumerOutput {
668
730
  */
669
731
  export interface DescribeStreamSummaryInput {
670
732
  /**
733
+ * @public
671
734
  * <p>The name of the stream to describe.</p>
672
735
  */
673
736
  StreamName?: string;
674
737
  /**
738
+ * @public
675
739
  * <p>The ARN of the stream.</p>
676
740
  */
677
741
  StreamARN?: string;
@@ -683,14 +747,17 @@ export interface DescribeStreamSummaryInput {
683
747
  */
684
748
  export interface StreamDescriptionSummary {
685
749
  /**
750
+ * @public
686
751
  * <p>The name of the stream being described.</p>
687
752
  */
688
753
  StreamName: string | undefined;
689
754
  /**
755
+ * @public
690
756
  * <p>The Amazon Resource Name (ARN) for the stream being described.</p>
691
757
  */
692
758
  StreamARN: string | undefined;
693
759
  /**
760
+ * @public
694
761
  * <p>The current status of the stream being described. The stream status is one of the
695
762
  * following states:</p>
696
763
  * <ul>
@@ -722,23 +789,28 @@ export interface StreamDescriptionSummary {
722
789
  */
723
790
  StreamStatus: StreamStatus | string | undefined;
724
791
  /**
792
+ * @public
725
793
  * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
726
794
  * 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>
727
795
  */
728
796
  StreamModeDetails?: StreamModeDetails;
729
797
  /**
798
+ * @public
730
799
  * <p>The current retention period, in hours.</p>
731
800
  */
732
801
  RetentionPeriodHours: number | undefined;
733
802
  /**
803
+ * @public
734
804
  * <p>The approximate time that the stream was created.</p>
735
805
  */
736
806
  StreamCreationTimestamp: Date | undefined;
737
807
  /**
808
+ * @public
738
809
  * <p>Represents the current enhanced monitoring settings of the stream.</p>
739
810
  */
740
811
  EnhancedMonitoring: EnhancedMetrics[] | undefined;
741
812
  /**
813
+ * @public
742
814
  * <p>The encryption type used. This value is one of the following:</p>
743
815
  * <ul>
744
816
  * <li>
@@ -755,6 +827,7 @@ export interface StreamDescriptionSummary {
755
827
  */
756
828
  EncryptionType?: EncryptionType | string;
757
829
  /**
830
+ * @public
758
831
  * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
759
832
  * This value can be a globally unique identifier, a fully specified ARN to either an alias
760
833
  * or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
@@ -788,10 +861,12 @@ export interface StreamDescriptionSummary {
788
861
  */
789
862
  KeyId?: string;
790
863
  /**
864
+ * @public
791
865
  * <p>The number of open shards in the stream.</p>
792
866
  */
793
867
  OpenShardCount: number | undefined;
794
868
  /**
869
+ * @public
795
870
  * <p>The number of enhanced fan-out consumers registered with the stream.</p>
796
871
  */
797
872
  ConsumerCount?: number;
@@ -801,6 +876,7 @@ export interface StreamDescriptionSummary {
801
876
  */
802
877
  export interface DescribeStreamSummaryOutput {
803
878
  /**
879
+ * @public
804
880
  * <p>A <a>StreamDescriptionSummary</a> containing information about the
805
881
  * stream.</p>
806
882
  */
@@ -812,10 +888,12 @@ export interface DescribeStreamSummaryOutput {
812
888
  */
813
889
  export interface DisableEnhancedMonitoringInput {
814
890
  /**
891
+ * @public
815
892
  * <p>The name of the Kinesis data stream for which to disable enhanced monitoring.</p>
816
893
  */
817
894
  StreamName?: string;
818
895
  /**
896
+ * @public
819
897
  * <p>List of shard-level metrics to disable.</p>
820
898
  * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" disables
821
899
  * every metric.</p>
@@ -867,6 +945,7 @@ export interface DisableEnhancedMonitoringInput {
867
945
  */
868
946
  ShardLevelMetrics: (MetricsName | string)[] | undefined;
869
947
  /**
948
+ * @public
870
949
  * <p>The ARN of the stream.</p>
871
950
  */
872
951
  StreamARN?: string;
@@ -877,20 +956,24 @@ export interface DisableEnhancedMonitoringInput {
877
956
  */
878
957
  export interface EnhancedMonitoringOutput {
879
958
  /**
959
+ * @public
880
960
  * <p>The name of the Kinesis data stream.</p>
881
961
  */
882
962
  StreamName?: string;
883
963
  /**
964
+ * @public
884
965
  * <p>Represents the current state of the metrics that are in the enhanced state before the
885
966
  * operation.</p>
886
967
  */
887
968
  CurrentShardLevelMetrics?: (MetricsName | string)[];
888
969
  /**
970
+ * @public
889
971
  * <p>Represents the list of all the metrics that would be in the enhanced state after the
890
972
  * operation.</p>
891
973
  */
892
974
  DesiredShardLevelMetrics?: (MetricsName | string)[];
893
975
  /**
976
+ * @public
894
977
  * <p>The ARN of the stream.</p>
895
978
  */
896
979
  StreamARN?: string;
@@ -901,10 +984,12 @@ export interface EnhancedMonitoringOutput {
901
984
  */
902
985
  export interface EnableEnhancedMonitoringInput {
903
986
  /**
987
+ * @public
904
988
  * <p>The name of the stream for which to enable enhanced monitoring.</p>
905
989
  */
906
990
  StreamName?: string;
907
991
  /**
992
+ * @public
908
993
  * <p>List of shard-level metrics to enable.</p>
909
994
  * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enables
910
995
  * every metric.</p>
@@ -956,6 +1041,7 @@ export interface EnableEnhancedMonitoringInput {
956
1041
  */
957
1042
  ShardLevelMetrics: (MetricsName | string)[] | undefined;
958
1043
  /**
1044
+ * @public
959
1045
  * <p>The ARN of the stream.</p>
960
1046
  */
961
1047
  StreamARN?: string;
@@ -990,18 +1076,21 @@ export declare class ExpiredNextTokenException extends __BaseException {
990
1076
  */
991
1077
  export interface GetRecordsInput {
992
1078
  /**
1079
+ * @public
993
1080
  * <p>The position in the shard from which you want to start sequentially reading data
994
1081
  * records. A shard iterator specifies this position using the sequence number of a data
995
1082
  * record in the shard.</p>
996
1083
  */
997
1084
  ShardIterator: string | undefined;
998
1085
  /**
1086
+ * @public
999
1087
  * <p>The maximum number of records to return. Specify a value of up to 10,000. If you
1000
1088
  * specify a value that is greater than 10,000, <a>GetRecords</a> throws
1001
1089
  * <code>InvalidArgumentException</code>. The default value is 10,000.</p>
1002
1090
  */
1003
1091
  Limit?: number;
1004
1092
  /**
1093
+ * @public
1005
1094
  * <p>The ARN of the stream.</p>
1006
1095
  */
1007
1096
  StreamARN?: string;
@@ -1013,14 +1102,17 @@ export interface GetRecordsInput {
1013
1102
  */
1014
1103
  export interface _Record {
1015
1104
  /**
1105
+ * @public
1016
1106
  * <p>The unique identifier of the record within its shard.</p>
1017
1107
  */
1018
1108
  SequenceNumber: string | undefined;
1019
1109
  /**
1110
+ * @public
1020
1111
  * <p>The approximate time that the record was inserted into the stream.</p>
1021
1112
  */
1022
1113
  ApproximateArrivalTimestamp?: Date;
1023
1114
  /**
1115
+ * @public
1024
1116
  * <p>The data blob. The data in the blob is both opaque and immutable to Kinesis Data
1025
1117
  * Streams, which does not inspect, interpret, or change the data in the blob in any way.
1026
1118
  * When the data blob (the payload before base64-encoding) is added to the partition key
@@ -1028,10 +1120,12 @@ export interface _Record {
1028
1120
  */
1029
1121
  Data: Uint8Array | undefined;
1030
1122
  /**
1123
+ * @public
1031
1124
  * <p>Identifies which shard in the stream the data record is assigned to.</p>
1032
1125
  */
1033
1126
  PartitionKey: string | undefined;
1034
1127
  /**
1128
+ * @public
1035
1129
  * <p>The encryption type used on the record. This parameter can be one of the following
1036
1130
  * values:</p>
1037
1131
  * <ul>
@@ -1054,16 +1148,19 @@ export interface _Record {
1054
1148
  */
1055
1149
  export interface GetRecordsOutput {
1056
1150
  /**
1151
+ * @public
1057
1152
  * <p>The data records retrieved from the shard.</p>
1058
1153
  */
1059
1154
  Records: _Record[] | undefined;
1060
1155
  /**
1156
+ * @public
1061
1157
  * <p>The next position in the shard from which to start sequentially reading data records.
1062
1158
  * If set to <code>null</code>, the shard has been closed and the requested iterator does
1063
1159
  * not return any more data. </p>
1064
1160
  */
1065
1161
  NextShardIterator?: string;
1066
1162
  /**
1163
+ * @public
1067
1164
  * <p>The number of milliseconds the <a>GetRecords</a> response is from the tip
1068
1165
  * of the stream, indicating how far behind current time the consumer is. A value of zero
1069
1166
  * indicates that record processing is caught up, and there are no new records to process
@@ -1071,6 +1168,7 @@ export interface GetRecordsOutput {
1071
1168
  */
1072
1169
  MillisBehindLatest?: number;
1073
1170
  /**
1171
+ * @public
1074
1172
  * <p>The list of the current shard's child shards, returned in the <code>GetRecords</code>
1075
1173
  * API's response only when the end of the current shard is reached.</p>
1076
1174
  */
@@ -1194,14 +1292,17 @@ export type ShardIteratorType = (typeof ShardIteratorType)[keyof typeof ShardIte
1194
1292
  */
1195
1293
  export interface GetShardIteratorInput {
1196
1294
  /**
1295
+ * @public
1197
1296
  * <p>The name of the Amazon Kinesis data stream.</p>
1198
1297
  */
1199
1298
  StreamName?: string;
1200
1299
  /**
1300
+ * @public
1201
1301
  * <p>The shard ID of the Kinesis Data Streams shard to get the iterator for.</p>
1202
1302
  */
1203
1303
  ShardId: string | undefined;
1204
1304
  /**
1305
+ * @public
1205
1306
  * <p>Determines how the shard iterator is used to start reading data records from the
1206
1307
  * shard.</p>
1207
1308
  * <p>The following are the valid Amazon Kinesis shard iterator types:</p>
@@ -1232,11 +1333,13 @@ export interface GetShardIteratorInput {
1232
1333
  */
1233
1334
  ShardIteratorType: ShardIteratorType | string | undefined;
1234
1335
  /**
1336
+ * @public
1235
1337
  * <p>The sequence number of the data record in the shard from which to start reading. Used
1236
1338
  * with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.</p>
1237
1339
  */
1238
1340
  StartingSequenceNumber?: string;
1239
1341
  /**
1342
+ * @public
1240
1343
  * <p>The time stamp of the data record from which to start reading. Used with shard
1241
1344
  * iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in
1242
1345
  * milliseconds. For example, <code>2016-04-04T19:58:46.480-00:00</code> or
@@ -1247,6 +1350,7 @@ export interface GetShardIteratorInput {
1247
1350
  */
1248
1351
  Timestamp?: Date;
1249
1352
  /**
1353
+ * @public
1250
1354
  * <p>The ARN of the stream.</p>
1251
1355
  */
1252
1356
  StreamARN?: string;
@@ -1257,6 +1361,7 @@ export interface GetShardIteratorInput {
1257
1361
  */
1258
1362
  export interface GetShardIteratorOutput {
1259
1363
  /**
1364
+ * @public
1260
1365
  * <p>The position in the shard from which to start reading data records sequentially. A
1261
1366
  * shard iterator specifies this position using the sequence number of a data record in a
1262
1367
  * shard.</p>
@@ -1269,15 +1374,18 @@ export interface GetShardIteratorOutput {
1269
1374
  */
1270
1375
  export interface IncreaseStreamRetentionPeriodInput {
1271
1376
  /**
1377
+ * @public
1272
1378
  * <p>The name of the stream to modify.</p>
1273
1379
  */
1274
1380
  StreamName?: string;
1275
1381
  /**
1382
+ * @public
1276
1383
  * <p>The new retention period of the stream, in hours. Must be more than the current
1277
1384
  * retention period.</p>
1278
1385
  */
1279
1386
  RetentionPeriodHours: number | undefined;
1280
1387
  /**
1388
+ * @public
1281
1389
  * <p>The ARN of the stream.</p>
1282
1390
  */
1283
1391
  StreamARN?: string;
@@ -1318,6 +1426,7 @@ export type ShardFilterType = (typeof ShardFilterType)[keyof typeof ShardFilterT
1318
1426
  */
1319
1427
  export interface ShardFilter {
1320
1428
  /**
1429
+ * @public
1321
1430
  * <p>The shard type specified in the <code>ShardFilter</code> parameter. This is a required
1322
1431
  * property of the <code>ShardFilter</code> parameter.</p>
1323
1432
  * <p>You can specify the following valid values: </p>
@@ -1361,12 +1470,14 @@ export interface ShardFilter {
1361
1470
  */
1362
1471
  Type: ShardFilterType | string | undefined;
1363
1472
  /**
1473
+ * @public
1364
1474
  * <p>The exclusive start <code>shardID</code> speified in the <code>ShardFilter</code>
1365
1475
  * parameter. This property can only be used if the <code>AFTER_SHARD_ID</code> shard type
1366
1476
  * is specified.</p>
1367
1477
  */
1368
1478
  ShardId?: string;
1369
1479
  /**
1480
+ * @public
1370
1481
  * <p>The timestamps specified in the <code>ShardFilter</code> parameter. A timestamp is a
1371
1482
  * Unix epoch date with precision in milliseconds. For example,
1372
1483
  * 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if
@@ -1380,12 +1491,14 @@ export interface ShardFilter {
1380
1491
  */
1381
1492
  export interface ListShardsInput {
1382
1493
  /**
1494
+ * @public
1383
1495
  * <p>The name of the data stream whose shards you want to list. </p>
1384
1496
  * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1385
1497
  * parameter.</p>
1386
1498
  */
1387
1499
  StreamName?: string;
1388
1500
  /**
1501
+ * @public
1389
1502
  * <p>When the number of shards in the data stream is greater than the default value for the
1390
1503
  * <code>MaxResults</code> parameter, or if you explicitly specify a value for
1391
1504
  * <code>MaxResults</code> that is less than the number of shards in the data stream,
@@ -1410,6 +1523,7 @@ export interface ListShardsInput {
1410
1523
  */
1411
1524
  NextToken?: string;
1412
1525
  /**
1526
+ * @public
1413
1527
  * <p>Specify this parameter to indicate that you want to list the shards starting with the
1414
1528
  * shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
1415
1529
  * <p>If you don't specify this parameter, the default behavior is for
@@ -1419,6 +1533,7 @@ export interface ListShardsInput {
1419
1533
  */
1420
1534
  ExclusiveStartShardId?: string;
1421
1535
  /**
1536
+ * @public
1422
1537
  * <p>The maximum number of shards to return in a single call to <code>ListShards</code>.
1423
1538
  * The maximum number of shards to return in a single call. The default value is 1000. If
1424
1539
  * you specify a value greater than 1000, at most 1000 results are returned. </p>
@@ -1429,6 +1544,7 @@ export interface ListShardsInput {
1429
1544
  */
1430
1545
  MaxResults?: number;
1431
1546
  /**
1547
+ * @public
1432
1548
  * <p>Specify this input parameter to distinguish data streams that have the same name. For
1433
1549
  * example, if you create a data stream and then delete it, and you later create another
1434
1550
  * data stream with the same name, you can use this input parameter to specify which of the
@@ -1438,6 +1554,7 @@ export interface ListShardsInput {
1438
1554
  */
1439
1555
  StreamCreationTimestamp?: Date;
1440
1556
  /**
1557
+ * @public
1441
1558
  * <p>Enables you to filter out the response of the <code>ListShards</code> API. You can
1442
1559
  * only specify one filter at a time. </p>
1443
1560
  * <p>If you use the <code>ShardFilter</code> parameter when invoking the ListShards API,
@@ -1459,6 +1576,7 @@ export interface ListShardsInput {
1459
1576
  */
1460
1577
  ShardFilter?: ShardFilter;
1461
1578
  /**
1579
+ * @public
1462
1580
  * <p>The ARN of the stream.</p>
1463
1581
  */
1464
1582
  StreamARN?: string;
@@ -1468,6 +1586,7 @@ export interface ListShardsInput {
1468
1586
  */
1469
1587
  export interface ListShardsOutput {
1470
1588
  /**
1589
+ * @public
1471
1590
  * <p>An array of JSON objects. Each object represents one shard and specifies the IDs of
1472
1591
  * the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each
1473
1592
  * object also contains the starting and ending hash keys and the starting and ending
@@ -1475,6 +1594,7 @@ export interface ListShardsOutput {
1475
1594
  */
1476
1595
  Shards?: Shard[];
1477
1596
  /**
1597
+ * @public
1478
1598
  * <p>When the number of shards in the data stream is greater than the default value for the
1479
1599
  * <code>MaxResults</code> parameter, or if you explicitly specify a value for
1480
1600
  * <code>MaxResults</code> that is less than the number of shards in the data stream,
@@ -1496,12 +1616,14 @@ export interface ListShardsOutput {
1496
1616
  */
1497
1617
  export interface ListStreamConsumersInput {
1498
1618
  /**
1619
+ * @public
1499
1620
  * <p>The ARN of the Kinesis data stream for which you want to list the registered
1500
1621
  * consumers. 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
1501
1622
  * Namespaces</a>.</p>
1502
1623
  */
1503
1624
  StreamARN: string | undefined;
1504
1625
  /**
1626
+ * @public
1505
1627
  * <p>When the number of consumers that are registered with the data stream is greater than
1506
1628
  * the default value for the <code>MaxResults</code> parameter, or if you explicitly
1507
1629
  * specify a value for <code>MaxResults</code> that is less than the number of consumers
@@ -1528,12 +1650,14 @@ export interface ListStreamConsumersInput {
1528
1650
  */
1529
1651
  NextToken?: string;
1530
1652
  /**
1653
+ * @public
1531
1654
  * <p>The maximum number of consumers that you want a single call of
1532
1655
  * <code>ListStreamConsumers</code> to return. The default value is 100. If you specify
1533
1656
  * a value greater than 100, at most 100 results are returned. </p>
1534
1657
  */
1535
1658
  MaxResults?: number;
1536
1659
  /**
1660
+ * @public
1537
1661
  * <p>Specify this input parameter to distinguish data streams that have the same name. For
1538
1662
  * example, if you create a data stream and then delete it, and you later create another
1539
1663
  * data stream with the same name, you can use this input parameter to specify which of the
@@ -1547,10 +1671,12 @@ export interface ListStreamConsumersInput {
1547
1671
  */
1548
1672
  export interface ListStreamConsumersOutput {
1549
1673
  /**
1674
+ * @public
1550
1675
  * <p>An array of JSON objects. Each object represents one registered consumer.</p>
1551
1676
  */
1552
1677
  Consumers?: Consumer[];
1553
1678
  /**
1679
+ * @public
1554
1680
  * <p>When the number of consumers that are registered with the data stream is greater than
1555
1681
  * the default value for the <code>MaxResults</code> parameter, or if you explicitly
1556
1682
  * specify a value for <code>MaxResults</code> that is less than the number of registered
@@ -1575,15 +1701,18 @@ export interface ListStreamConsumersOutput {
1575
1701
  */
1576
1702
  export interface ListStreamsInput {
1577
1703
  /**
1704
+ * @public
1578
1705
  * <p>The maximum number of streams to list. The default value is 100. If you specify a
1579
1706
  * value greater than 100, at most 100 results are returned.</p>
1580
1707
  */
1581
1708
  Limit?: number;
1582
1709
  /**
1710
+ * @public
1583
1711
  * <p>The name of the stream to start the list with.</p>
1584
1712
  */
1585
1713
  ExclusiveStartStreamName?: string;
1586
1714
  /**
1715
+ * @public
1587
1716
  * <p></p>
1588
1717
  */
1589
1718
  NextToken?: string;
@@ -1594,23 +1723,28 @@ export interface ListStreamsInput {
1594
1723
  */
1595
1724
  export interface StreamSummary {
1596
1725
  /**
1726
+ * @public
1597
1727
  * <p>The name of a stream.</p>
1598
1728
  */
1599
1729
  StreamName: string | undefined;
1600
1730
  /**
1731
+ * @public
1601
1732
  * <p>The ARN of the stream.</p>
1602
1733
  */
1603
1734
  StreamARN: string | undefined;
1604
1735
  /**
1736
+ * @public
1605
1737
  * <p>The status of the stream.</p>
1606
1738
  */
1607
1739
  StreamStatus: StreamStatus | string | undefined;
1608
1740
  /**
1741
+ * @public
1609
1742
  * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
1610
1743
  * 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>
1611
1744
  */
1612
1745
  StreamModeDetails?: StreamModeDetails;
1613
1746
  /**
1747
+ * @public
1614
1748
  * <p>The timestamp at which the stream was created.</p>
1615
1749
  */
1616
1750
  StreamCreationTimestamp?: Date;
@@ -1621,19 +1755,23 @@ export interface StreamSummary {
1621
1755
  */
1622
1756
  export interface ListStreamsOutput {
1623
1757
  /**
1758
+ * @public
1624
1759
  * <p>The names of the streams that are associated with the Amazon Web Services account
1625
1760
  * making the <code>ListStreams</code> request.</p>
1626
1761
  */
1627
1762
  StreamNames: string[] | undefined;
1628
1763
  /**
1764
+ * @public
1629
1765
  * <p>If set to <code>true</code>, there are more streams available to list.</p>
1630
1766
  */
1631
1767
  HasMoreStreams: boolean | undefined;
1632
1768
  /**
1769
+ * @public
1633
1770
  * <p></p>
1634
1771
  */
1635
1772
  NextToken?: string;
1636
1773
  /**
1774
+ * @public
1637
1775
  * <p></p>
1638
1776
  */
1639
1777
  StreamSummaries?: StreamSummary[];
@@ -1644,16 +1782,19 @@ export interface ListStreamsOutput {
1644
1782
  */
1645
1783
  export interface ListTagsForStreamInput {
1646
1784
  /**
1785
+ * @public
1647
1786
  * <p>The name of the stream.</p>
1648
1787
  */
1649
1788
  StreamName?: string;
1650
1789
  /**
1790
+ * @public
1651
1791
  * <p>The key to use as the starting point for the list of tags. If this parameter is set,
1652
1792
  * <code>ListTagsForStream</code> gets all tags that occur after
1653
1793
  * <code>ExclusiveStartTagKey</code>. </p>
1654
1794
  */
1655
1795
  ExclusiveStartTagKey?: string;
1656
1796
  /**
1797
+ * @public
1657
1798
  * <p>The number of tags to return. If this number is less than the total number of tags
1658
1799
  * associated with the stream, <code>HasMoreTags</code> is set to <code>true</code>. To
1659
1800
  * list additional tags, set <code>ExclusiveStartTagKey</code> to the last key in the
@@ -1661,6 +1802,7 @@ export interface ListTagsForStreamInput {
1661
1802
  */
1662
1803
  Limit?: number;
1663
1804
  /**
1805
+ * @public
1664
1806
  * <p>The ARN of the stream.</p>
1665
1807
  */
1666
1808
  StreamARN?: string;
@@ -1671,11 +1813,13 @@ export interface ListTagsForStreamInput {
1671
1813
  */
1672
1814
  export interface Tag {
1673
1815
  /**
1816
+ * @public
1674
1817
  * <p>A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
1675
1818
  * Unicode letters, digits, white space, _ . / = + - % @</p>
1676
1819
  */
1677
1820
  Key: string | undefined;
1678
1821
  /**
1822
+ * @public
1679
1823
  * <p>An optional string, typically used to describe or define the tag. Maximum length: 256
1680
1824
  * characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
1681
1825
  * @</p>
@@ -1688,12 +1832,14 @@ export interface Tag {
1688
1832
  */
1689
1833
  export interface ListTagsForStreamOutput {
1690
1834
  /**
1835
+ * @public
1691
1836
  * <p>A list of tags associated with <code>StreamName</code>, starting with the first tag
1692
1837
  * after <code>ExclusiveStartTagKey</code> and up to the specified <code>Limit</code>.
1693
1838
  * </p>
1694
1839
  */
1695
1840
  Tags: Tag[] | undefined;
1696
1841
  /**
1842
+ * @public
1697
1843
  * <p>If set to <code>true</code>, more tags are available. To request additional tags, set
1698
1844
  * <code>ExclusiveStartTagKey</code> to the key of the last tag returned.</p>
1699
1845
  */
@@ -1705,18 +1851,22 @@ export interface ListTagsForStreamOutput {
1705
1851
  */
1706
1852
  export interface MergeShardsInput {
1707
1853
  /**
1854
+ * @public
1708
1855
  * <p>The name of the stream for the merge.</p>
1709
1856
  */
1710
1857
  StreamName?: string;
1711
1858
  /**
1859
+ * @public
1712
1860
  * <p>The shard ID of the shard to combine with the adjacent shard for the merge.</p>
1713
1861
  */
1714
1862
  ShardToMerge: string | undefined;
1715
1863
  /**
1864
+ * @public
1716
1865
  * <p>The shard ID of the adjacent shard for the merge.</p>
1717
1866
  */
1718
1867
  AdjacentShardToMerge: string | undefined;
1719
1868
  /**
1869
+ * @public
1720
1870
  * <p>The ARN of the stream.</p>
1721
1871
  */
1722
1872
  StreamARN?: string;
@@ -1741,10 +1891,12 @@ export declare class ValidationException extends __BaseException {
1741
1891
  */
1742
1892
  export interface PutRecordInput {
1743
1893
  /**
1894
+ * @public
1744
1895
  * <p>The name of the stream to put the data record into.</p>
1745
1896
  */
1746
1897
  StreamName?: string;
1747
1898
  /**
1899
+ * @public
1748
1900
  * <p>The data blob to put into the record, which is base64-encoded when the blob is
1749
1901
  * serialized. When the data blob (the payload before base64-encoding) is added to the
1750
1902
  * partition key size, the total size must not exceed the maximum record size (1
@@ -1752,6 +1904,7 @@ export interface PutRecordInput {
1752
1904
  */
1753
1905
  Data: Uint8Array | undefined;
1754
1906
  /**
1907
+ * @public
1755
1908
  * <p>Determines which shard in the stream the data record is assigned to. Partition keys
1756
1909
  * are Unicode strings with a maximum length limit of 256 characters for each key. Amazon
1757
1910
  * Kinesis Data Streams uses the partition key as input to a hash function that maps the
@@ -1762,11 +1915,13 @@ export interface PutRecordInput {
1762
1915
  */
1763
1916
  PartitionKey: string | undefined;
1764
1917
  /**
1918
+ * @public
1765
1919
  * <p>The hash value used to explicitly determine the shard the data record is assigned to
1766
1920
  * by overriding the partition key hash.</p>
1767
1921
  */
1768
1922
  ExplicitHashKey?: string;
1769
1923
  /**
1924
+ * @public
1770
1925
  * <p>Guarantees strictly increasing sequence numbers, for puts from the same client and to
1771
1926
  * the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of record
1772
1927
  * <i>n</i> to the sequence number of record <i>n-1</i> (as
@@ -1775,6 +1930,7 @@ export interface PutRecordInput {
1775
1930
  */
1776
1931
  SequenceNumberForOrdering?: string;
1777
1932
  /**
1933
+ * @public
1778
1934
  * <p>The ARN of the stream.</p>
1779
1935
  */
1780
1936
  StreamARN?: string;
@@ -1785,16 +1941,19 @@ export interface PutRecordInput {
1785
1941
  */
1786
1942
  export interface PutRecordOutput {
1787
1943
  /**
1944
+ * @public
1788
1945
  * <p>The shard ID of the shard where the data record was placed.</p>
1789
1946
  */
1790
1947
  ShardId: string | undefined;
1791
1948
  /**
1949
+ * @public
1792
1950
  * <p>The sequence number identifier that was assigned to the put data record. The sequence
1793
1951
  * number for the record is unique across all records in the stream. A sequence number is
1794
1952
  * the identifier associated with every record put into the stream.</p>
1795
1953
  */
1796
1954
  SequenceNumber: string | undefined;
1797
1955
  /**
1956
+ * @public
1798
1957
  * <p>The encryption type to use on the record. This parameter can be one of the following
1799
1958
  * values:</p>
1800
1959
  * <ul>
@@ -1817,6 +1976,7 @@ export interface PutRecordOutput {
1817
1976
  */
1818
1977
  export interface PutRecordsRequestEntry {
1819
1978
  /**
1979
+ * @public
1820
1980
  * <p>The data blob to put into the record, which is base64-encoded when the blob is
1821
1981
  * serialized. When the data blob (the payload before base64-encoding) is added to the
1822
1982
  * partition key size, the total size must not exceed the maximum record size (1
@@ -1824,11 +1984,13 @@ export interface PutRecordsRequestEntry {
1824
1984
  */
1825
1985
  Data: Uint8Array | undefined;
1826
1986
  /**
1987
+ * @public
1827
1988
  * <p>The hash value used to determine explicitly the shard that the data record is assigned
1828
1989
  * to by overriding the partition key hash.</p>
1829
1990
  */
1830
1991
  ExplicitHashKey?: string;
1831
1992
  /**
1993
+ * @public
1832
1994
  * <p>Determines which shard in the stream the data record is assigned to. Partition keys
1833
1995
  * are Unicode strings with a maximum length limit of 256 characters for each key. Amazon
1834
1996
  * Kinesis Data Streams uses the partition key as input to a hash function that maps the
@@ -1845,14 +2007,17 @@ export interface PutRecordsRequestEntry {
1845
2007
  */
1846
2008
  export interface PutRecordsInput {
1847
2009
  /**
2010
+ * @public
1848
2011
  * <p>The records associated with the request.</p>
1849
2012
  */
1850
2013
  Records: PutRecordsRequestEntry[] | undefined;
1851
2014
  /**
2015
+ * @public
1852
2016
  * <p>The stream name associated with the request.</p>
1853
2017
  */
1854
2018
  StreamName?: string;
1855
2019
  /**
2020
+ * @public
1856
2021
  * <p>The ARN of the stream.</p>
1857
2022
  */
1858
2023
  StreamARN?: string;
@@ -1866,20 +2031,24 @@ export interface PutRecordsInput {
1866
2031
  */
1867
2032
  export interface PutRecordsResultEntry {
1868
2033
  /**
2034
+ * @public
1869
2035
  * <p>The sequence number for an individual record result.</p>
1870
2036
  */
1871
2037
  SequenceNumber?: string;
1872
2038
  /**
2039
+ * @public
1873
2040
  * <p>The shard ID for an individual record result.</p>
1874
2041
  */
1875
2042
  ShardId?: string;
1876
2043
  /**
2044
+ * @public
1877
2045
  * <p>The error code for an individual record result. <code>ErrorCodes</code> can be either
1878
2046
  * <code>ProvisionedThroughputExceededException</code> or
1879
2047
  * <code>InternalFailure</code>.</p>
1880
2048
  */
1881
2049
  ErrorCode?: string;
1882
2050
  /**
2051
+ * @public
1883
2052
  * <p>The error message for an individual record result. An <code>ErrorCode</code> value of
1884
2053
  * <code>ProvisionedThroughputExceededException</code> has an error message that
1885
2054
  * includes the account ID, stream name, and shard ID. An <code>ErrorCode</code> value of
@@ -1895,11 +2064,13 @@ export interface PutRecordsResultEntry {
1895
2064
  */
1896
2065
  export interface PutRecordsOutput {
1897
2066
  /**
2067
+ * @public
1898
2068
  * <p>The number of unsuccessfully processed records in a <code>PutRecords</code>
1899
2069
  * request.</p>
1900
2070
  */
1901
2071
  FailedRecordCount?: number;
1902
2072
  /**
2073
+ * @public
1903
2074
  * <p>An array of successfully and unsuccessfully processed record results. A record that is
1904
2075
  * successfully added to a stream includes <code>SequenceNumber</code> and
1905
2076
  * <code>ShardId</code> in the result. A record that fails to be added to a stream
@@ -1907,6 +2078,7 @@ export interface PutRecordsOutput {
1907
2078
  */
1908
2079
  Records: PutRecordsResultEntry[] | undefined;
1909
2080
  /**
2081
+ * @public
1910
2082
  * <p>The encryption type used on the records. This parameter can be one of the following
1911
2083
  * values:</p>
1912
2084
  * <ul>
@@ -1928,12 +2100,14 @@ export interface PutRecordsOutput {
1928
2100
  */
1929
2101
  export interface RegisterStreamConsumerInput {
1930
2102
  /**
2103
+ * @public
1931
2104
  * <p>The ARN of the Kinesis data stream that you want to register the consumer with. For
1932
2105
  * more info, 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
1933
2106
  * Namespaces</a>.</p>
1934
2107
  */
1935
2108
  StreamARN: string | undefined;
1936
2109
  /**
2110
+ * @public
1937
2111
  * <p>For a given Kinesis data stream, each consumer must have a unique name. However,
1938
2112
  * consumer names don't have to be unique across data streams.</p>
1939
2113
  */
@@ -1944,6 +2118,7 @@ export interface RegisterStreamConsumerInput {
1944
2118
  */
1945
2119
  export interface RegisterStreamConsumerOutput {
1946
2120
  /**
2121
+ * @public
1947
2122
  * <p>An object that represents the details of the consumer you registered. When you
1948
2123
  * register a consumer, it gets an ARN that is generated by Kinesis Data Streams.</p>
1949
2124
  */
@@ -1955,14 +2130,17 @@ export interface RegisterStreamConsumerOutput {
1955
2130
  */
1956
2131
  export interface RemoveTagsFromStreamInput {
1957
2132
  /**
2133
+ * @public
1958
2134
  * <p>The name of the stream.</p>
1959
2135
  */
1960
2136
  StreamName?: string;
1961
2137
  /**
2138
+ * @public
1962
2139
  * <p>A list of tag keys. Each corresponding tag is removed from the stream.</p>
1963
2140
  */
1964
2141
  TagKeys: string[] | undefined;
1965
2142
  /**
2143
+ * @public
1966
2144
  * <p>The ARN of the stream.</p>
1967
2145
  */
1968
2146
  StreamARN?: string;
@@ -1973,14 +2151,17 @@ export interface RemoveTagsFromStreamInput {
1973
2151
  */
1974
2152
  export interface SplitShardInput {
1975
2153
  /**
2154
+ * @public
1976
2155
  * <p>The name of the stream for the shard split.</p>
1977
2156
  */
1978
2157
  StreamName?: string;
1979
2158
  /**
2159
+ * @public
1980
2160
  * <p>The shard ID of the shard to split.</p>
1981
2161
  */
1982
2162
  ShardToSplit: string | undefined;
1983
2163
  /**
2164
+ * @public
1984
2165
  * <p>A hash key value for the starting hash key of one of the child shards created by the
1985
2166
  * split. The hash key range for a given shard constitutes a set of ordered contiguous
1986
2167
  * positive integers. The value for <code>NewStartingHashKey</code> must be in the range of
@@ -1991,6 +2172,7 @@ export interface SplitShardInput {
1991
2172
  */
1992
2173
  NewStartingHashKey: string | undefined;
1993
2174
  /**
2175
+ * @public
1994
2176
  * <p>The ARN of the stream.</p>
1995
2177
  */
1996
2178
  StreamARN?: string;
@@ -2000,14 +2182,17 @@ export interface SplitShardInput {
2000
2182
  */
2001
2183
  export interface StartStreamEncryptionInput {
2002
2184
  /**
2185
+ * @public
2003
2186
  * <p>The name of the stream for which to start encrypting records.</p>
2004
2187
  */
2005
2188
  StreamName?: string;
2006
2189
  /**
2190
+ * @public
2007
2191
  * <p>The encryption type to use. The only valid value is <code>KMS</code>.</p>
2008
2192
  */
2009
2193
  EncryptionType: EncryptionType | string | undefined;
2010
2194
  /**
2195
+ * @public
2011
2196
  * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
2012
2197
  * This value can be a globally unique identifier, a fully specified Amazon Resource Name
2013
2198
  * (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
@@ -2042,6 +2227,7 @@ export interface StartStreamEncryptionInput {
2042
2227
  */
2043
2228
  KeyId: string | undefined;
2044
2229
  /**
2230
+ * @public
2045
2231
  * <p>The ARN of the stream.</p>
2046
2232
  */
2047
2233
  StreamARN?: string;
@@ -2051,14 +2237,17 @@ export interface StartStreamEncryptionInput {
2051
2237
  */
2052
2238
  export interface StopStreamEncryptionInput {
2053
2239
  /**
2240
+ * @public
2054
2241
  * <p>The name of the stream on which to stop encrypting records.</p>
2055
2242
  */
2056
2243
  StreamName?: string;
2057
2244
  /**
2245
+ * @public
2058
2246
  * <p>The encryption type. The only valid value is <code>KMS</code>.</p>
2059
2247
  */
2060
2248
  EncryptionType: EncryptionType | string | undefined;
2061
2249
  /**
2250
+ * @public
2062
2251
  * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
2063
2252
  * This value can be a globally unique identifier, a fully specified Amazon Resource Name
2064
2253
  * (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
@@ -2093,6 +2282,7 @@ export interface StopStreamEncryptionInput {
2093
2282
  */
2094
2283
  KeyId: string | undefined;
2095
2284
  /**
2285
+ * @public
2096
2286
  * <p>The ARN of the stream.</p>
2097
2287
  */
2098
2288
  StreamARN?: string;
@@ -2103,6 +2293,7 @@ export interface StopStreamEncryptionInput {
2103
2293
  */
2104
2294
  export interface StartingPosition {
2105
2295
  /**
2296
+ * @public
2106
2297
  * <p>You can set the starting position to one of the following values:</p>
2107
2298
  * <p>
2108
2299
  * <code>AT_SEQUENCE_NUMBER</code>: Start streaming from the position denoted by the
@@ -2122,12 +2313,14 @@ export interface StartingPosition {
2122
2313
  */
2123
2314
  Type: ShardIteratorType | string | undefined;
2124
2315
  /**
2316
+ * @public
2125
2317
  * <p>The sequence number of the data record in the shard from which to start streaming. To
2126
2318
  * specify a sequence number, set <code>StartingPosition</code> to
2127
2319
  * <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>.</p>
2128
2320
  */
2129
2321
  SequenceNumber?: string;
2130
2322
  /**
2323
+ * @public
2131
2324
  * <p>The time stamp of the data record from which to start reading. To specify a time
2132
2325
  * stamp, set <code>StartingPosition</code> to <code>Type AT_TIMESTAMP</code>. A time stamp
2133
2326
  * is the Unix epoch date with precision in milliseconds. For example,
@@ -2143,15 +2336,18 @@ export interface StartingPosition {
2143
2336
  */
2144
2337
  export interface SubscribeToShardInput {
2145
2338
  /**
2339
+ * @public
2146
2340
  * <p>For this parameter, use the value you obtained when you called <a>RegisterStreamConsumer</a>.</p>
2147
2341
  */
2148
2342
  ConsumerARN: string | undefined;
2149
2343
  /**
2344
+ * @public
2150
2345
  * <p>The ID of the shard you want to subscribe to. To see a list of all the shards for a
2151
2346
  * given stream, use <a>ListShards</a>.</p>
2152
2347
  */
2153
2348
  ShardId: string | undefined;
2154
2349
  /**
2350
+ * @public
2155
2351
  * <p>The starting position in the data stream from which to start streaming.</p>
2156
2352
  */
2157
2353
  StartingPosition: StartingPosition | undefined;
@@ -2163,10 +2359,12 @@ export interface SubscribeToShardInput {
2163
2359
  */
2164
2360
  export interface SubscribeToShardEvent {
2165
2361
  /**
2362
+ * @public
2166
2363
  * <p></p>
2167
2364
  */
2168
2365
  Records: _Record[] | undefined;
2169
2366
  /**
2367
+ * @public
2170
2368
  * <p>Use this as <code>SequenceNumber</code> in the next call to <a>SubscribeToShard</a>, with <code>StartingPosition</code> set to
2171
2369
  * <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>. Use
2172
2370
  * <code>ContinuationSequenceNumber</code> for checkpointing because it captures your
@@ -2174,12 +2372,14 @@ export interface SubscribeToShardEvent {
2174
2372
  */
2175
2373
  ContinuationSequenceNumber: string | undefined;
2176
2374
  /**
2375
+ * @public
2177
2376
  * <p>The number of milliseconds the read records are from the tip of the stream, indicating
2178
2377
  * how far behind current time the consumer is. A value of zero indicates that record
2179
2378
  * processing is caught up, and there are no new records to process at this moment.</p>
2180
2379
  */
2181
2380
  MillisBehindLatest: number | undefined;
2182
2381
  /**
2382
+ * @public
2183
2383
  * <p>The list of the child shards of the current shard, returned only at the end of the
2184
2384
  * current shard.</p>
2185
2385
  */
@@ -2196,6 +2396,7 @@ export type SubscribeToShardEventStream = SubscribeToShardEventStream.InternalFa
2196
2396
  */
2197
2397
  export declare namespace SubscribeToShardEventStream {
2198
2398
  /**
2399
+ * @public
2199
2400
  * <p>After you call <a>SubscribeToShard</a>, Kinesis Data Streams sends events
2200
2401
  * of this type to your consumer. For an example of how to handle these events, see <a href="/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
2201
2402
  * Using the Kinesis Data Streams API</a>.</p>
@@ -2214,6 +2415,7 @@ export declare namespace SubscribeToShardEventStream {
2214
2415
  $unknown?: never;
2215
2416
  }
2216
2417
  /**
2418
+ * @public
2217
2419
  * <p>The requested resource could not be found. The stream might not be specified
2218
2420
  * correctly.</p>
2219
2421
  */
@@ -2231,6 +2433,7 @@ export declare namespace SubscribeToShardEventStream {
2231
2433
  $unknown?: never;
2232
2434
  }
2233
2435
  /**
2436
+ * @public
2234
2437
  * <p>The resource is not available for this operation. For successful operation, the
2235
2438
  * resource must be in the <code>ACTIVE</code> state.</p>
2236
2439
  */
@@ -2248,6 +2451,7 @@ export declare namespace SubscribeToShardEventStream {
2248
2451
  $unknown?: never;
2249
2452
  }
2250
2453
  /**
2454
+ * @public
2251
2455
  * <p>The request was rejected because the specified customer master key (CMK) isn't
2252
2456
  * enabled.</p>
2253
2457
  */
@@ -2265,6 +2469,7 @@ export declare namespace SubscribeToShardEventStream {
2265
2469
  $unknown?: never;
2266
2470
  }
2267
2471
  /**
2472
+ * @public
2268
2473
  * <p>The request was rejected because the state of the specified resource isn't valid for
2269
2474
  * this request. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a
2270
2475
  * Customer Master Key</a> in the <i>Amazon Web Services Key Management
@@ -2284,6 +2489,7 @@ export declare namespace SubscribeToShardEventStream {
2284
2489
  $unknown?: never;
2285
2490
  }
2286
2491
  /**
2492
+ * @public
2287
2493
  * <p>The ciphertext references a key that doesn't exist or that you don't have access
2288
2494
  * to.</p>
2289
2495
  */
@@ -2301,6 +2507,7 @@ export declare namespace SubscribeToShardEventStream {
2301
2507
  $unknown?: never;
2302
2508
  }
2303
2509
  /**
2510
+ * @public
2304
2511
  * <p>The request was rejected because the specified entity or resource can't be
2305
2512
  * found.</p>
2306
2513
  */
@@ -2318,6 +2525,7 @@ export declare namespace SubscribeToShardEventStream {
2318
2525
  $unknown?: never;
2319
2526
  }
2320
2527
  /**
2528
+ * @public
2321
2529
  * <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
2322
2530
  */
2323
2531
  interface KMSOptInRequiredMember {
@@ -2334,6 +2542,7 @@ export declare namespace SubscribeToShardEventStream {
2334
2542
  $unknown?: never;
2335
2543
  }
2336
2544
  /**
2545
+ * @public
2337
2546
  * <p>The request was denied due to request throttling. For more information about
2338
2547
  * throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
2339
2548
  * the <i>Amazon Web Services Key Management Service Developer
@@ -2353,6 +2562,7 @@ export declare namespace SubscribeToShardEventStream {
2353
2562
  $unknown?: never;
2354
2563
  }
2355
2564
  /**
2565
+ * @public
2356
2566
  * <p>The processing of the request failed because of an unknown error, exception, or
2357
2567
  * failure.</p>
2358
2568
  */
@@ -2369,6 +2579,9 @@ export declare namespace SubscribeToShardEventStream {
2369
2579
  InternalFailureException: InternalFailureException;
2370
2580
  $unknown?: never;
2371
2581
  }
2582
+ /**
2583
+ * @public
2584
+ */
2372
2585
  interface $UnknownMember {
2373
2586
  SubscribeToShardEvent?: never;
2374
2587
  ResourceNotFoundException?: never;
@@ -2402,6 +2615,7 @@ export declare namespace SubscribeToShardEventStream {
2402
2615
  */
2403
2616
  export interface SubscribeToShardOutput {
2404
2617
  /**
2618
+ * @public
2405
2619
  * <p>The event stream that your consumer can use to read records from the shard.</p>
2406
2620
  */
2407
2621
  EventStream: AsyncIterable<SubscribeToShardEventStream> | undefined;
@@ -2422,10 +2636,12 @@ export type ScalingType = (typeof ScalingType)[keyof typeof ScalingType];
2422
2636
  */
2423
2637
  export interface UpdateShardCountInput {
2424
2638
  /**
2639
+ * @public
2425
2640
  * <p>The name of the stream.</p>
2426
2641
  */
2427
2642
  StreamName?: string;
2428
2643
  /**
2644
+ * @public
2429
2645
  * <p>The new number of shards. This value has the following default limits. By default, you
2430
2646
  * cannot do the following: </p>
2431
2647
  * <ul>
@@ -2449,10 +2665,12 @@ export interface UpdateShardCountInput {
2449
2665
  */
2450
2666
  TargetShardCount: number | undefined;
2451
2667
  /**
2668
+ * @public
2452
2669
  * <p>The scaling type. Uniform scaling creates shards of equal size.</p>
2453
2670
  */
2454
2671
  ScalingType: ScalingType | string | undefined;
2455
2672
  /**
2673
+ * @public
2456
2674
  * <p>The ARN of the stream.</p>
2457
2675
  */
2458
2676
  StreamARN?: string;
@@ -2462,18 +2680,22 @@ export interface UpdateShardCountInput {
2462
2680
  */
2463
2681
  export interface UpdateShardCountOutput {
2464
2682
  /**
2683
+ * @public
2465
2684
  * <p>The name of the stream.</p>
2466
2685
  */
2467
2686
  StreamName?: string;
2468
2687
  /**
2688
+ * @public
2469
2689
  * <p>The current number of shards.</p>
2470
2690
  */
2471
2691
  CurrentShardCount?: number;
2472
2692
  /**
2693
+ * @public
2473
2694
  * <p>The updated number of shards.</p>
2474
2695
  */
2475
2696
  TargetShardCount?: number;
2476
2697
  /**
2698
+ * @public
2477
2699
  * <p>The ARN of the stream.</p>
2478
2700
  */
2479
2701
  StreamARN?: string;
@@ -2483,10 +2705,12 @@ export interface UpdateShardCountOutput {
2483
2705
  */
2484
2706
  export interface UpdateStreamModeInput {
2485
2707
  /**
2708
+ * @public
2486
2709
  * <p> Specifies the ARN of the data stream whose capacity mode you want to update. </p>
2487
2710
  */
2488
2711
  StreamARN: string | undefined;
2489
2712
  /**
2713
+ * @public
2490
2714
  * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
2491
2715
  * 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>
2492
2716
  */