@aws-sdk/client-kinesis 3.231.0 → 3.232.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.
Files changed (101) hide show
  1. package/dist-cjs/commands/AddTagsToStreamCommand.js +2 -0
  2. package/dist-cjs/commands/DecreaseStreamRetentionPeriodCommand.js +2 -0
  3. package/dist-cjs/commands/DeleteStreamCommand.js +2 -0
  4. package/dist-cjs/commands/DeregisterStreamConsumerCommand.js +3 -0
  5. package/dist-cjs/commands/DescribeStreamCommand.js +2 -0
  6. package/dist-cjs/commands/DescribeStreamConsumerCommand.js +3 -0
  7. package/dist-cjs/commands/DescribeStreamSummaryCommand.js +2 -0
  8. package/dist-cjs/commands/DisableEnhancedMonitoringCommand.js +2 -0
  9. package/dist-cjs/commands/EnableEnhancedMonitoringCommand.js +2 -0
  10. package/dist-cjs/commands/GetRecordsCommand.js +2 -0
  11. package/dist-cjs/commands/GetShardIteratorCommand.js +2 -0
  12. package/dist-cjs/commands/IncreaseStreamRetentionPeriodCommand.js +2 -0
  13. package/dist-cjs/commands/ListShardsCommand.js +2 -0
  14. package/dist-cjs/commands/ListStreamConsumersCommand.js +2 -0
  15. package/dist-cjs/commands/ListTagsForStreamCommand.js +2 -0
  16. package/dist-cjs/commands/MergeShardsCommand.js +2 -0
  17. package/dist-cjs/commands/PutRecordCommand.js +2 -0
  18. package/dist-cjs/commands/PutRecordsCommand.js +2 -0
  19. package/dist-cjs/commands/RegisterStreamConsumerCommand.js +2 -0
  20. package/dist-cjs/commands/RemoveTagsFromStreamCommand.js +2 -0
  21. package/dist-cjs/commands/SplitShardCommand.js +2 -0
  22. package/dist-cjs/commands/StartStreamEncryptionCommand.js +2 -0
  23. package/dist-cjs/commands/StopStreamEncryptionCommand.js +2 -0
  24. package/dist-cjs/commands/SubscribeToShardCommand.js +2 -0
  25. package/dist-cjs/commands/UpdateShardCountCommand.js +2 -0
  26. package/dist-cjs/commands/UpdateStreamModeCommand.js +2 -0
  27. package/dist-cjs/endpoint/ruleset.js +1069 -5
  28. package/dist-cjs/models/models_0.js +19 -2
  29. package/dist-cjs/pagination/ListStreamsPaginator.js +36 -0
  30. package/dist-cjs/pagination/index.js +1 -0
  31. package/dist-cjs/protocols/Aws_json1_1.js +143 -0
  32. package/dist-es/commands/AddTagsToStreamCommand.js +2 -0
  33. package/dist-es/commands/DecreaseStreamRetentionPeriodCommand.js +2 -0
  34. package/dist-es/commands/DeleteStreamCommand.js +2 -0
  35. package/dist-es/commands/DeregisterStreamConsumerCommand.js +3 -0
  36. package/dist-es/commands/DescribeStreamCommand.js +2 -0
  37. package/dist-es/commands/DescribeStreamConsumerCommand.js +3 -0
  38. package/dist-es/commands/DescribeStreamSummaryCommand.js +2 -0
  39. package/dist-es/commands/DisableEnhancedMonitoringCommand.js +2 -0
  40. package/dist-es/commands/EnableEnhancedMonitoringCommand.js +2 -0
  41. package/dist-es/commands/GetRecordsCommand.js +2 -0
  42. package/dist-es/commands/GetShardIteratorCommand.js +2 -0
  43. package/dist-es/commands/IncreaseStreamRetentionPeriodCommand.js +2 -0
  44. package/dist-es/commands/ListShardsCommand.js +2 -0
  45. package/dist-es/commands/ListStreamConsumersCommand.js +2 -0
  46. package/dist-es/commands/ListTagsForStreamCommand.js +2 -0
  47. package/dist-es/commands/MergeShardsCommand.js +2 -0
  48. package/dist-es/commands/PutRecordCommand.js +2 -0
  49. package/dist-es/commands/PutRecordsCommand.js +2 -0
  50. package/dist-es/commands/RegisterStreamConsumerCommand.js +2 -0
  51. package/dist-es/commands/RemoveTagsFromStreamCommand.js +2 -0
  52. package/dist-es/commands/SplitShardCommand.js +2 -0
  53. package/dist-es/commands/StartStreamEncryptionCommand.js +2 -0
  54. package/dist-es/commands/StopStreamEncryptionCommand.js +2 -0
  55. package/dist-es/commands/SubscribeToShardCommand.js +2 -0
  56. package/dist-es/commands/UpdateShardCountCommand.js +2 -0
  57. package/dist-es/commands/UpdateStreamModeCommand.js +2 -0
  58. package/dist-es/endpoint/ruleset.js +1069 -5
  59. package/dist-es/models/models_0.js +15 -0
  60. package/dist-es/pagination/ListStreamsPaginator.js +32 -0
  61. package/dist-es/pagination/index.js +1 -0
  62. package/dist-es/protocols/Aws_json1_1.js +144 -1
  63. package/dist-types/Kinesis.d.ts +213 -138
  64. package/dist-types/KinesisClient.d.ts +1 -1
  65. package/dist-types/commands/AddTagsToStreamCommand.d.ts +6 -2
  66. package/dist-types/commands/CreateStreamCommand.d.ts +19 -16
  67. package/dist-types/commands/DecreaseStreamRetentionPeriodCommand.d.ts +5 -1
  68. package/dist-types/commands/DeleteStreamCommand.d.ts +9 -6
  69. package/dist-types/commands/DeregisterStreamConsumerCommand.d.ts +1 -1
  70. package/dist-types/commands/DescribeLimitsCommand.d.ts +2 -2
  71. package/dist-types/commands/DescribeStreamCommand.d.ts +10 -7
  72. package/dist-types/commands/DescribeStreamConsumerCommand.d.ts +1 -1
  73. package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +6 -2
  74. package/dist-types/commands/DisableEnhancedMonitoringCommand.d.ts +4 -0
  75. package/dist-types/commands/EnableEnhancedMonitoringCommand.d.ts +4 -0
  76. package/dist-types/commands/GetRecordsCommand.d.ts +11 -16
  77. package/dist-types/commands/GetShardIteratorCommand.d.ts +10 -6
  78. package/dist-types/commands/IncreaseStreamRetentionPeriodCommand.d.ts +5 -1
  79. package/dist-types/commands/ListShardsCommand.d.ts +7 -3
  80. package/dist-types/commands/ListStreamConsumersCommand.d.ts +1 -1
  81. package/dist-types/commands/ListStreamsCommand.d.ts +3 -3
  82. package/dist-types/commands/ListTagsForStreamCommand.d.ts +4 -0
  83. package/dist-types/commands/MergeShardsCommand.d.ts +13 -8
  84. package/dist-types/commands/PutRecordCommand.d.ts +14 -10
  85. package/dist-types/commands/PutRecordsCommand.d.ts +16 -12
  86. package/dist-types/commands/RegisterStreamConsumerCommand.d.ts +3 -3
  87. package/dist-types/commands/RemoveTagsFromStreamCommand.d.ts +6 -2
  88. package/dist-types/commands/SplitShardCommand.d.ts +15 -10
  89. package/dist-types/commands/StartStreamEncryptionCommand.d.ts +7 -3
  90. package/dist-types/commands/StopStreamEncryptionCommand.d.ts +7 -3
  91. package/dist-types/commands/SubscribeToShardCommand.d.ts +4 -4
  92. package/dist-types/commands/UpdateShardCountCommand.d.ts +19 -14
  93. package/dist-types/endpoint/EndpointParameters.d.ts +4 -1
  94. package/dist-types/models/models_0.d.ts +351 -214
  95. package/dist-types/pagination/ListStreamsPaginator.d.ts +4 -0
  96. package/dist-types/pagination/index.d.ts +1 -0
  97. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +4 -1
  98. package/dist-types/ts3.4/models/models_0.d.ts +60 -18
  99. package/dist-types/ts3.4/pagination/ListStreamsPaginator.d.ts +11 -0
  100. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  101. package/package.json +1 -1
@@ -1,5 +1,17 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { KinesisServiceException as __BaseException } from "./KinesisServiceException";
3
+ /**
4
+ * <p>Specifies that you do not have the permissions required to perform this
5
+ * operation.</p>
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
+ }
3
15
  /**
4
16
  * <p>Represents the input for <code>AddTagsToStream</code>.</p>
5
17
  */
@@ -7,11 +19,15 @@ export interface AddTagsToStreamInput {
7
19
  /**
8
20
  * <p>The name of the stream.</p>
9
21
  */
10
- StreamName: string | undefined;
22
+ StreamName?: string;
11
23
  /**
12
24
  * <p>A set of up to 10 key-value pairs to use to create the tags.</p>
13
25
  */
14
26
  Tags: Record<string, string> | undefined;
27
+ /**
28
+ * <p>The ARN of the stream.</p>
29
+ */
30
+ StreamARN?: string;
15
31
  }
16
32
  /**
17
33
  * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
@@ -112,7 +128,7 @@ export interface Consumer {
112
128
  /**
113
129
  * <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
114
130
  * this ARN to be able to call <a>SubscribeToShard</a>.</p>
115
- * <p>If you delete a consumer and then create a new one with the same name, it won't have
131
+ * <p>If you delete a consumer and then create a new one with the same name, it won't have
116
132
  * the same ARN. That's because consumer ARNs contain the creation timestamp. This is
117
133
  * important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
118
134
  */
@@ -140,7 +156,7 @@ export interface ConsumerDescription {
140
156
  /**
141
157
  * <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
142
158
  * this ARN to be able to call <a>SubscribeToShard</a>.</p>
143
- * <p>If you delete a consumer and then create a new one with the same name, it won't have
159
+ * <p>If you delete a consumer and then create a new one with the same name, it won't have
144
160
  * the same ARN. That's because consumer ARNs contain the creation timestamp. This is
145
161
  * important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
146
162
  */
@@ -206,12 +222,16 @@ export interface DecreaseStreamRetentionPeriodInput {
206
222
  /**
207
223
  * <p>The name of the stream to modify.</p>
208
224
  */
209
- StreamName: string | undefined;
225
+ StreamName?: string;
210
226
  /**
211
227
  * <p>The new retention period of the stream, in hours. Must be less than the current
212
228
  * retention period.</p>
213
229
  */
214
230
  RetentionPeriodHours: number | undefined;
231
+ /**
232
+ * <p>The ARN of the stream.</p>
233
+ */
234
+ StreamARN?: string;
215
235
  }
216
236
  /**
217
237
  * <p>Represents the input for <a>DeleteStream</a>.</p>
@@ -220,13 +240,17 @@ export interface DeleteStreamInput {
220
240
  /**
221
241
  * <p>The name of the stream to delete.</p>
222
242
  */
223
- StreamName: string | undefined;
243
+ StreamName?: string;
224
244
  /**
225
245
  * <p>If this parameter is unset (<code>null</code>) or if you set it to <code>false</code>,
226
246
  * and the stream has registered consumers, the call to <code>DeleteStream</code> fails
227
247
  * with a <code>ResourceInUseException</code>. </p>
228
248
  */
229
249
  EnforceConsumerDeletion?: boolean;
250
+ /**
251
+ * <p>The ARN of the stream.</p>
252
+ */
253
+ StreamARN?: string;
230
254
  }
231
255
  export interface DeregisterStreamConsumerInput {
232
256
  /**
@@ -275,7 +299,7 @@ export interface DescribeStreamInput {
275
299
  /**
276
300
  * <p>The name of the stream to describe.</p>
277
301
  */
278
- StreamName: string | undefined;
302
+ StreamName?: string;
279
303
  /**
280
304
  * <p>The maximum number of shards to return in a single call. The default value is 100. If
281
305
  * you specify a value greater than 100, at most 100 results are returned.</p>
@@ -283,13 +307,17 @@ export interface DescribeStreamInput {
283
307
  Limit?: number;
284
308
  /**
285
309
  * <p>The shard ID of the shard to start with.</p>
286
- * <p>Specify this parameter to indicate that you want to describe the stream starting with
310
+ * <p>Specify this parameter to indicate that you want to describe the stream starting with
287
311
  * the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
288
- * <p>If you don't specify this parameter, the default behavior for
312
+ * <p>If you don't specify this parameter, the default behavior for
289
313
  * <code>DescribeStream</code> is to describe the stream starting with the first shard
290
314
  * in the stream.</p>
291
315
  */
292
316
  ExclusiveStartShardId?: string;
317
+ /**
318
+ * <p>The ARN of the stream.</p>
319
+ */
320
+ StreamARN?: string;
293
321
  }
294
322
  export declare enum EncryptionType {
295
323
  KMS = "KMS",
@@ -311,51 +339,51 @@ export declare enum MetricsName {
311
339
  export interface EnhancedMetrics {
312
340
  /**
313
341
  * <p>List of shard-level metrics.</p>
314
- * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enhances
342
+ * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enhances
315
343
  * every metric.</p>
316
- * <ul>
344
+ * <ul>
317
345
  * <li>
318
- * <p>
319
- * <code>IncomingBytes</code>
320
- * </p>
346
+ * <p>
347
+ * <code>IncomingBytes</code>
348
+ * </p>
321
349
  * </li>
322
350
  * <li>
323
- * <p>
324
- * <code>IncomingRecords</code>
325
- * </p>
351
+ * <p>
352
+ * <code>IncomingRecords</code>
353
+ * </p>
326
354
  * </li>
327
355
  * <li>
328
- * <p>
329
- * <code>OutgoingBytes</code>
330
- * </p>
356
+ * <p>
357
+ * <code>OutgoingBytes</code>
358
+ * </p>
331
359
  * </li>
332
360
  * <li>
333
- * <p>
334
- * <code>OutgoingRecords</code>
335
- * </p>
361
+ * <p>
362
+ * <code>OutgoingRecords</code>
363
+ * </p>
336
364
  * </li>
337
365
  * <li>
338
- * <p>
339
- * <code>WriteProvisionedThroughputExceeded</code>
340
- * </p>
366
+ * <p>
367
+ * <code>WriteProvisionedThroughputExceeded</code>
368
+ * </p>
341
369
  * </li>
342
370
  * <li>
343
- * <p>
344
- * <code>ReadProvisionedThroughputExceeded</code>
345
- * </p>
371
+ * <p>
372
+ * <code>ReadProvisionedThroughputExceeded</code>
373
+ * </p>
346
374
  * </li>
347
375
  * <li>
348
- * <p>
349
- * <code>IteratorAgeMilliseconds</code>
350
- * </p>
376
+ * <p>
377
+ * <code>IteratorAgeMilliseconds</code>
378
+ * </p>
351
379
  * </li>
352
380
  * <li>
353
- * <p>
354
- * <code>ALL</code>
355
- * </p>
381
+ * <p>
382
+ * <code>ALL</code>
383
+ * </p>
356
384
  * </li>
357
385
  * </ul>
358
- * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
386
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
359
387
  * Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
360
388
  * Kinesis Data Streams Developer Guide</i>.</p>
361
389
  */
@@ -422,28 +450,28 @@ export interface StreamDescription {
422
450
  /**
423
451
  * <p>The current status of the stream being described. The stream status is one of the
424
452
  * following states:</p>
425
- * <ul>
453
+ * <ul>
426
454
  * <li>
427
- * <p>
428
- * <code>CREATING</code> - The stream is being created. Kinesis Data Streams
455
+ * <p>
456
+ * <code>CREATING</code> - The stream is being created. Kinesis Data Streams
429
457
  * immediately returns and sets <code>StreamStatus</code> to
430
458
  * <code>CREATING</code>.</p>
431
459
  * </li>
432
460
  * <li>
433
- * <p>
434
- * <code>DELETING</code> - The stream is being deleted. The specified stream is in
461
+ * <p>
462
+ * <code>DELETING</code> - The stream is being deleted. The specified stream is in
435
463
  * the <code>DELETING</code> state until Kinesis Data Streams completes the
436
464
  * deletion.</p>
437
465
  * </li>
438
466
  * <li>
439
- * <p>
440
- * <code>ACTIVE</code> - The stream exists and is ready for read and write
467
+ * <p>
468
+ * <code>ACTIVE</code> - The stream exists and is ready for read and write
441
469
  * operations or deletion. You should perform read and write operations only on an
442
470
  * <code>ACTIVE</code> stream.</p>
443
471
  * </li>
444
472
  * <li>
445
- * <p>
446
- * <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
473
+ * <p>
474
+ * <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
447
475
  * write operations continue to work while the stream is in the
448
476
  * <code>UPDATING</code> state.</p>
449
477
  * </li>
@@ -480,13 +508,13 @@ export interface StreamDescription {
480
508
  /**
481
509
  * <p>The server-side encryption type used on the stream. This parameter can be one of the
482
510
  * following values:</p>
483
- * <ul>
511
+ * <ul>
484
512
  * <li>
485
- * <p>
513
+ * <p>
486
514
  * <code>NONE</code>: Do not encrypt the records in the stream.</p>
487
515
  * </li>
488
516
  * <li>
489
- * <p>
517
+ * <p>
490
518
  * <code>KMS</code>: Use server-side encryption on the records in the stream
491
519
  * using a customer-managed Amazon Web Services KMS key.</p>
492
520
  * </li>
@@ -498,28 +526,28 @@ export interface StreamDescription {
498
526
  * This value can be a globally unique identifier, a fully specified ARN to either an alias
499
527
  * or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
500
528
  * Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
501
- * <ul>
529
+ * <ul>
502
530
  * <li>
503
- * <p>Key ARN example:
531
+ * <p>Key ARN example:
504
532
  * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
505
533
  * </p>
506
534
  * </li>
507
535
  * <li>
508
- * <p>Alias ARN example:
536
+ * <p>Alias ARN example:
509
537
  * <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
510
538
  * </p>
511
539
  * </li>
512
540
  * <li>
513
- * <p>Globally unique key ID example:
541
+ * <p>Globally unique key ID example:
514
542
  * <code>12345678-1234-1234-1234-123456789012</code>
515
543
  * </p>
516
544
  * </li>
517
545
  * <li>
518
- * <p>Alias name example: <code>alias/MyAliasName</code>
546
+ * <p>Alias name example: <code>alias/MyAliasName</code>
519
547
  * </p>
520
548
  * </li>
521
549
  * <li>
522
- * <p>Master key owned by Kinesis Data Streams:
550
+ * <p>Master key owned by Kinesis Data Streams:
523
551
  * <code>alias/aws/kinesis</code>
524
552
  * </p>
525
553
  * </li>
@@ -564,7 +592,11 @@ export interface DescribeStreamSummaryInput {
564
592
  /**
565
593
  * <p>The name of the stream to describe.</p>
566
594
  */
567
- StreamName: string | undefined;
595
+ StreamName?: string;
596
+ /**
597
+ * <p>The ARN of the stream.</p>
598
+ */
599
+ StreamARN?: string;
568
600
  }
569
601
  /**
570
602
  * <p>Represents the output for <a>DescribeStreamSummary</a>
@@ -582,28 +614,28 @@ export interface StreamDescriptionSummary {
582
614
  /**
583
615
  * <p>The current status of the stream being described. The stream status is one of the
584
616
  * following states:</p>
585
- * <ul>
617
+ * <ul>
586
618
  * <li>
587
- * <p>
588
- * <code>CREATING</code> - The stream is being created. Kinesis Data Streams
619
+ * <p>
620
+ * <code>CREATING</code> - The stream is being created. Kinesis Data Streams
589
621
  * immediately returns and sets <code>StreamStatus</code> to
590
622
  * <code>CREATING</code>.</p>
591
623
  * </li>
592
624
  * <li>
593
- * <p>
594
- * <code>DELETING</code> - The stream is being deleted. The specified stream is in
625
+ * <p>
626
+ * <code>DELETING</code> - The stream is being deleted. The specified stream is in
595
627
  * the <code>DELETING</code> state until Kinesis Data Streams completes the
596
628
  * deletion.</p>
597
629
  * </li>
598
630
  * <li>
599
- * <p>
600
- * <code>ACTIVE</code> - The stream exists and is ready for read and write
631
+ * <p>
632
+ * <code>ACTIVE</code> - The stream exists and is ready for read and write
601
633
  * operations or deletion. You should perform read and write operations only on an
602
634
  * <code>ACTIVE</code> stream.</p>
603
635
  * </li>
604
636
  * <li>
605
- * <p>
606
- * <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
637
+ * <p>
638
+ * <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
607
639
  * write operations continue to work while the stream is in the
608
640
  * <code>UPDATING</code> state.</p>
609
641
  * </li>
@@ -629,14 +661,14 @@ export interface StreamDescriptionSummary {
629
661
  EnhancedMonitoring: EnhancedMetrics[] | undefined;
630
662
  /**
631
663
  * <p>The encryption type used. This value is one of the following:</p>
632
- * <ul>
664
+ * <ul>
633
665
  * <li>
634
- * <p>
666
+ * <p>
635
667
  * <code>KMS</code>
636
668
  * </p>
637
669
  * </li>
638
670
  * <li>
639
- * <p>
671
+ * <p>
640
672
  * <code>NONE</code>
641
673
  * </p>
642
674
  * </li>
@@ -648,28 +680,28 @@ export interface StreamDescriptionSummary {
648
680
  * This value can be a globally unique identifier, a fully specified ARN to either an alias
649
681
  * or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
650
682
  * Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
651
- * <ul>
683
+ * <ul>
652
684
  * <li>
653
- * <p>Key ARN example:
685
+ * <p>Key ARN example:
654
686
  * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
655
687
  * </p>
656
688
  * </li>
657
689
  * <li>
658
- * <p>Alias ARN example: <code>
690
+ * <p>Alias ARN example: <code>
659
691
  * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
660
692
  * </p>
661
693
  * </li>
662
694
  * <li>
663
- * <p>Globally unique key ID example:
695
+ * <p>Globally unique key ID example:
664
696
  * <code>12345678-1234-1234-1234-123456789012</code>
665
697
  * </p>
666
698
  * </li>
667
699
  * <li>
668
- * <p>Alias name example: <code>alias/MyAliasName</code>
700
+ * <p>Alias name example: <code>alias/MyAliasName</code>
669
701
  * </p>
670
702
  * </li>
671
703
  * <li>
672
- * <p>Master key owned by Kinesis Data Streams:
704
+ * <p>Master key owned by Kinesis Data Streams:
673
705
  * <code>alias/aws/kinesis</code>
674
706
  * </p>
675
707
  * </li>
@@ -699,58 +731,62 @@ export interface DisableEnhancedMonitoringInput {
699
731
  /**
700
732
  * <p>The name of the Kinesis data stream for which to disable enhanced monitoring.</p>
701
733
  */
702
- StreamName: string | undefined;
734
+ StreamName?: string;
703
735
  /**
704
736
  * <p>List of shard-level metrics to disable.</p>
705
- * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" disables
737
+ * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" disables
706
738
  * every metric.</p>
707
- * <ul>
739
+ * <ul>
708
740
  * <li>
709
- * <p>
710
- * <code>IncomingBytes</code>
711
- * </p>
741
+ * <p>
742
+ * <code>IncomingBytes</code>
743
+ * </p>
712
744
  * </li>
713
745
  * <li>
714
- * <p>
715
- * <code>IncomingRecords</code>
716
- * </p>
746
+ * <p>
747
+ * <code>IncomingRecords</code>
748
+ * </p>
717
749
  * </li>
718
750
  * <li>
719
- * <p>
720
- * <code>OutgoingBytes</code>
721
- * </p>
751
+ * <p>
752
+ * <code>OutgoingBytes</code>
753
+ * </p>
722
754
  * </li>
723
755
  * <li>
724
- * <p>
725
- * <code>OutgoingRecords</code>
726
- * </p>
756
+ * <p>
757
+ * <code>OutgoingRecords</code>
758
+ * </p>
727
759
  * </li>
728
760
  * <li>
729
- * <p>
730
- * <code>WriteProvisionedThroughputExceeded</code>
731
- * </p>
761
+ * <p>
762
+ * <code>WriteProvisionedThroughputExceeded</code>
763
+ * </p>
732
764
  * </li>
733
765
  * <li>
734
- * <p>
735
- * <code>ReadProvisionedThroughputExceeded</code>
736
- * </p>
766
+ * <p>
767
+ * <code>ReadProvisionedThroughputExceeded</code>
768
+ * </p>
737
769
  * </li>
738
770
  * <li>
739
- * <p>
740
- * <code>IteratorAgeMilliseconds</code>
741
- * </p>
771
+ * <p>
772
+ * <code>IteratorAgeMilliseconds</code>
773
+ * </p>
742
774
  * </li>
743
775
  * <li>
744
- * <p>
745
- * <code>ALL</code>
746
- * </p>
776
+ * <p>
777
+ * <code>ALL</code>
778
+ * </p>
747
779
  * </li>
748
780
  * </ul>
749
- * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
781
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
750
782
  * Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
751
783
  * Kinesis Data Streams Developer Guide</i>.</p>
752
784
  */
753
785
  ShardLevelMetrics: (MetricsName | string)[] | undefined;
786
+ /**
787
+ * <p>The ARN of the stream.</p>
788
+ */
789
+ StreamARN?: string;
754
790
  }
755
791
  /**
756
792
  * <p>Represents the output for <a>EnableEnhancedMonitoring</a> and <a>DisableEnhancedMonitoring</a>.</p>
@@ -770,6 +806,10 @@ export interface EnhancedMonitoringOutput {
770
806
  * operation.</p>
771
807
  */
772
808
  DesiredShardLevelMetrics?: (MetricsName | string)[];
809
+ /**
810
+ * <p>The ARN of the stream.</p>
811
+ */
812
+ StreamARN?: string;
773
813
  }
774
814
  /**
775
815
  * <p>Represents the input for <a>EnableEnhancedMonitoring</a>.</p>
@@ -778,58 +818,62 @@ export interface EnableEnhancedMonitoringInput {
778
818
  /**
779
819
  * <p>The name of the stream for which to enable enhanced monitoring.</p>
780
820
  */
781
- StreamName: string | undefined;
821
+ StreamName?: string;
782
822
  /**
783
823
  * <p>List of shard-level metrics to enable.</p>
784
- * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enables
824
+ * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enables
785
825
  * every metric.</p>
786
- * <ul>
826
+ * <ul>
787
827
  * <li>
788
- * <p>
789
- * <code>IncomingBytes</code>
790
- * </p>
828
+ * <p>
829
+ * <code>IncomingBytes</code>
830
+ * </p>
791
831
  * </li>
792
832
  * <li>
793
- * <p>
794
- * <code>IncomingRecords</code>
795
- * </p>
833
+ * <p>
834
+ * <code>IncomingRecords</code>
835
+ * </p>
796
836
  * </li>
797
837
  * <li>
798
- * <p>
799
- * <code>OutgoingBytes</code>
800
- * </p>
838
+ * <p>
839
+ * <code>OutgoingBytes</code>
840
+ * </p>
801
841
  * </li>
802
842
  * <li>
803
- * <p>
804
- * <code>OutgoingRecords</code>
805
- * </p>
843
+ * <p>
844
+ * <code>OutgoingRecords</code>
845
+ * </p>
806
846
  * </li>
807
847
  * <li>
808
- * <p>
809
- * <code>WriteProvisionedThroughputExceeded</code>
810
- * </p>
848
+ * <p>
849
+ * <code>WriteProvisionedThroughputExceeded</code>
850
+ * </p>
811
851
  * </li>
812
852
  * <li>
813
- * <p>
814
- * <code>ReadProvisionedThroughputExceeded</code>
815
- * </p>
853
+ * <p>
854
+ * <code>ReadProvisionedThroughputExceeded</code>
855
+ * </p>
816
856
  * </li>
817
857
  * <li>
818
- * <p>
819
- * <code>IteratorAgeMilliseconds</code>
820
- * </p>
858
+ * <p>
859
+ * <code>IteratorAgeMilliseconds</code>
860
+ * </p>
821
861
  * </li>
822
862
  * <li>
823
- * <p>
824
- * <code>ALL</code>
825
- * </p>
863
+ * <p>
864
+ * <code>ALL</code>
865
+ * </p>
826
866
  * </li>
827
867
  * </ul>
828
- * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
868
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
829
869
  * Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
830
870
  * Kinesis Data Streams Developer Guide</i>.</p>
831
871
  */
832
872
  ShardLevelMetrics: (MetricsName | string)[] | undefined;
873
+ /**
874
+ * <p>The ARN of the stream.</p>
875
+ */
876
+ StreamARN?: string;
833
877
  }
834
878
  /**
835
879
  * <p>The provided iterator exceeds the maximum age allowed.</p>
@@ -869,6 +913,10 @@ export interface GetRecordsInput {
869
913
  * <code>InvalidArgumentException</code>. The default value is 10,000.</p>
870
914
  */
871
915
  Limit?: number;
916
+ /**
917
+ * <p>The ARN of the stream.</p>
918
+ */
919
+ StreamARN?: string;
872
920
  }
873
921
  /**
874
922
  * <p>The unit of data of the Kinesis data stream, which is composed of a sequence number, a
@@ -897,13 +945,13 @@ export interface _Record {
897
945
  /**
898
946
  * <p>The encryption type used on the record. This parameter can be one of the following
899
947
  * values:</p>
900
- * <ul>
948
+ * <ul>
901
949
  * <li>
902
- * <p>
950
+ * <p>
903
951
  * <code>NONE</code>: Do not encrypt the records in the stream.</p>
904
952
  * </li>
905
953
  * <li>
906
- * <p>
954
+ * <p>
907
955
  * <code>KMS</code>: Use server-side encryption on the records in the stream
908
956
  * using a customer-managed Amazon Web Services KMS key.</p>
909
957
  * </li>
@@ -1042,7 +1090,7 @@ export interface GetShardIteratorInput {
1042
1090
  /**
1043
1091
  * <p>The name of the Amazon Kinesis data stream.</p>
1044
1092
  */
1045
- StreamName: string | undefined;
1093
+ StreamName?: string;
1046
1094
  /**
1047
1095
  * <p>The shard ID of the Kinesis Data Streams shard to get the iterator for.</p>
1048
1096
  */
@@ -1050,33 +1098,28 @@ export interface GetShardIteratorInput {
1050
1098
  /**
1051
1099
  * <p>Determines how the shard iterator is used to start reading data records from the
1052
1100
  * shard.</p>
1053
- * <p>The following are the valid Amazon Kinesis shard iterator types:</p>
1054
- * <ul>
1101
+ * <p>The following are the valid Amazon Kinesis shard iterator types:</p>
1102
+ * <ul>
1055
1103
  * <li>
1056
- *
1057
- * <p>AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific
1104
+ * <p>AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific
1058
1105
  * sequence number, provided in the value
1059
1106
  * <code>StartingSequenceNumber</code>.</p>
1060
1107
  * </li>
1061
1108
  * <li>
1062
- *
1063
- * <p>AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a
1109
+ * <p>AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a
1064
1110
  * specific sequence number, provided in the value
1065
1111
  * <code>StartingSequenceNumber</code>.</p>
1066
1112
  * </li>
1067
1113
  * <li>
1068
- *
1069
- * <p>AT_TIMESTAMP - Start reading from the position denoted by a specific time
1114
+ * <p>AT_TIMESTAMP - Start reading from the position denoted by a specific time
1070
1115
  * stamp, provided in the value <code>Timestamp</code>.</p>
1071
1116
  * </li>
1072
1117
  * <li>
1073
- *
1074
- * <p>TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the
1118
+ * <p>TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the
1075
1119
  * system, which is the oldest data record in the shard.</p>
1076
1120
  * </li>
1077
1121
  * <li>
1078
- *
1079
- * <p>LATEST - Start reading just after the most recent record in the shard, so that
1122
+ * <p>LATEST - Start reading just after the most recent record in the shard, so that
1080
1123
  * you always read the most recent data in the shard.</p>
1081
1124
  * </li>
1082
1125
  * </ul>
@@ -1097,6 +1140,10 @@ export interface GetShardIteratorInput {
1097
1140
  * (TRIM_HORIZON).</p>
1098
1141
  */
1099
1142
  Timestamp?: Date;
1143
+ /**
1144
+ * <p>The ARN of the stream.</p>
1145
+ */
1146
+ StreamARN?: string;
1100
1147
  }
1101
1148
  /**
1102
1149
  * <p>Represents the output for <code>GetShardIterator</code>.</p>
@@ -1116,12 +1163,16 @@ export interface IncreaseStreamRetentionPeriodInput {
1116
1163
  /**
1117
1164
  * <p>The name of the stream to modify.</p>
1118
1165
  */
1119
- StreamName: string | undefined;
1166
+ StreamName?: string;
1120
1167
  /**
1121
1168
  * <p>The new retention period of the stream, in hours. Must be more than the current
1122
1169
  * retention period.</p>
1123
1170
  */
1124
1171
  RetentionPeriodHours: number | undefined;
1172
+ /**
1173
+ * <p>The ARN of the stream.</p>
1174
+ */
1175
+ StreamARN?: string;
1125
1176
  }
1126
1177
  /**
1127
1178
  * <p>The processing of the request failed because of an unknown error, exception, or
@@ -1151,37 +1202,37 @@ export interface ShardFilter {
1151
1202
  /**
1152
1203
  * <p>The shard type specified in the <code>ShardFilter</code> parameter. This is a required
1153
1204
  * property of the <code>ShardFilter</code> parameter.</p>
1154
- * <p>You can specify the following valid values: </p>
1155
- * <ul>
1205
+ * <p>You can specify the following valid values: </p>
1206
+ * <ul>
1156
1207
  * <li>
1157
- * <p>
1208
+ * <p>
1158
1209
  * <code>AFTER_SHARD_ID</code> - the response includes all the shards, starting
1159
1210
  * with the shard whose ID immediately follows the <code>ShardId</code> that you
1160
1211
  * provided. </p>
1161
1212
  * </li>
1162
1213
  * <li>
1163
- * <p>
1214
+ * <p>
1164
1215
  * <code>AT_TRIM_HORIZON</code> - the response includes all the shards that were
1165
1216
  * open at <code>TRIM_HORIZON</code>.</p>
1166
1217
  * </li>
1167
1218
  * <li>
1168
- * <p>
1219
+ * <p>
1169
1220
  * <code>FROM_TRIM_HORIZON</code> - (default), the response includes all the
1170
1221
  * shards within the retention period of the data stream (trim to tip).</p>
1171
1222
  * </li>
1172
1223
  * <li>
1173
- * <p>
1224
+ * <p>
1174
1225
  * <code>AT_LATEST</code> - the response includes only the currently open shards
1175
1226
  * of the data stream.</p>
1176
1227
  * </li>
1177
1228
  * <li>
1178
- * <p>
1229
+ * <p>
1179
1230
  * <code>AT_TIMESTAMP</code> - the response includes all shards whose start
1180
1231
  * timestamp is less than or equal to the given timestamp and end timestamp is
1181
1232
  * greater than or equal to the given timestamp or still open. </p>
1182
1233
  * </li>
1183
1234
  * <li>
1184
- * <p>
1235
+ * <p>
1185
1236
  * <code>FROM_TIMESTAMP</code> - the response incldues all closed shards whose
1186
1237
  * end timestamp is greater than or equal to the given timestamp and also all open
1187
1238
  * shards. Corrected to <code>TRIM_HORIZON</code> of the data stream if
@@ -1209,7 +1260,7 @@ export interface ShardFilter {
1209
1260
  export interface ListShardsInput {
1210
1261
  /**
1211
1262
  * <p>The name of the data stream whose shards you want to list. </p>
1212
- * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1263
+ * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1213
1264
  * parameter.</p>
1214
1265
  */
1215
1266
  StreamName?: string;
@@ -1220,37 +1271,37 @@ export interface ListShardsInput {
1220
1271
  * the response includes a pagination token named <code>NextToken</code>. You can specify
1221
1272
  * this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
1222
1273
  * list the next set of shards.</p>
1223
- * <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you
1274
+ * <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you
1224
1275
  * specify <code>NextToken</code> because the latter unambiguously identifies the
1225
1276
  * stream.</p>
1226
- * <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you
1277
+ * <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you
1227
1278
  * specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that is
1228
1279
  * less than the number of shards that the operation returns if you don't specify
1229
1280
  * <code>MaxResults</code>, the response will contain a new <code>NextToken</code>
1230
1281
  * value. You can use the new <code>NextToken</code> value in a subsequent call to the
1231
1282
  * <code>ListShards</code> operation.</p>
1232
- * <important>
1283
+ * <important>
1233
1284
  * <p>Tokens expire after 300 seconds. When you obtain a value for
1234
1285
  * <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
1235
1286
  * have 300 seconds to use that value. If you specify an expired token in a call to
1236
1287
  * <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
1237
- * </important>
1288
+ * </important>
1238
1289
  */
1239
1290
  NextToken?: string;
1240
1291
  /**
1241
1292
  * <p>Specify this parameter to indicate that you want to list the shards starting with the
1242
1293
  * shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
1243
- * <p>If you don't specify this parameter, the default behavior is for
1294
+ * <p>If you don't specify this parameter, the default behavior is for
1244
1295
  * <code>ListShards</code> to list the shards starting with the first one in the
1245
1296
  * stream.</p>
1246
- * <p>You cannot specify this parameter if you specify <code>NextToken</code>.</p>
1297
+ * <p>You cannot specify this parameter if you specify <code>NextToken</code>.</p>
1247
1298
  */
1248
1299
  ExclusiveStartShardId?: string;
1249
1300
  /**
1250
1301
  * <p>The maximum number of shards to return in a single call to <code>ListShards</code>.
1251
1302
  * The maximum number of shards to return in a single call. The default value is 1000. If
1252
1303
  * you specify a value greater than 1000, at most 1000 results are returned. </p>
1253
- * <p>When the number of shards to be listed is greater than the value of
1304
+ * <p>When the number of shards to be listed is greater than the value of
1254
1305
  * <code>MaxResults</code>, the response contains a <code>NextToken</code> value that
1255
1306
  * you can use in a subsequent call to <code>ListShards</code> to list the next set of
1256
1307
  * shards.</p>
@@ -1261,31 +1312,35 @@ export interface ListShardsInput {
1261
1312
  * example, if you create a data stream and then delete it, and you later create another
1262
1313
  * data stream with the same name, you can use this input parameter to specify which of the
1263
1314
  * two streams you want to list the shards for.</p>
1264
- * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1315
+ * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1265
1316
  * parameter.</p>
1266
1317
  */
1267
1318
  StreamCreationTimestamp?: Date;
1268
1319
  /**
1269
1320
  * <p>Enables you to filter out the response of the <code>ListShards</code> API. You can
1270
1321
  * only specify one filter at a time. </p>
1271
- * <p>If you use the <code>ShardFilter</code> parameter when invoking the ListShards API,
1322
+ * <p>If you use the <code>ShardFilter</code> parameter when invoking the ListShards API,
1272
1323
  * the <code>Type</code> is the required property and must be specified. If you specify the
1273
1324
  * <code>AT_TRIM_HORIZON</code>, <code>FROM_TRIM_HORIZON</code>, or
1274
1325
  * <code>AT_LATEST</code> types, you do not need to specify either the
1275
1326
  * <code>ShardId</code> or the <code>Timestamp</code> optional properties. </p>
1276
- * <p>If you specify the <code>AFTER_SHARD_ID</code> type, you must also provide the value
1327
+ * <p>If you specify the <code>AFTER_SHARD_ID</code> type, you must also provide the value
1277
1328
  * for the optional <code>ShardId</code> property. The <code>ShardId</code> property is
1278
1329
  * identical in fuctionality to the <code>ExclusiveStartShardId</code> parameter of the
1279
1330
  * <code>ListShards</code> API. When <code>ShardId</code> property is specified, the
1280
1331
  * response includes the shards starting with the shard whose ID immediately follows the
1281
1332
  * <code>ShardId</code> that you provided. </p>
1282
- * <p>If you specify the <code>AT_TIMESTAMP</code> or <code>FROM_TIMESTAMP_ID</code> type,
1333
+ * <p>If you specify the <code>AT_TIMESTAMP</code> or <code>FROM_TIMESTAMP_ID</code> type,
1283
1334
  * you must also provide the value for the optional <code>Timestamp</code> property. If you
1284
1335
  * specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp
1285
1336
  * are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the
1286
1337
  * provided timestamp to TIP are returned. </p>
1287
1338
  */
1288
1339
  ShardFilter?: ShardFilter;
1340
+ /**
1341
+ * <p>The ARN of the stream.</p>
1342
+ */
1343
+ StreamARN?: string;
1289
1344
  }
1290
1345
  export interface ListShardsOutput {
1291
1346
  /**
@@ -1303,12 +1358,12 @@ export interface ListShardsOutput {
1303
1358
  * this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
1304
1359
  * list the next set of shards. For more information about the use of this pagination token
1305
1360
  * when calling the <code>ListShards</code> operation, see <a>ListShardsInput$NextToken</a>.</p>
1306
- * <important>
1361
+ * <important>
1307
1362
  * <p>Tokens expire after 300 seconds. When you obtain a value for
1308
1363
  * <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
1309
1364
  * have 300 seconds to use that value. If you specify an expired token in a call to
1310
1365
  * <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
1311
- * </important>
1366
+ * </important>
1312
1367
  */
1313
1368
  NextToken?: string;
1314
1369
  }
@@ -1327,22 +1382,22 @@ export interface ListStreamConsumersInput {
1327
1382
  * <code>NextToken</code>. You can specify this <code>NextToken</code> value in a
1328
1383
  * subsequent call to <code>ListStreamConsumers</code> to list the next set of registered
1329
1384
  * consumers.</p>
1330
- * <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you
1385
+ * <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you
1331
1386
  * specify <code>NextToken</code> because the latter unambiguously identifies the
1332
1387
  * stream.</p>
1333
- * <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you
1388
+ * <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you
1334
1389
  * specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that is
1335
1390
  * less than the number of consumers that the operation returns if you don't specify
1336
1391
  * <code>MaxResults</code>, the response will contain a new <code>NextToken</code>
1337
1392
  * value. You can use the new <code>NextToken</code> value in a subsequent call to the
1338
1393
  * <code>ListStreamConsumers</code> operation to list the next set of consumers.</p>
1339
- * <important>
1394
+ * <important>
1340
1395
  * <p>Tokens expire after 300 seconds. When you obtain a value for
1341
1396
  * <code>NextToken</code> in the response to a call to
1342
1397
  * <code>ListStreamConsumers</code>, you have 300 seconds to use that value. If you
1343
1398
  * specify an expired token in a call to <code>ListStreamConsumers</code>, you get
1344
1399
  * <code>ExpiredNextTokenException</code>.</p>
1345
- * </important>
1400
+ * </important>
1346
1401
  */
1347
1402
  NextToken?: string;
1348
1403
  /**
@@ -1356,7 +1411,7 @@ export interface ListStreamConsumersInput {
1356
1411
  * example, if you create a data stream and then delete it, and you later create another
1357
1412
  * data stream with the same name, you can use this input parameter to specify which of the
1358
1413
  * two streams you want to list the consumers for. </p>
1359
- * <p>You can't specify this parameter if you specify the NextToken parameter. </p>
1414
+ * <p>You can't specify this parameter if you specify the NextToken parameter. </p>
1360
1415
  */
1361
1416
  StreamCreationTimestamp?: Date;
1362
1417
  }
@@ -1374,13 +1429,13 @@ export interface ListStreamConsumersOutput {
1374
1429
  * <code>ListStreamConsumers</code> to list the next set of registered consumers. For
1375
1430
  * more information about the use of this pagination token when calling the
1376
1431
  * <code>ListStreamConsumers</code> operation, see <a>ListStreamConsumersInput$NextToken</a>.</p>
1377
- * <important>
1432
+ * <important>
1378
1433
  * <p>Tokens expire after 300 seconds. When you obtain a value for
1379
1434
  * <code>NextToken</code> in the response to a call to
1380
1435
  * <code>ListStreamConsumers</code>, you have 300 seconds to use that value. If you
1381
1436
  * specify an expired token in a call to <code>ListStreamConsumers</code>, you get
1382
1437
  * <code>ExpiredNextTokenException</code>.</p>
1383
- * </important>
1438
+ * </important>
1384
1439
  */
1385
1440
  NextToken?: string;
1386
1441
  }
@@ -1397,6 +1452,36 @@ export interface ListStreamsInput {
1397
1452
  * <p>The name of the stream to start the list with.</p>
1398
1453
  */
1399
1454
  ExclusiveStartStreamName?: string;
1455
+ /**
1456
+ * <p></p>
1457
+ */
1458
+ NextToken?: string;
1459
+ }
1460
+ /**
1461
+ * <p>The summary of a stream.</p>
1462
+ */
1463
+ export interface StreamSummary {
1464
+ /**
1465
+ * <p>The name of a stream.</p>
1466
+ */
1467
+ StreamName: string | undefined;
1468
+ /**
1469
+ * <p>The ARN of the stream.</p>
1470
+ */
1471
+ StreamARN: string | undefined;
1472
+ /**
1473
+ * <p>The status of the stream.</p>
1474
+ */
1475
+ StreamStatus: StreamStatus | string | undefined;
1476
+ /**
1477
+ * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
1478
+ * 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>
1479
+ */
1480
+ StreamModeDetails?: StreamModeDetails;
1481
+ /**
1482
+ * <p>The timestamp at which the stream was created.</p>
1483
+ */
1484
+ StreamCreationTimestamp?: Date;
1400
1485
  }
1401
1486
  /**
1402
1487
  * <p>Represents the output for <code>ListStreams</code>.</p>
@@ -1411,6 +1496,14 @@ export interface ListStreamsOutput {
1411
1496
  * <p>If set to <code>true</code>, there are more streams available to list.</p>
1412
1497
  */
1413
1498
  HasMoreStreams: boolean | undefined;
1499
+ /**
1500
+ * <p></p>
1501
+ */
1502
+ NextToken?: string;
1503
+ /**
1504
+ * <p></p>
1505
+ */
1506
+ StreamSummaries?: StreamSummary[];
1414
1507
  }
1415
1508
  /**
1416
1509
  * <p>Represents the input for <code>ListTagsForStream</code>.</p>
@@ -1419,7 +1512,7 @@ export interface ListTagsForStreamInput {
1419
1512
  /**
1420
1513
  * <p>The name of the stream.</p>
1421
1514
  */
1422
- StreamName: string | undefined;
1515
+ StreamName?: string;
1423
1516
  /**
1424
1517
  * <p>The key to use as the starting point for the list of tags. If this parameter is set,
1425
1518
  * <code>ListTagsForStream</code> gets all tags that occur after
@@ -1433,6 +1526,10 @@ export interface ListTagsForStreamInput {
1433
1526
  * response.</p>
1434
1527
  */
1435
1528
  Limit?: number;
1529
+ /**
1530
+ * <p>The ARN of the stream.</p>
1531
+ */
1532
+ StreamARN?: string;
1436
1533
  }
1437
1534
  /**
1438
1535
  * <p>Metadata assigned to the stream, consisting of a key-value pair.</p>
@@ -1473,7 +1570,7 @@ export interface MergeShardsInput {
1473
1570
  /**
1474
1571
  * <p>The name of the stream for the merge.</p>
1475
1572
  */
1476
- StreamName: string | undefined;
1573
+ StreamName?: string;
1477
1574
  /**
1478
1575
  * <p>The shard ID of the shard to combine with the adjacent shard for the merge.</p>
1479
1576
  */
@@ -1482,11 +1579,15 @@ export interface MergeShardsInput {
1482
1579
  * <p>The shard ID of the adjacent shard for the merge.</p>
1483
1580
  */
1484
1581
  AdjacentShardToMerge: string | undefined;
1582
+ /**
1583
+ * <p>The ARN of the stream.</p>
1584
+ */
1585
+ StreamARN?: string;
1485
1586
  }
1486
1587
  /**
1487
- * <p>
1488
- *
1489
- * </p>
1588
+ * <p>Specifies that you tried to invoke this API for a data stream with the on-demand
1589
+ * capacity mode. This API is only supported for data streams with the provisioned capacity
1590
+ * mode. </p>
1490
1591
  */
1491
1592
  export declare class ValidationException extends __BaseException {
1492
1593
  readonly name: "ValidationException";
@@ -1503,7 +1604,7 @@ export interface PutRecordInput {
1503
1604
  /**
1504
1605
  * <p>The name of the stream to put the data record into.</p>
1505
1606
  */
1506
- StreamName: string | undefined;
1607
+ StreamName?: string;
1507
1608
  /**
1508
1609
  * <p>The data blob to put into the record, which is base64-encoded when the blob is
1509
1610
  * serialized. When the data blob (the payload before base64-encoding) is added to the
@@ -1534,6 +1635,10 @@ export interface PutRecordInput {
1534
1635
  * is not set, records are coarsely ordered based on arrival time.</p>
1535
1636
  */
1536
1637
  SequenceNumberForOrdering?: string;
1638
+ /**
1639
+ * <p>The ARN of the stream.</p>
1640
+ */
1641
+ StreamARN?: string;
1537
1642
  }
1538
1643
  /**
1539
1644
  * <p>Represents the output for <code>PutRecord</code>.</p>
@@ -1552,13 +1657,13 @@ export interface PutRecordOutput {
1552
1657
  /**
1553
1658
  * <p>The encryption type to use on the record. This parameter can be one of the following
1554
1659
  * values:</p>
1555
- * <ul>
1660
+ * <ul>
1556
1661
  * <li>
1557
- * <p>
1662
+ * <p>
1558
1663
  * <code>NONE</code>: Do not encrypt the records in the stream.</p>
1559
1664
  * </li>
1560
1665
  * <li>
1561
- * <p>
1666
+ * <p>
1562
1667
  * <code>KMS</code>: Use server-side encryption on the records in the stream
1563
1668
  * using a customer-managed Amazon Web Services KMS key.</p>
1564
1669
  * </li>
@@ -1604,7 +1709,11 @@ export interface PutRecordsInput {
1604
1709
  /**
1605
1710
  * <p>The stream name associated with the request.</p>
1606
1711
  */
1607
- StreamName: string | undefined;
1712
+ StreamName?: string;
1713
+ /**
1714
+ * <p>The ARN of the stream.</p>
1715
+ */
1716
+ StreamARN?: string;
1608
1717
  }
1609
1718
  /**
1610
1719
  * <p>Represents the result of an individual record from a <code>PutRecords</code> request.
@@ -1656,13 +1765,13 @@ export interface PutRecordsOutput {
1656
1765
  /**
1657
1766
  * <p>The encryption type used on the records. This parameter can be one of the following
1658
1767
  * values:</p>
1659
- * <ul>
1768
+ * <ul>
1660
1769
  * <li>
1661
- * <p>
1770
+ * <p>
1662
1771
  * <code>NONE</code>: Do not encrypt the records.</p>
1663
1772
  * </li>
1664
1773
  * <li>
1665
- * <p>
1774
+ * <p>
1666
1775
  * <code>KMS</code>: Use server-side encryption on the records using a
1667
1776
  * customer-managed Amazon Web Services KMS key.</p>
1668
1777
  * </li>
@@ -1697,11 +1806,15 @@ export interface RemoveTagsFromStreamInput {
1697
1806
  /**
1698
1807
  * <p>The name of the stream.</p>
1699
1808
  */
1700
- StreamName: string | undefined;
1809
+ StreamName?: string;
1701
1810
  /**
1702
1811
  * <p>A list of tag keys. Each corresponding tag is removed from the stream.</p>
1703
1812
  */
1704
1813
  TagKeys: string[] | undefined;
1814
+ /**
1815
+ * <p>The ARN of the stream.</p>
1816
+ */
1817
+ StreamARN?: string;
1705
1818
  }
1706
1819
  /**
1707
1820
  * <p>Represents the input for <code>SplitShard</code>.</p>
@@ -1710,7 +1823,7 @@ export interface SplitShardInput {
1710
1823
  /**
1711
1824
  * <p>The name of the stream for the shard split.</p>
1712
1825
  */
1713
- StreamName: string | undefined;
1826
+ StreamName?: string;
1714
1827
  /**
1715
1828
  * <p>The shard ID of the shard to split.</p>
1716
1829
  */
@@ -1725,12 +1838,16 @@ export interface SplitShardInput {
1725
1838
  * child shard.</p>
1726
1839
  */
1727
1840
  NewStartingHashKey: string | undefined;
1841
+ /**
1842
+ * <p>The ARN of the stream.</p>
1843
+ */
1844
+ StreamARN?: string;
1728
1845
  }
1729
1846
  export interface StartStreamEncryptionInput {
1730
1847
  /**
1731
1848
  * <p>The name of the stream for which to start encrypting records.</p>
1732
1849
  */
1733
- StreamName: string | undefined;
1850
+ StreamName?: string;
1734
1851
  /**
1735
1852
  * <p>The encryption type to use. The only valid value is <code>KMS</code>.</p>
1736
1853
  */
@@ -1741,40 +1858,44 @@ export interface StartStreamEncryptionInput {
1741
1858
  * (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
1742
1859
  * use a master key owned by Kinesis Data Streams by specifying the alias
1743
1860
  * <code>aws/kinesis</code>.</p>
1744
- * <ul>
1861
+ * <ul>
1745
1862
  * <li>
1746
- * <p>Key ARN example:
1863
+ * <p>Key ARN example:
1747
1864
  * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
1748
1865
  * </p>
1749
1866
  * </li>
1750
1867
  * <li>
1751
- * <p>Alias ARN example:
1868
+ * <p>Alias ARN example:
1752
1869
  * <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
1753
1870
  * </p>
1754
1871
  * </li>
1755
1872
  * <li>
1756
- * <p>Globally unique key ID example:
1873
+ * <p>Globally unique key ID example:
1757
1874
  * <code>12345678-1234-1234-1234-123456789012</code>
1758
1875
  * </p>
1759
1876
  * </li>
1760
1877
  * <li>
1761
- * <p>Alias name example: <code>alias/MyAliasName</code>
1878
+ * <p>Alias name example: <code>alias/MyAliasName</code>
1762
1879
  * </p>
1763
1880
  * </li>
1764
1881
  * <li>
1765
- * <p>Master key owned by Kinesis Data Streams:
1882
+ * <p>Master key owned by Kinesis Data Streams:
1766
1883
  * <code>alias/aws/kinesis</code>
1767
1884
  * </p>
1768
1885
  * </li>
1769
1886
  * </ul>
1770
1887
  */
1771
1888
  KeyId: string | undefined;
1889
+ /**
1890
+ * <p>The ARN of the stream.</p>
1891
+ */
1892
+ StreamARN?: string;
1772
1893
  }
1773
1894
  export interface StopStreamEncryptionInput {
1774
1895
  /**
1775
1896
  * <p>The name of the stream on which to stop encrypting records.</p>
1776
1897
  */
1777
- StreamName: string | undefined;
1898
+ StreamName?: string;
1778
1899
  /**
1779
1900
  * <p>The encryption type. The only valid value is <code>KMS</code>.</p>
1780
1901
  */
@@ -1785,34 +1906,38 @@ export interface StopStreamEncryptionInput {
1785
1906
  * (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
1786
1907
  * use a master key owned by Kinesis Data Streams by specifying the alias
1787
1908
  * <code>aws/kinesis</code>.</p>
1788
- * <ul>
1909
+ * <ul>
1789
1910
  * <li>
1790
- * <p>Key ARN example:
1911
+ * <p>Key ARN example:
1791
1912
  * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
1792
1913
  * </p>
1793
1914
  * </li>
1794
1915
  * <li>
1795
- * <p>Alias ARN example:
1916
+ * <p>Alias ARN example:
1796
1917
  * <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
1797
1918
  * </p>
1798
1919
  * </li>
1799
1920
  * <li>
1800
- * <p>Globally unique key ID example:
1921
+ * <p>Globally unique key ID example:
1801
1922
  * <code>12345678-1234-1234-1234-123456789012</code>
1802
1923
  * </p>
1803
1924
  * </li>
1804
1925
  * <li>
1805
- * <p>Alias name example: <code>alias/MyAliasName</code>
1926
+ * <p>Alias name example: <code>alias/MyAliasName</code>
1806
1927
  * </p>
1807
1928
  * </li>
1808
1929
  * <li>
1809
- * <p>Master key owned by Kinesis Data Streams:
1930
+ * <p>Master key owned by Kinesis Data Streams:
1810
1931
  * <code>alias/aws/kinesis</code>
1811
1932
  * </p>
1812
1933
  * </li>
1813
1934
  * </ul>
1814
1935
  */
1815
1936
  KeyId: string | undefined;
1937
+ /**
1938
+ * <p>The ARN of the stream.</p>
1939
+ */
1940
+ StreamARN?: string;
1816
1941
  }
1817
1942
  /**
1818
1943
  * <p>The starting position in the data stream from which to start streaming.</p>
@@ -1820,19 +1945,19 @@ export interface StopStreamEncryptionInput {
1820
1945
  export interface StartingPosition {
1821
1946
  /**
1822
1947
  * <p>You can set the starting position to one of the following values:</p>
1823
- * <p>
1948
+ * <p>
1824
1949
  * <code>AT_SEQUENCE_NUMBER</code>: Start streaming from the position denoted by the
1825
1950
  * sequence number specified in the <code>SequenceNumber</code> field.</p>
1826
- * <p>
1951
+ * <p>
1827
1952
  * <code>AFTER_SEQUENCE_NUMBER</code>: Start streaming right after the position denoted
1828
1953
  * by the sequence number specified in the <code>SequenceNumber</code> field.</p>
1829
- * <p>
1954
+ * <p>
1830
1955
  * <code>AT_TIMESTAMP</code>: Start streaming from the position denoted by the time stamp
1831
1956
  * specified in the <code>Timestamp</code> field.</p>
1832
- * <p>
1957
+ * <p>
1833
1958
  * <code>TRIM_HORIZON</code>: Start streaming at the last untrimmed record in the shard,
1834
1959
  * which is the oldest data record in the shard.</p>
1835
- * <p>
1960
+ * <p>
1836
1961
  * <code>LATEST</code>: Start streaming just after the most recent record in the shard,
1837
1962
  * so that you always read the most recent data in the shard.</p>
1838
1963
  */
@@ -2118,25 +2243,25 @@ export interface UpdateShardCountInput {
2118
2243
  /**
2119
2244
  * <p>The name of the stream.</p>
2120
2245
  */
2121
- StreamName: string | undefined;
2246
+ StreamName?: string;
2122
2247
  /**
2123
2248
  * <p>The new number of shards. This value has the following default limits. By default, you
2124
2249
  * cannot do the following: </p>
2125
- * <ul>
2250
+ * <ul>
2126
2251
  * <li>
2127
- * <p>Set this value to more than double your current shard count for a
2252
+ * <p>Set this value to more than double your current shard count for a
2128
2253
  * stream.</p>
2129
2254
  * </li>
2130
2255
  * <li>
2131
- * <p>Set this value below half your current shard count for a stream.</p>
2256
+ * <p>Set this value below half your current shard count for a stream.</p>
2132
2257
  * </li>
2133
2258
  * <li>
2134
- * <p>Set this value to more than 10000 shards in a stream (the default limit for
2259
+ * <p>Set this value to more than 10000 shards in a stream (the default limit for
2135
2260
  * shard count per stream is 10000 per account per region), unless you request a
2136
2261
  * limit increase.</p>
2137
2262
  * </li>
2138
2263
  * <li>
2139
- * <p>Scale a stream with more than 10000 shards down unless you set this value to
2264
+ * <p>Scale a stream with more than 10000 shards down unless you set this value to
2140
2265
  * less than 10000 shards.</p>
2141
2266
  * </li>
2142
2267
  * </ul>
@@ -2146,6 +2271,10 @@ export interface UpdateShardCountInput {
2146
2271
  * <p>The scaling type. Uniform scaling creates shards of equal size.</p>
2147
2272
  */
2148
2273
  ScalingType: ScalingType | string | undefined;
2274
+ /**
2275
+ * <p>The ARN of the stream.</p>
2276
+ */
2277
+ StreamARN?: string;
2149
2278
  }
2150
2279
  export interface UpdateShardCountOutput {
2151
2280
  /**
@@ -2160,6 +2289,10 @@ export interface UpdateShardCountOutput {
2160
2289
  * <p>The updated number of shards.</p>
2161
2290
  */
2162
2291
  TargetShardCount?: number;
2292
+ /**
2293
+ * <p>The ARN of the stream.</p>
2294
+ */
2295
+ StreamARN?: string;
2163
2296
  }
2164
2297
  export interface UpdateStreamModeInput {
2165
2298
  /**
@@ -2324,6 +2457,10 @@ export declare const ListStreamConsumersOutputFilterSensitiveLog: (obj: ListStre
2324
2457
  * @internal
2325
2458
  */
2326
2459
  export declare const ListStreamsInputFilterSensitiveLog: (obj: ListStreamsInput) => any;
2460
+ /**
2461
+ * @internal
2462
+ */
2463
+ export declare const StreamSummaryFilterSensitiveLog: (obj: StreamSummary) => any;
2327
2464
  /**
2328
2465
  * @internal
2329
2466
  */