@aws-sdk/client-kinesis 3.40.0 → 3.44.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 (55) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +2 -2
  3. package/dist-cjs/Kinesis.js +15 -0
  4. package/dist-cjs/commands/UpdateStreamModeCommand.js +36 -0
  5. package/dist-cjs/commands/index.js +1 -0
  6. package/dist-cjs/endpoints.js +8 -0
  7. package/dist-cjs/models/models_0.js +25 -2
  8. package/dist-cjs/protocols/Aws_json1_1.js +151 -2
  9. package/dist-es/Kinesis.js +15 -0
  10. package/dist-es/commands/UpdateStreamModeCommand.js +39 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/endpoints.js +8 -0
  13. package/dist-es/models/models_0.js +17 -0
  14. package/dist-es/protocols/Aws_json1_1.js +189 -35
  15. package/dist-types/Kinesis.d.ts +165 -143
  16. package/dist-types/KinesisClient.d.ts +5 -4
  17. package/dist-types/commands/AddTagsToStreamCommand.d.ts +3 -5
  18. package/dist-types/commands/CreateStreamCommand.d.ts +20 -20
  19. package/dist-types/commands/DecreaseStreamRetentionPeriodCommand.d.ts +6 -6
  20. package/dist-types/commands/DeleteStreamCommand.d.ts +6 -5
  21. package/dist-types/commands/DeregisterStreamConsumerCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeLimitsCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeStreamCommand.d.ts +6 -2
  24. package/dist-types/commands/DescribeStreamConsumerCommand.d.ts +1 -1
  25. package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +6 -6
  26. package/dist-types/commands/DisableEnhancedMonitoringCommand.d.ts +1 -1
  27. package/dist-types/commands/EnableEnhancedMonitoringCommand.d.ts +1 -1
  28. package/dist-types/commands/GetRecordsCommand.d.ts +30 -20
  29. package/dist-types/commands/GetShardIteratorCommand.d.ts +8 -8
  30. package/dist-types/commands/IncreaseStreamRetentionPeriodCommand.d.ts +4 -4
  31. package/dist-types/commands/ListShardsCommand.d.ts +5 -3
  32. package/dist-types/commands/ListStreamConsumersCommand.d.ts +1 -1
  33. package/dist-types/commands/ListStreamsCommand.d.ts +2 -2
  34. package/dist-types/commands/ListTagsForStreamCommand.d.ts +1 -1
  35. package/dist-types/commands/MergeShardsCommand.d.ts +6 -6
  36. package/dist-types/commands/PutRecordCommand.d.ts +9 -9
  37. package/dist-types/commands/PutRecordsCommand.d.ts +8 -8
  38. package/dist-types/commands/RegisterStreamConsumerCommand.d.ts +1 -1
  39. package/dist-types/commands/RemoveTagsFromStreamCommand.d.ts +1 -1
  40. package/dist-types/commands/SplitShardCommand.d.ts +18 -20
  41. package/dist-types/commands/StartStreamEncryptionCommand.d.ts +11 -11
  42. package/dist-types/commands/StopStreamEncryptionCommand.d.ts +9 -10
  43. package/dist-types/commands/SubscribeToShardCommand.d.ts +4 -3
  44. package/dist-types/commands/UpdateShardCountCommand.d.ts +11 -12
  45. package/dist-types/commands/UpdateStreamModeCommand.d.ts +38 -0
  46. package/dist-types/commands/index.d.ts +1 -0
  47. package/dist-types/models/models_0.d.ts +333 -152
  48. package/dist-types/protocols/Aws_json1_1.d.ts +3 -0
  49. package/dist-types/ts3.4/Kinesis.d.ts +5 -0
  50. package/dist-types/ts3.4/KinesisClient.d.ts +3 -2
  51. package/dist-types/ts3.4/commands/UpdateStreamModeCommand.d.ts +17 -0
  52. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  53. package/dist-types/ts3.4/models/models_0.d.ts +54 -1
  54. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +3 -0
  55. package/package.json +4 -4
@@ -39,8 +39,8 @@ export declare namespace InvalidArgumentException {
39
39
  const filterSensitiveLog: (obj: InvalidArgumentException) => any;
40
40
  }
41
41
  /**
42
- * <p>The requested resource exceeds the maximum number allowed, or the number of
43
- * concurrent stream requests exceeds the maximum number allowed. </p>
42
+ * <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
43
+ * stream requests exceeds the maximum number allowed. </p>
44
44
  */
45
45
  export interface LimitExceededException extends __SmithyException, $MetadataBearer {
46
46
  name: "LimitExceededException";
@@ -112,8 +112,18 @@ export declare namespace HashKeyRange {
112
112
  */
113
113
  const filterSensitiveLog: (obj: HashKeyRange) => any;
114
114
  }
115
+ /**
116
+ * <p>Output parameter of the GetRecords API. The existing child shard of the current
117
+ * shard.</p>
118
+ */
115
119
  export interface ChildShard {
120
+ /**
121
+ * <p>The shard ID of the existing child shard of the current shard.</p>
122
+ */
116
123
  ShardId: string | undefined;
124
+ /**
125
+ * <p>The current shard that is the parent of the existing child shard.</p>
126
+ */
117
127
  ParentShards: string[] | undefined;
118
128
  /**
119
129
  * <p>The range of possible hash key values for the shard, which is a set of ordered
@@ -204,15 +214,36 @@ export declare namespace ConsumerDescription {
204
214
  */
205
215
  const filterSensitiveLog: (obj: ConsumerDescription) => any;
206
216
  }
217
+ export declare enum StreamMode {
218
+ ON_DEMAND = "ON_DEMAND",
219
+ PROVISIONED = "PROVISIONED"
220
+ }
221
+ /**
222
+ * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
223
+ * 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>
224
+ */
225
+ export interface StreamModeDetails {
226
+ /**
227
+ * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
228
+ * 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>
229
+ */
230
+ StreamMode: StreamMode | string | undefined;
231
+ }
232
+ export declare namespace StreamModeDetails {
233
+ /**
234
+ * @internal
235
+ */
236
+ const filterSensitiveLog: (obj: StreamModeDetails) => any;
237
+ }
207
238
  /**
208
239
  * <p>Represents the input for <code>CreateStream</code>.</p>
209
240
  */
210
241
  export interface CreateStreamInput {
211
242
  /**
212
- * <p>A name to identify the stream. The stream name is scoped to the AWS account used by
213
- * the application that creates the stream. It is also scoped by AWS Region. That is, two
214
- * streams in two different AWS accounts can have the same name. Two streams in the same
215
- * AWS account but in two different Regions can also have the same name.</p>
243
+ * <p>A name to identify the stream. The stream name is scoped to the Amazon Web Services
244
+ * 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
245
+ * can have the same name. Two streams in the same Amazon Web Services account but in two
246
+ * different Regions can also have the same name.</p>
216
247
  */
217
248
  StreamName: string | undefined;
218
249
  /**
@@ -220,7 +251,14 @@ export interface CreateStreamInput {
220
251
  * function of the number of shards; more shards are required for greater provisioned
221
252
  * throughput.</p>
222
253
  */
223
- ShardCount: number | undefined;
254
+ ShardCount?: number;
255
+ /**
256
+ * <p> Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,
257
+ * you can choose between an <b>on-demand</b> capacity mode and a
258
+ * <b>provisioned</b> capacity mode for your data
259
+ * streams.</p>
260
+ */
261
+ StreamModeDetails?: StreamModeDetails;
224
262
  }
225
263
  export declare namespace CreateStreamInput {
226
264
  /**
@@ -272,7 +310,8 @@ export declare namespace DeleteStreamInput {
272
310
  export interface DeregisterStreamConsumerInput {
273
311
  /**
274
312
  * <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
275
- * 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 AWS Service Namespaces</a>.</p>
313
+ * 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
314
+ * Namespaces</a>.</p>
276
315
  */
277
316
  StreamARN?: string;
278
317
  /**
@@ -311,6 +350,14 @@ export interface DescribeLimitsOutput {
311
350
  * <p>The number of open shards.</p>
312
351
  */
313
352
  OpenShardCount: number | undefined;
353
+ /**
354
+ * <p> Indicates the number of data streams with the on-demand capacity mode.</p>
355
+ */
356
+ OnDemandStreamCount: number | undefined;
357
+ /**
358
+ * <p> The maximum number of data streams with the on-demand capacity mode. </p>
359
+ */
360
+ OnDemandStreamCountLimit: number | undefined;
314
361
  }
315
362
  export declare namespace DescribeLimitsOutput {
316
363
  /**
@@ -327,12 +374,17 @@ export interface DescribeStreamInput {
327
374
  */
328
375
  StreamName: string | undefined;
329
376
  /**
330
- * <p>The maximum number of shards to return in a single call. The default value is 100.
331
- * If you specify a value greater than 100, at most 100 shards are returned.</p>
377
+ * <p>The maximum number of shards to return in a single call. The default value is 100. If
378
+ * you specify a value greater than 100, at most 100 results are returned.</p>
332
379
  */
333
380
  Limit?: number;
334
381
  /**
335
382
  * <p>The shard ID of the shard to start with.</p>
383
+ * <p>Specify this parameter to indicate that you want to describe the stream starting with
384
+ * the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
385
+ * <p>If you don't specify this parameter, the default behavior for
386
+ * <code>DescribeStream</code> is to describe the stream starting with the first shard
387
+ * in the stream.</p>
336
388
  */
337
389
  ExclusiveStartShardId?: string;
338
390
  }
@@ -362,8 +414,8 @@ export declare enum MetricsName {
362
414
  export interface EnhancedMetrics {
363
415
  /**
364
416
  * <p>List of shard-level metrics.</p>
365
- * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>"
366
- * enhances every metric.</p>
417
+ * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enhances
418
+ * every metric.</p>
367
419
  * <ul>
368
420
  * <li>
369
421
  * <p>
@@ -519,6 +571,11 @@ export interface StreamDescription {
519
571
  * </ul>
520
572
  */
521
573
  StreamStatus: StreamStatus | string | undefined;
574
+ /**
575
+ * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
576
+ * 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>
577
+ */
578
+ StreamModeDetails?: StreamModeDetails;
522
579
  /**
523
580
  * <p>The shards that comprise the stream.</p>
524
581
  */
@@ -542,8 +599,8 @@ export interface StreamDescription {
542
599
  */
543
600
  EnhancedMonitoring: EnhancedMetrics[] | undefined;
544
601
  /**
545
- * <p>The server-side encryption type used on the stream. This parameter can be one of
546
- * the following values:</p>
602
+ * <p>The server-side encryption type used on the stream. This parameter can be one of the
603
+ * following values:</p>
547
604
  * <ul>
548
605
  * <li>
549
606
  * <p>
@@ -552,16 +609,16 @@ export interface StreamDescription {
552
609
  * <li>
553
610
  * <p>
554
611
  * <code>KMS</code>: Use server-side encryption on the records in the stream
555
- * using a customer-managed AWS KMS key.</p>
612
+ * using a customer-managed Amazon Web Services KMS key.</p>
556
613
  * </li>
557
614
  * </ul>
558
615
  */
559
616
  EncryptionType?: EncryptionType | string;
560
617
  /**
561
- * <p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can
562
- * be a globally unique identifier, a fully specified ARN to either an alias or a key, or
563
- * an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data
564
- * Streams by specifying the alias <code>aws/kinesis</code>.</p>
618
+ * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
619
+ * This value can be a globally unique identifier, a fully specified ARN to either an alias
620
+ * or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
621
+ * Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
565
622
  * <ul>
566
623
  * <li>
567
624
  * <p>Key ARN example:
@@ -602,8 +659,8 @@ export declare namespace StreamDescription {
602
659
  */
603
660
  export interface DescribeStreamOutput {
604
661
  /**
605
- * <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array
606
- * of shard objects that comprise the stream, and whether there are more shards
662
+ * <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of
663
+ * shard objects that comprise the stream, and whether there are more shards
607
664
  * available.</p>
608
665
  */
609
666
  StreamDescription: StreamDescription | undefined;
@@ -617,7 +674,8 @@ export declare namespace DescribeStreamOutput {
617
674
  export interface DescribeStreamConsumerInput {
618
675
  /**
619
676
  * <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
620
- * 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 AWS Service Namespaces</a>.</p>
677
+ * 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
678
+ * Namespaces</a>.</p>
621
679
  */
622
680
  StreamARN?: string;
623
681
  /**
@@ -703,6 +761,11 @@ export interface StreamDescriptionSummary {
703
761
  * </ul>
704
762
  */
705
763
  StreamStatus: StreamStatus | string | undefined;
764
+ /**
765
+ * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
766
+ * 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>
767
+ */
768
+ StreamModeDetails?: StreamModeDetails;
706
769
  /**
707
770
  * <p>The current retention period, in hours.</p>
708
771
  */
@@ -732,10 +795,10 @@ export interface StreamDescriptionSummary {
732
795
  */
733
796
  EncryptionType?: EncryptionType | string;
734
797
  /**
735
- * <p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can
736
- * be a globally unique identifier, a fully specified ARN to either an alias or a key, or
737
- * an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data
738
- * Streams by specifying the alias <code>aws/kinesis</code>.</p>
798
+ * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
799
+ * This value can be a globally unique identifier, a fully specified ARN to either an alias
800
+ * or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
801
+ * Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
739
802
  * <ul>
740
803
  * <li>
741
804
  * <p>Key ARN example:
@@ -797,14 +860,13 @@ export declare namespace DescribeStreamSummaryOutput {
797
860
  */
798
861
  export interface DisableEnhancedMonitoringInput {
799
862
  /**
800
- * <p>The name of the Kinesis data stream for which to disable enhanced
801
- * monitoring.</p>
863
+ * <p>The name of the Kinesis data stream for which to disable enhanced monitoring.</p>
802
864
  */
803
865
  StreamName: string | undefined;
804
866
  /**
805
867
  * <p>List of shard-level metrics to disable.</p>
806
- * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>"
807
- * disables every metric.</p>
868
+ * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" disables
869
+ * every metric.</p>
808
870
  * <ul>
809
871
  * <li>
810
872
  * <p>
@@ -868,13 +930,13 @@ export interface EnhancedMonitoringOutput {
868
930
  */
869
931
  StreamName?: string;
870
932
  /**
871
- * <p>Represents the current state of the metrics that are in the enhanced state before
872
- * the operation.</p>
933
+ * <p>Represents the current state of the metrics that are in the enhanced state before the
934
+ * operation.</p>
873
935
  */
874
936
  CurrentShardLevelMetrics?: (MetricsName | string)[];
875
937
  /**
876
- * <p>Represents the list of all the metrics that would be in the enhanced state after
877
- * the operation.</p>
938
+ * <p>Represents the list of all the metrics that would be in the enhanced state after the
939
+ * operation.</p>
878
940
  */
879
941
  DesiredShardLevelMetrics?: (MetricsName | string)[];
880
942
  }
@@ -894,8 +956,8 @@ export interface EnableEnhancedMonitoringInput {
894
956
  StreamName: string | undefined;
895
957
  /**
896
958
  * <p>List of shard-level metrics to enable.</p>
897
- * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>"
898
- * enables every metric.</p>
959
+ * <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enables
960
+ * every metric.</p>
899
961
  * <ul>
900
962
  * <li>
901
963
  * <p>
@@ -1005,8 +1067,8 @@ export declare namespace GetRecordsInput {
1005
1067
  const filterSensitiveLog: (obj: GetRecordsInput) => any;
1006
1068
  }
1007
1069
  /**
1008
- * <p>The unit of data of the Kinesis data stream, which is composed of a sequence
1009
- * number, a partition key, and a data blob.</p>
1070
+ * <p>The unit of data of the Kinesis data stream, which is composed of a sequence number, a
1071
+ * partition key, and a data blob.</p>
1010
1072
  */
1011
1073
  export interface _Record {
1012
1074
  /**
@@ -1039,7 +1101,7 @@ export interface _Record {
1039
1101
  * <li>
1040
1102
  * <p>
1041
1103
  * <code>KMS</code>: Use server-side encryption on the records in the stream
1042
- * using a customer-managed AWS KMS key.</p>
1104
+ * using a customer-managed Amazon Web Services KMS key.</p>
1043
1105
  * </li>
1044
1106
  * </ul>
1045
1107
  */
@@ -1060,18 +1122,22 @@ export interface GetRecordsOutput {
1060
1122
  */
1061
1123
  Records: _Record[] | undefined;
1062
1124
  /**
1063
- * <p>The next position in the shard from which to start sequentially reading data
1064
- * records. If set to <code>null</code>, the shard has been closed and the requested
1065
- * iterator does not return any more data. </p>
1125
+ * <p>The next position in the shard from which to start sequentially reading data records.
1126
+ * If set to <code>null</code>, the shard has been closed and the requested iterator does
1127
+ * not return any more data. </p>
1066
1128
  */
1067
1129
  NextShardIterator?: string;
1068
1130
  /**
1069
- * <p>The number of milliseconds the <a>GetRecords</a> response is from the
1070
- * tip of the stream, indicating how far behind current time the consumer is. A value of
1071
- * zero indicates that record processing is caught up, and there are no new records to
1072
- * process at this moment.</p>
1131
+ * <p>The number of milliseconds the <a>GetRecords</a> response is from the tip
1132
+ * of the stream, indicating how far behind current time the consumer is. A value of zero
1133
+ * indicates that record processing is caught up, and there are no new records to process
1134
+ * at this moment.</p>
1073
1135
  */
1074
1136
  MillisBehindLatest?: number;
1137
+ /**
1138
+ * <p>The list of the current shard's child shards, returned in the <code>GetRecords</code>
1139
+ * API's response only when the end of the current shard is reached.</p>
1140
+ */
1075
1141
  ChildShards?: ChildShard[];
1076
1142
  }
1077
1143
  export declare namespace GetRecordsOutput {
@@ -1117,10 +1183,10 @@ export declare namespace KMSDisabledException {
1117
1183
  const filterSensitiveLog: (obj: KMSDisabledException) => any;
1118
1184
  }
1119
1185
  /**
1120
- * <p>The request was rejected because the state of the specified resource isn't valid
1121
- * for 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
1122
- * Customer Master Key</a> in the <i>AWS Key Management Service Developer
1123
- * Guide</i>.</p>
1186
+ * <p>The request was rejected because the state of the specified resource isn't valid for
1187
+ * 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
1188
+ * Customer Master Key</a> in the <i>Amazon Web Services Key Management
1189
+ * Service Developer Guide</i>.</p>
1124
1190
  */
1125
1191
  export interface KMSInvalidStateException extends __SmithyException, $MetadataBearer {
1126
1192
  name: "KMSInvalidStateException";
@@ -1155,7 +1221,7 @@ export declare namespace KMSNotFoundException {
1155
1221
  const filterSensitiveLog: (obj: KMSNotFoundException) => any;
1156
1222
  }
1157
1223
  /**
1158
- * <p>The AWS access key ID needs a subscription for the service.</p>
1224
+ * <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
1159
1225
  */
1160
1226
  export interface KMSOptInRequired extends __SmithyException, $MetadataBearer {
1161
1227
  name: "KMSOptInRequired";
@@ -1174,7 +1240,8 @@ export declare namespace KMSOptInRequired {
1174
1240
  /**
1175
1241
  * <p>The request was denied due to request throttling. For more information about
1176
1242
  * throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
1177
- * the <i>AWS Key Management Service Developer Guide</i>.</p>
1243
+ * the <i>Amazon Web Services Key Management Service Developer
1244
+ * Guide</i>.</p>
1178
1245
  */
1179
1246
  export interface KMSThrottlingException extends __SmithyException, $MetadataBearer {
1180
1247
  name: "KMSThrottlingException";
@@ -1195,8 +1262,7 @@ export declare namespace KMSThrottlingException {
1195
1262
  * the available throughput. Reduce the frequency or size of your requests. For more
1196
1263
  * information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Streams Limits</a> in the
1197
1264
  * <i>Amazon Kinesis Data Streams Developer Guide</i>, and <a href="https://docs.aws.amazon.com/general/latest/gr/api-retries.html">Error Retries and
1198
- * Exponential Backoff in AWS</a> in the <i>AWS General
1199
- * Reference</i>.</p>
1265
+ * Exponential Backoff in Amazon Web Services</a> in the <i>Amazon Web Services General Reference</i>.</p>
1200
1266
  */
1201
1267
  export interface ProvisionedThroughputExceededException extends __SmithyException, $MetadataBearer {
1202
1268
  name: "ProvisionedThroughputExceededException";
@@ -1255,20 +1321,20 @@ export interface GetShardIteratorInput {
1255
1321
  * </li>
1256
1322
  * <li>
1257
1323
  *
1258
- * <p>TRIM_HORIZON - Start reading at the last untrimmed record in the shard in
1259
- * the system, which is the oldest data record in the shard.</p>
1324
+ * <p>TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the
1325
+ * system, which is the oldest data record in the shard.</p>
1260
1326
  * </li>
1261
1327
  * <li>
1262
1328
  *
1263
- * <p>LATEST - Start reading just after the most recent record in the shard, so
1264
- * that you always read the most recent data in the shard.</p>
1329
+ * <p>LATEST - Start reading just after the most recent record in the shard, so that
1330
+ * you always read the most recent data in the shard.</p>
1265
1331
  * </li>
1266
1332
  * </ul>
1267
1333
  */
1268
1334
  ShardIteratorType: ShardIteratorType | string | undefined;
1269
1335
  /**
1270
- * <p>The sequence number of the data record in the shard from which to start reading.
1271
- * Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.</p>
1336
+ * <p>The sequence number of the data record in the shard from which to start reading. Used
1337
+ * with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.</p>
1272
1338
  */
1273
1339
  StartingSequenceNumber?: string;
1274
1340
  /**
@@ -1348,9 +1414,67 @@ export declare enum ShardFilterType {
1348
1414
  FROM_TIMESTAMP = "FROM_TIMESTAMP",
1349
1415
  FROM_TRIM_HORIZON = "FROM_TRIM_HORIZON"
1350
1416
  }
1417
+ /**
1418
+ * <p>The request parameter used to filter out the response of the <code>ListShards</code>
1419
+ * API.</p>
1420
+ */
1351
1421
  export interface ShardFilter {
1422
+ /**
1423
+ * <p>The shard type specified in the <code>ShardFilter</code> parameter. This is a required
1424
+ * property of the <code>ShardFilter</code> parameter.</p>
1425
+ * <p>You can specify the following valid values: </p>
1426
+ * <ul>
1427
+ * <li>
1428
+ * <p>
1429
+ * <code>AFTER_SHARD_ID</code> - the response includes all the shards, starting
1430
+ * with the shard whose ID immediately follows the <code>ShardId</code> that you
1431
+ * provided. </p>
1432
+ * </li>
1433
+ * <li>
1434
+ * <p>
1435
+ * <code>AT_TRIM_HORIZON</code> - the response includes all the shards that were
1436
+ * open at <code>TRIM_HORIZON</code>.</p>
1437
+ * </li>
1438
+ * <li>
1439
+ * <p>
1440
+ * <code>FROM_TRIM_HORIZON</code> - (default), the response includes all the
1441
+ * shards within the retention period of the data stream (trim to tip).</p>
1442
+ * </li>
1443
+ * <li>
1444
+ * <p>
1445
+ * <code>AT_LATEST</code> - the response includes only the currently open shards
1446
+ * of the data stream.</p>
1447
+ * </li>
1448
+ * <li>
1449
+ * <p>
1450
+ * <code>AT_TIMESTAMP</code> - the response includes all shards whose start
1451
+ * timestamp is less than or equal to the given timestamp and end timestamp is
1452
+ * greater than or equal to the given timestamp or still open. </p>
1453
+ * </li>
1454
+ * <li>
1455
+ * <p>
1456
+ * <code>FROM_TIMESTAMP</code> - the response incldues all closed shards whose
1457
+ * end timestamp is greater than or equal to the given timestamp and also all open
1458
+ * shards. Corrected to <code>TRIM_HORIZON</code> of the data stream if
1459
+ * <code>FROM_TIMESTAMP</code> is less than the <code>TRIM_HORIZON</code>
1460
+ * value.</p>
1461
+ * </li>
1462
+ * </ul>
1463
+ */
1352
1464
  Type: ShardFilterType | string | undefined;
1465
+ /**
1466
+ * <p>The exclusive start <code>shardID</code> speified in the <code>ShardFilter</code>
1467
+ * parameter. This property can only be used if the <code>AFTER_SHARD_ID</code> shard type
1468
+ * is specified.</p>
1469
+ */
1353
1470
  ShardId?: string;
1471
+ /**
1472
+ * <p>The timestamps specified in the <code>ShardFilter</code> parameter. A timestamp is a
1473
+ * Unix epoch date with precision in milliseconds. For example,
1474
+ * 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if
1475
+ * <code>FROM_TIMESTAMP</code> or <code>AT_TIMESTAMP</code> shard types are
1476
+ * specified.</p>
1477
+ */
1354
1478
  Timestamp?: Date;
1355
1479
  }
1356
1480
  export declare namespace ShardFilter {
@@ -1367,18 +1491,18 @@ export interface ListShardsInput {
1367
1491
  */
1368
1492
  StreamName?: string;
1369
1493
  /**
1370
- * <p>When the number of shards in the data stream is greater than the default value for
1371
- * the <code>MaxResults</code> parameter, or if you explicitly specify a value for
1494
+ * <p>When the number of shards in the data stream is greater than the default value for the
1495
+ * <code>MaxResults</code> parameter, or if you explicitly specify a value for
1372
1496
  * <code>MaxResults</code> that is less than the number of shards in the data stream,
1373
1497
  * the response includes a pagination token named <code>NextToken</code>. You can specify
1374
1498
  * this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
1375
1499
  * list the next set of shards.</p>
1376
- * <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if
1377
- * you specify <code>NextToken</code> because the latter unambiguously identifies the
1500
+ * <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you
1501
+ * specify <code>NextToken</code> because the latter unambiguously identifies the
1378
1502
  * stream.</p>
1379
- * <p>You can optionally specify a value for the <code>MaxResults</code> parameter when
1380
- * you specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that
1381
- * is less than the number of shards that the operation returns if you don't specify
1503
+ * <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you
1504
+ * specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that is
1505
+ * less than the number of shards that the operation returns if you don't specify
1382
1506
  * <code>MaxResults</code>, the response will contain a new <code>NextToken</code>
1383
1507
  * value. You can use the new <code>NextToken</code> value in a subsequent call to the
1384
1508
  * <code>ListShards</code> operation.</p>
@@ -1386,14 +1510,13 @@ export interface ListShardsInput {
1386
1510
  * <p>Tokens expire after 300 seconds. When you obtain a value for
1387
1511
  * <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
1388
1512
  * have 300 seconds to use that value. If you specify an expired token in a call to
1389
- * <code>ListShards</code>, you get
1390
- * <code>ExpiredNextTokenException</code>.</p>
1513
+ * <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
1391
1514
  * </important>
1392
1515
  */
1393
1516
  NextToken?: string;
1394
1517
  /**
1395
- * <p>Specify this parameter to indicate that you want to list the shards starting with
1396
- * the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
1518
+ * <p>Specify this parameter to indicate that you want to list the shards starting with the
1519
+ * shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
1397
1520
  * <p>If you don't specify this parameter, the default behavior is for
1398
1521
  * <code>ListShards</code> to list the shards starting with the first one in the
1399
1522
  * stream.</p>
@@ -1402,8 +1525,8 @@ export interface ListShardsInput {
1402
1525
  ExclusiveStartShardId?: string;
1403
1526
  /**
1404
1527
  * <p>The maximum number of shards to return in a single call to <code>ListShards</code>.
1405
- * The minimum value you can specify for this parameter is 1, and the maximum is 10,000,
1406
- * which is also the default.</p>
1528
+ * The maximum number of shards to return in a single call. The default value is 1000. If
1529
+ * you specify a value greater than 1000, at most 1000 results are returned. </p>
1407
1530
  * <p>When the number of shards to be listed is greater than the value of
1408
1531
  * <code>MaxResults</code>, the response contains a <code>NextToken</code> value that
1409
1532
  * you can use in a subsequent call to <code>ListShards</code> to list the next set of
@@ -1411,14 +1534,34 @@ export interface ListShardsInput {
1411
1534
  */
1412
1535
  MaxResults?: number;
1413
1536
  /**
1414
- * <p>Specify this input parameter to distinguish data streams that have the same name.
1415
- * For example, if you create a data stream and then delete it, and you later create
1416
- * another data stream with the same name, you can use this input parameter to specify
1417
- * which of the two streams you want to list the shards for.</p>
1537
+ * <p>Specify this input parameter to distinguish data streams that have the same name. For
1538
+ * example, if you create a data stream and then delete it, and you later create another
1539
+ * data stream with the same name, you can use this input parameter to specify which of the
1540
+ * two streams you want to list the shards for.</p>
1418
1541
  * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1419
1542
  * parameter.</p>
1420
1543
  */
1421
1544
  StreamCreationTimestamp?: Date;
1545
+ /**
1546
+ * <p>Enables you to filter out the response of the <code>ListShards</code> API. You can
1547
+ * only specify one filter at a time. </p>
1548
+ * <p>If you use the <code>ShardFilter</code> parameter when invoking the ListShards API,
1549
+ * the <code>Type</code> is the required property and must be specified. If you specify the
1550
+ * <code>AT_TRIM_HORIZON</code>, <code>FROM_TRIM_HORIZON</code>, or
1551
+ * <code>AT_LATEST</code> types, you do not need to specify either the
1552
+ * <code>ShardId</code> or the <code>Timestamp</code> optional properties. </p>
1553
+ * <p>If you specify the <code>AFTER_SHARD_ID</code> type, you must also provide the value
1554
+ * for the optional <code>ShardId</code> property. The <code>ShardId</code> property is
1555
+ * identical in fuctionality to the <code>ExclusiveStartShardId</code> parameter of the
1556
+ * <code>ListShards</code> API. When <code>ShardId</code> property is specified, the
1557
+ * response includes the shards starting with the shard whose ID immediately follows the
1558
+ * <code>ShardId</code> that you provided. </p>
1559
+ * <p>If you specify the <code>AT_TIMESTAMP</code> or <code>FROM_TIMESTAMP_ID</code> type,
1560
+ * you must also provide the value for the optional <code>Timestamp</code> property. If you
1561
+ * specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp
1562
+ * are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the
1563
+ * provided timestamp to TIP are returned. </p>
1564
+ */
1422
1565
  ShardFilter?: ShardFilter;
1423
1566
  }
1424
1567
  export declare namespace ListShardsInput {
@@ -1436,8 +1579,8 @@ export interface ListShardsOutput {
1436
1579
  */
1437
1580
  Shards?: Shard[];
1438
1581
  /**
1439
- * <p>When the number of shards in the data stream is greater than the default value for
1440
- * the <code>MaxResults</code> parameter, or if you explicitly specify a value for
1582
+ * <p>When the number of shards in the data stream is greater than the default value for the
1583
+ * <code>MaxResults</code> parameter, or if you explicitly specify a value for
1441
1584
  * <code>MaxResults</code> that is less than the number of shards in the data stream,
1442
1585
  * the response includes a pagination token named <code>NextToken</code>. You can specify
1443
1586
  * this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
@@ -1447,8 +1590,7 @@ export interface ListShardsOutput {
1447
1590
  * <p>Tokens expire after 300 seconds. When you obtain a value for
1448
1591
  * <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
1449
1592
  * have 300 seconds to use that value. If you specify an expired token in a call to
1450
- * <code>ListShards</code>, you get
1451
- * <code>ExpiredNextTokenException</code>.</p>
1593
+ * <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
1452
1594
  * </important>
1453
1595
  */
1454
1596
  NextToken?: string;
@@ -1462,7 +1604,8 @@ export declare namespace ListShardsOutput {
1462
1604
  export interface ListStreamConsumersInput {
1463
1605
  /**
1464
1606
  * <p>The ARN of the Kinesis data stream for which you want to list the registered
1465
- * 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 AWS Service Namespaces</a>.</p>
1607
+ * 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
1608
+ * Namespaces</a>.</p>
1466
1609
  */
1467
1610
  StreamARN: string | undefined;
1468
1611
  /**
@@ -1493,7 +1636,8 @@ export interface ListStreamConsumersInput {
1493
1636
  NextToken?: string;
1494
1637
  /**
1495
1638
  * <p>The maximum number of consumers that you want a single call of
1496
- * <code>ListStreamConsumers</code> to return.</p>
1639
+ * <code>ListStreamConsumers</code> to return. The default value is 100. If you specify
1640
+ * a value greater than 100, at most 100 results are returned. </p>
1497
1641
  */
1498
1642
  MaxResults?: number;
1499
1643
  /**
@@ -1546,7 +1690,8 @@ export declare namespace ListStreamConsumersOutput {
1546
1690
  */
1547
1691
  export interface ListStreamsInput {
1548
1692
  /**
1549
- * <p>The maximum number of streams to list.</p>
1693
+ * <p>The maximum number of streams to list. The default value is 100. If you specify a
1694
+ * value greater than 100, at most 100 results are returned.</p>
1550
1695
  */
1551
1696
  Limit?: number;
1552
1697
  /**
@@ -1565,8 +1710,8 @@ export declare namespace ListStreamsInput {
1565
1710
  */
1566
1711
  export interface ListStreamsOutput {
1567
1712
  /**
1568
- * <p>The names of the streams that are associated with the AWS account making the
1569
- * <code>ListStreams</code> request.</p>
1713
+ * <p>The names of the streams that are associated with the Amazon Web Services account
1714
+ * making the <code>ListStreams</code> request.</p>
1570
1715
  */
1571
1716
  StreamNames: string[] | undefined;
1572
1717
  /**
@@ -1589,8 +1734,8 @@ export interface ListTagsForStreamInput {
1589
1734
  */
1590
1735
  StreamName: string | undefined;
1591
1736
  /**
1592
- * <p>The key to use as the starting point for the list of tags. If this parameter is
1593
- * set, <code>ListTagsForStream</code> gets all tags that occur after
1737
+ * <p>The key to use as the starting point for the list of tags. If this parameter is set,
1738
+ * <code>ListTagsForStream</code> gets all tags that occur after
1594
1739
  * <code>ExclusiveStartTagKey</code>. </p>
1595
1740
  */
1596
1741
  ExclusiveStartTagKey?: string;
@@ -1618,8 +1763,8 @@ export interface Tag {
1618
1763
  */
1619
1764
  Key: string | undefined;
1620
1765
  /**
1621
- * <p>An optional string, typically used to describe or define the tag. Maximum length:
1622
- * 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
1766
+ * <p>An optional string, typically used to describe or define the tag. Maximum length: 256
1767
+ * characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
1623
1768
  * @</p>
1624
1769
  */
1625
1770
  Value?: string;
@@ -1641,8 +1786,8 @@ export interface ListTagsForStreamOutput {
1641
1786
  */
1642
1787
  Tags: Tag[] | undefined;
1643
1788
  /**
1644
- * <p>If set to <code>true</code>, more tags are available. To request additional tags,
1645
- * set <code>ExclusiveStartTagKey</code> to the key of the last tag returned.</p>
1789
+ * <p>If set to <code>true</code>, more tags are available. To request additional tags, set
1790
+ * <code>ExclusiveStartTagKey</code> to the key of the last tag returned.</p>
1646
1791
  */
1647
1792
  HasMoreTags: boolean | undefined;
1648
1793
  }
@@ -1661,8 +1806,7 @@ export interface MergeShardsInput {
1661
1806
  */
1662
1807
  StreamName: string | undefined;
1663
1808
  /**
1664
- * <p>The shard ID of the shard to combine with the adjacent shard for the
1665
- * merge.</p>
1809
+ * <p>The shard ID of the shard to combine with the adjacent shard for the merge.</p>
1666
1810
  */
1667
1811
  ShardToMerge: string | undefined;
1668
1812
  /**
@@ -1676,6 +1820,22 @@ export declare namespace MergeShardsInput {
1676
1820
  */
1677
1821
  const filterSensitiveLog: (obj: MergeShardsInput) => any;
1678
1822
  }
1823
+ /**
1824
+ * <p>
1825
+ *
1826
+ * </p>
1827
+ */
1828
+ export interface ValidationException extends __SmithyException, $MetadataBearer {
1829
+ name: "ValidationException";
1830
+ $fault: "client";
1831
+ message?: string;
1832
+ }
1833
+ export declare namespace ValidationException {
1834
+ /**
1835
+ * @internal
1836
+ */
1837
+ const filterSensitiveLog: (obj: ValidationException) => any;
1838
+ }
1679
1839
  /**
1680
1840
  * <p>Represents the input for <code>PutRecord</code>.</p>
1681
1841
  */
@@ -1702,16 +1862,16 @@ export interface PutRecordInput {
1702
1862
  */
1703
1863
  PartitionKey: string | undefined;
1704
1864
  /**
1705
- * <p>The hash value used to explicitly determine the shard the data record is assigned
1706
- * to by overriding the partition key hash.</p>
1865
+ * <p>The hash value used to explicitly determine the shard the data record is assigned to
1866
+ * by overriding the partition key hash.</p>
1707
1867
  */
1708
1868
  ExplicitHashKey?: string;
1709
1869
  /**
1710
- * <p>Guarantees strictly increasing sequence numbers, for puts from the same client and
1711
- * to the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of
1712
- * record <i>n</i> to the sequence number of record <i>n-1</i>
1713
- * (as returned in the result when putting record <i>n-1</i>). If this
1714
- * parameter is not set, records are coarsely ordered based on arrival time.</p>
1870
+ * <p>Guarantees strictly increasing sequence numbers, for puts from the same client and to
1871
+ * the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of record
1872
+ * <i>n</i> to the sequence number of record <i>n-1</i> (as
1873
+ * returned in the result when putting record <i>n-1</i>). If this parameter
1874
+ * is not set, records are coarsely ordered based on arrival time.</p>
1715
1875
  */
1716
1876
  SequenceNumberForOrdering?: string;
1717
1877
  }
@@ -1730,14 +1890,14 @@ export interface PutRecordOutput {
1730
1890
  */
1731
1891
  ShardId: string | undefined;
1732
1892
  /**
1733
- * <p>The sequence number identifier that was assigned to the put data record. The
1734
- * sequence number for the record is unique across all records in the stream. A sequence
1735
- * number is the identifier associated with every record put into the stream.</p>
1893
+ * <p>The sequence number identifier that was assigned to the put data record. The sequence
1894
+ * number for the record is unique across all records in the stream. A sequence number is
1895
+ * the identifier associated with every record put into the stream.</p>
1736
1896
  */
1737
1897
  SequenceNumber: string | undefined;
1738
1898
  /**
1739
- * <p>The encryption type to use on the record. This parameter can be one of the
1740
- * following values:</p>
1899
+ * <p>The encryption type to use on the record. This parameter can be one of the following
1900
+ * values:</p>
1741
1901
  * <ul>
1742
1902
  * <li>
1743
1903
  * <p>
@@ -1746,7 +1906,7 @@ export interface PutRecordOutput {
1746
1906
  * <li>
1747
1907
  * <p>
1748
1908
  * <code>KMS</code>: Use server-side encryption on the records in the stream
1749
- * using a customer-managed AWS KMS key.</p>
1909
+ * using a customer-managed Amazon Web Services KMS key.</p>
1750
1910
  * </li>
1751
1911
  * </ul>
1752
1912
  */
@@ -1770,8 +1930,8 @@ export interface PutRecordsRequestEntry {
1770
1930
  */
1771
1931
  Data: Uint8Array | undefined;
1772
1932
  /**
1773
- * <p>The hash value used to determine explicitly the shard that the data record is
1774
- * assigned to by overriding the partition key hash.</p>
1933
+ * <p>The hash value used to determine explicitly the shard that the data record is assigned
1934
+ * to by overriding the partition key hash.</p>
1775
1935
  */
1776
1936
  ExplicitHashKey?: string;
1777
1937
  /**
@@ -1811,11 +1971,10 @@ export declare namespace PutRecordsInput {
1811
1971
  const filterSensitiveLog: (obj: PutRecordsInput) => any;
1812
1972
  }
1813
1973
  /**
1814
- * <p>Represents the result of an individual record from a <code>PutRecords</code>
1815
- * request. A record that is successfully added to a stream includes
1816
- * <code>SequenceNumber</code> and <code>ShardId</code> in the result. A record that
1817
- * fails to be added to the stream includes <code>ErrorCode</code> and
1818
- * <code>ErrorMessage</code> in the result.</p>
1974
+ * <p>Represents the result of an individual record from a <code>PutRecords</code> request.
1975
+ * A record that is successfully added to a stream includes <code>SequenceNumber</code> and
1976
+ * <code>ShardId</code> in the result. A record that fails to be added to the stream
1977
+ * includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result.</p>
1819
1978
  */
1820
1979
  export interface PutRecordsResultEntry {
1821
1980
  /**
@@ -1827,14 +1986,14 @@ export interface PutRecordsResultEntry {
1827
1986
  */
1828
1987
  ShardId?: string;
1829
1988
  /**
1830
- * <p>The error code for an individual record result. <code>ErrorCodes</code> can be
1831
- * either <code>ProvisionedThroughputExceededException</code> or
1832
- * <code>InternalFailure</code>.</p>
1989
+ * <p>The error code for an individual record result. <code>ErrorCodes</code> can be either
1990
+ * <code>ProvisionedThroughputExceededException</code> or
1991
+ * <code>InternalFailure</code>.</p>
1833
1992
  */
1834
1993
  ErrorCode?: string;
1835
1994
  /**
1836
- * <p>The error message for an individual record result. An <code>ErrorCode</code> value
1837
- * of <code>ProvisionedThroughputExceededException</code> has an error message that
1995
+ * <p>The error message for an individual record result. An <code>ErrorCode</code> value of
1996
+ * <code>ProvisionedThroughputExceededException</code> has an error message that
1838
1997
  * includes the account ID, stream name, and shard ID. An <code>ErrorCode</code> value of
1839
1998
  * <code>InternalFailure</code> has the error message <code>"Internal Service
1840
1999
  * Failure"</code>.</p>
@@ -1858,11 +2017,10 @@ export interface PutRecordsOutput {
1858
2017
  */
1859
2018
  FailedRecordCount?: number;
1860
2019
  /**
1861
- * <p>An array of successfully and unsuccessfully processed record results, correlated
1862
- * with the request by natural ordering. A record that is successfully added to a stream
1863
- * includes <code>SequenceNumber</code> and <code>ShardId</code> in the result. A record
1864
- * that fails to be added to a stream includes <code>ErrorCode</code> and
1865
- * <code>ErrorMessage</code> in the result.</p>
2020
+ * <p>An array of successfully and unsuccessfully processed record results. A record that is
2021
+ * successfully added to a stream includes <code>SequenceNumber</code> and
2022
+ * <code>ShardId</code> in the result. A record that fails to be added to a stream
2023
+ * includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result.</p>
1866
2024
  */
1867
2025
  Records: PutRecordsResultEntry[] | undefined;
1868
2026
  /**
@@ -1876,7 +2034,7 @@ export interface PutRecordsOutput {
1876
2034
  * <li>
1877
2035
  * <p>
1878
2036
  * <code>KMS</code>: Use server-side encryption on the records using a
1879
- * customer-managed AWS KMS key.</p>
2037
+ * customer-managed Amazon Web Services KMS key.</p>
1880
2038
  * </li>
1881
2039
  * </ul>
1882
2040
  */
@@ -1891,7 +2049,8 @@ export declare namespace PutRecordsOutput {
1891
2049
  export interface RegisterStreamConsumerInput {
1892
2050
  /**
1893
2051
  * <p>The ARN of the Kinesis data stream that you want to register the consumer with. For
1894
- * 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 AWS Service Namespaces</a>.</p>
2052
+ * 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
2053
+ * Namespaces</a>.</p>
1895
2054
  */
1896
2055
  StreamARN: string | undefined;
1897
2056
  /**
@@ -1951,8 +2110,8 @@ export interface SplitShardInput {
1951
2110
  */
1952
2111
  ShardToSplit: string | undefined;
1953
2112
  /**
1954
- * <p>A hash key value for the starting hash key of one of the child shards created by
1955
- * the split. The hash key range for a given shard constitutes a set of ordered contiguous
2113
+ * <p>A hash key value for the starting hash key of one of the child shards created by the
2114
+ * split. The hash key range for a given shard constitutes a set of ordered contiguous
1956
2115
  * positive integers. The value for <code>NewStartingHashKey</code> must be in the range of
1957
2116
  * hash keys being mapped into the shard. The <code>NewStartingHashKey</code> hash key
1958
2117
  * value and all higher hash key values in hash key range are distributed to one of the
@@ -1977,11 +2136,11 @@ export interface StartStreamEncryptionInput {
1977
2136
  */
1978
2137
  EncryptionType: EncryptionType | string | undefined;
1979
2138
  /**
1980
- * <p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can
1981
- * be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either
1982
- * an alias or a key, or an alias name prefixed by "alias/".You can also use a master key
1983
- * owned by Kinesis Data Streams by specifying the alias
1984
- * <code>aws/kinesis</code>.</p>
2139
+ * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
2140
+ * This value can be a globally unique identifier, a fully specified Amazon Resource Name
2141
+ * (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
2142
+ * use a master key owned by Kinesis Data Streams by specifying the alias
2143
+ * <code>aws/kinesis</code>.</p>
1985
2144
  * <ul>
1986
2145
  * <li>
1987
2146
  * <p>Key ARN example:
@@ -2027,11 +2186,11 @@ export interface StopStreamEncryptionInput {
2027
2186
  */
2028
2187
  EncryptionType: EncryptionType | string | undefined;
2029
2188
  /**
2030
- * <p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can
2031
- * be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either
2032
- * an alias or a key, or an alias name prefixed by "alias/".You can also use a master key
2033
- * owned by Kinesis Data Streams by specifying the alias
2034
- * <code>aws/kinesis</code>.</p>
2189
+ * <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
2190
+ * This value can be a globally unique identifier, a fully specified Amazon Resource Name
2191
+ * (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
2192
+ * use a master key owned by Kinesis Data Streams by specifying the alias
2193
+ * <code>aws/kinesis</code>.</p>
2035
2194
  * <ul>
2036
2195
  * <li>
2037
2196
  * <p>Key ARN example:
@@ -2068,7 +2227,7 @@ export declare namespace StopStreamEncryptionInput {
2068
2227
  const filterSensitiveLog: (obj: StopStreamEncryptionInput) => any;
2069
2228
  }
2070
2229
  /**
2071
- * <p></p>
2230
+ * <p>The starting position in the data stream from which to start streaming.</p>
2072
2231
  */
2073
2232
  export interface StartingPosition {
2074
2233
  /**
@@ -2124,7 +2283,7 @@ export interface SubscribeToShardInput {
2124
2283
  */
2125
2284
  ShardId: string | undefined;
2126
2285
  /**
2127
- * <p></p>
2286
+ * <p>The starting position in the data stream from which to start streaming.</p>
2128
2287
  */
2129
2288
  StartingPosition: StartingPosition | undefined;
2130
2289
  }
@@ -2156,6 +2315,10 @@ export interface SubscribeToShardEvent {
2156
2315
  * processing is caught up, and there are no new records to process at this moment.</p>
2157
2316
  */
2158
2317
  MillisBehindLatest: number | undefined;
2318
+ /**
2319
+ * <p>The list of the child shards of the current shard, returned only at the end of the
2320
+ * current shard.</p>
2321
+ */
2159
2322
  ChildShards?: ChildShard[];
2160
2323
  }
2161
2324
  export declare namespace SubscribeToShardEvent {
@@ -2240,10 +2403,10 @@ export declare namespace SubscribeToShardEventStream {
2240
2403
  $unknown?: never;
2241
2404
  }
2242
2405
  /**
2243
- * <p>The request was rejected because the state of the specified resource isn't valid
2244
- * for 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
2245
- * Customer Master Key</a> in the <i>AWS Key Management Service Developer
2246
- * Guide</i>.</p>
2406
+ * <p>The request was rejected because the state of the specified resource isn't valid for
2407
+ * 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
2408
+ * Customer Master Key</a> in the <i>Amazon Web Services Key Management
2409
+ * Service Developer Guide</i>.</p>
2247
2410
  */
2248
2411
  interface KMSInvalidStateExceptionMember {
2249
2412
  SubscribeToShardEvent?: never;
@@ -2293,7 +2456,7 @@ export declare namespace SubscribeToShardEventStream {
2293
2456
  $unknown?: never;
2294
2457
  }
2295
2458
  /**
2296
- * <p>The AWS access key ID needs a subscription for the service.</p>
2459
+ * <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
2297
2460
  */
2298
2461
  interface KMSOptInRequiredMember {
2299
2462
  SubscribeToShardEvent?: never;
@@ -2311,7 +2474,8 @@ export declare namespace SubscribeToShardEventStream {
2311
2474
  /**
2312
2475
  * <p>The request was denied due to request throttling. For more information about
2313
2476
  * throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
2314
- * the <i>AWS Key Management Service Developer Guide</i>.</p>
2477
+ * the <i>Amazon Web Services Key Management Service Developer
2478
+ * Guide</i>.</p>
2315
2479
  */
2316
2480
  interface KMSThrottlingExceptionMember {
2317
2481
  SubscribeToShardEvent?: never;
@@ -2396,8 +2560,8 @@ export interface UpdateShardCountInput {
2396
2560
  */
2397
2561
  StreamName: string | undefined;
2398
2562
  /**
2399
- * <p>The new number of shards. This value has the following default limits. By default,
2400
- * you cannot do the following: </p>
2563
+ * <p>The new number of shards. This value has the following default limits. By default, you
2564
+ * cannot do the following: </p>
2401
2565
  * <ul>
2402
2566
  * <li>
2403
2567
  * <p>Set this value to more than double your current shard count for a
@@ -2407,13 +2571,13 @@ export interface UpdateShardCountInput {
2407
2571
  * <p>Set this value below half your current shard count for a stream.</p>
2408
2572
  * </li>
2409
2573
  * <li>
2410
- * <p>Set this value to more than 500 shards in a stream (the default limit for
2411
- * shard count per stream is 500 per account per region), unless you request a
2574
+ * <p>Set this value to more than 10000 shards in a stream (the default limit for
2575
+ * shard count per stream is 10000 per account per region), unless you request a
2412
2576
  * limit increase.</p>
2413
2577
  * </li>
2414
2578
  * <li>
2415
- * <p>Scale a stream with more than 500 shards down unless you set this value to
2416
- * less than 500 shards.</p>
2579
+ * <p>Scale a stream with more than 10000 shards down unless you set this value to
2580
+ * less than 10000 shards.</p>
2417
2581
  * </li>
2418
2582
  * </ul>
2419
2583
  */
@@ -2449,3 +2613,20 @@ export declare namespace UpdateShardCountOutput {
2449
2613
  */
2450
2614
  const filterSensitiveLog: (obj: UpdateShardCountOutput) => any;
2451
2615
  }
2616
+ export interface UpdateStreamModeInput {
2617
+ /**
2618
+ * <p> Specifies the ARN of the data stream whose capacity mode you want to update. </p>
2619
+ */
2620
+ StreamARN: string | undefined;
2621
+ /**
2622
+ * <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
2623
+ * 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>
2624
+ */
2625
+ StreamModeDetails: StreamModeDetails | undefined;
2626
+ }
2627
+ export declare namespace UpdateStreamModeInput {
2628
+ /**
2629
+ * @internal
2630
+ */
2631
+ const filterSensitiveLog: (obj: UpdateStreamModeInput) => any;
2632
+ }