@aws-sdk/client-kinesis 3.43.0 → 3.47.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.
- package/CHANGELOG.md +50 -0
- package/README.md +2 -2
- package/dist-cjs/Kinesis.js +15 -0
- package/dist-cjs/commands/UpdateStreamModeCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoints.js +1 -16
- package/dist-cjs/models/models_0.js +28 -95
- package/dist-cjs/protocols/Aws_json1_1.js +151 -2
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- package/dist-es/Kinesis.js +15 -0
- package/dist-es/commands/UpdateStreamModeCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoints.js +1 -16
- package/dist-es/models/models_0.js +22 -65
- package/dist-es/protocols/Aws_json1_1.js +189 -35
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/Kinesis.d.ts +165 -143
- package/dist-types/KinesisClient.d.ts +10 -5
- package/dist-types/commands/AddTagsToStreamCommand.d.ts +2 -4
- package/dist-types/commands/CreateStreamCommand.d.ts +19 -19
- package/dist-types/commands/DecreaseStreamRetentionPeriodCommand.d.ts +5 -5
- package/dist-types/commands/DeleteStreamCommand.d.ts +5 -4
- package/dist-types/commands/DescribeStreamCommand.d.ts +5 -1
- package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +5 -5
- package/dist-types/commands/GetRecordsCommand.d.ts +29 -19
- package/dist-types/commands/GetShardIteratorCommand.d.ts +7 -7
- package/dist-types/commands/IncreaseStreamRetentionPeriodCommand.d.ts +3 -3
- package/dist-types/commands/ListShardsCommand.d.ts +4 -2
- package/dist-types/commands/ListStreamsCommand.d.ts +1 -1
- package/dist-types/commands/MergeShardsCommand.d.ts +5 -5
- package/dist-types/commands/PutRecordCommand.d.ts +8 -8
- package/dist-types/commands/PutRecordsCommand.d.ts +7 -7
- package/dist-types/commands/SplitShardCommand.d.ts +17 -19
- package/dist-types/commands/StartStreamEncryptionCommand.d.ts +10 -10
- package/dist-types/commands/StopStreamEncryptionCommand.d.ts +8 -9
- package/dist-types/commands/SubscribeToShardCommand.d.ts +3 -2
- package/dist-types/commands/UpdateShardCountCommand.d.ts +10 -11
- package/dist-types/commands/UpdateStreamModeCommand.d.ts +38 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +327 -236
- package/dist-types/protocols/Aws_json1_1.d.ts +3 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/Kinesis.d.ts +5 -0
- package/dist-types/ts3.4/KinesisClient.d.ts +6 -3
- package/dist-types/ts3.4/commands/UpdateStreamModeCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +50 -57
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +3 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +42 -49
|
@@ -32,15 +32,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe
|
|
|
32
32
|
*/
|
|
33
33
|
message?: string;
|
|
34
34
|
}
|
|
35
|
-
export declare namespace InvalidArgumentException {
|
|
36
|
-
/**
|
|
37
|
-
* @internal
|
|
38
|
-
*/
|
|
39
|
-
const filterSensitiveLog: (obj: InvalidArgumentException) => any;
|
|
40
|
-
}
|
|
41
35
|
/**
|
|
42
|
-
* <p>The requested resource exceeds the maximum number allowed, or the number of
|
|
43
|
-
*
|
|
36
|
+
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
|
|
37
|
+
* stream requests exceeds the maximum number allowed. </p>
|
|
44
38
|
*/
|
|
45
39
|
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
46
40
|
name: "LimitExceededException";
|
|
@@ -50,12 +44,6 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
|
|
|
50
44
|
*/
|
|
51
45
|
message?: string;
|
|
52
46
|
}
|
|
53
|
-
export declare namespace LimitExceededException {
|
|
54
|
-
/**
|
|
55
|
-
* @internal
|
|
56
|
-
*/
|
|
57
|
-
const filterSensitiveLog: (obj: LimitExceededException) => any;
|
|
58
|
-
}
|
|
59
47
|
/**
|
|
60
48
|
* <p>The resource is not available for this operation. For successful operation, the
|
|
61
49
|
* resource must be in the <code>ACTIVE</code> state.</p>
|
|
@@ -68,12 +56,6 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear
|
|
|
68
56
|
*/
|
|
69
57
|
message?: string;
|
|
70
58
|
}
|
|
71
|
-
export declare namespace ResourceInUseException {
|
|
72
|
-
/**
|
|
73
|
-
* @internal
|
|
74
|
-
*/
|
|
75
|
-
const filterSensitiveLog: (obj: ResourceInUseException) => any;
|
|
76
|
-
}
|
|
77
59
|
/**
|
|
78
60
|
* <p>The requested resource could not be found. The stream might not be specified
|
|
79
61
|
* correctly.</p>
|
|
@@ -86,12 +68,6 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
|
|
|
86
68
|
*/
|
|
87
69
|
message?: string;
|
|
88
70
|
}
|
|
89
|
-
export declare namespace ResourceNotFoundException {
|
|
90
|
-
/**
|
|
91
|
-
* @internal
|
|
92
|
-
*/
|
|
93
|
-
const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
|
|
94
|
-
}
|
|
95
71
|
/**
|
|
96
72
|
* <p>The range of possible hash key values for the shard, which is a set of ordered
|
|
97
73
|
* contiguous positive integers.</p>
|
|
@@ -112,8 +88,18 @@ export declare namespace HashKeyRange {
|
|
|
112
88
|
*/
|
|
113
89
|
const filterSensitiveLog: (obj: HashKeyRange) => any;
|
|
114
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* <p>Output parameter of the GetRecords API. The existing child shard of the current
|
|
93
|
+
* shard.</p>
|
|
94
|
+
*/
|
|
115
95
|
export interface ChildShard {
|
|
96
|
+
/**
|
|
97
|
+
* <p>The shard ID of the existing child shard of the current shard.</p>
|
|
98
|
+
*/
|
|
116
99
|
ShardId: string | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The current shard that is the parent of the existing child shard.</p>
|
|
102
|
+
*/
|
|
117
103
|
ParentShards: string[] | undefined;
|
|
118
104
|
/**
|
|
119
105
|
* <p>The range of possible hash key values for the shard, which is a set of ordered
|
|
@@ -204,15 +190,36 @@ export declare namespace ConsumerDescription {
|
|
|
204
190
|
*/
|
|
205
191
|
const filterSensitiveLog: (obj: ConsumerDescription) => any;
|
|
206
192
|
}
|
|
193
|
+
export declare enum StreamMode {
|
|
194
|
+
ON_DEMAND = "ON_DEMAND",
|
|
195
|
+
PROVISIONED = "PROVISIONED"
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
199
|
+
* 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>
|
|
200
|
+
*/
|
|
201
|
+
export interface StreamModeDetails {
|
|
202
|
+
/**
|
|
203
|
+
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
204
|
+
* 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>
|
|
205
|
+
*/
|
|
206
|
+
StreamMode: StreamMode | string | undefined;
|
|
207
|
+
}
|
|
208
|
+
export declare namespace StreamModeDetails {
|
|
209
|
+
/**
|
|
210
|
+
* @internal
|
|
211
|
+
*/
|
|
212
|
+
const filterSensitiveLog: (obj: StreamModeDetails) => any;
|
|
213
|
+
}
|
|
207
214
|
/**
|
|
208
215
|
* <p>Represents the input for <code>CreateStream</code>.</p>
|
|
209
216
|
*/
|
|
210
217
|
export interface CreateStreamInput {
|
|
211
218
|
/**
|
|
212
|
-
* <p>A name to identify the stream. The stream name is scoped to the
|
|
213
|
-
* the application that creates the stream. It is also scoped by
|
|
214
|
-
*
|
|
215
|
-
*
|
|
219
|
+
* <p>A name to identify the stream. The stream name is scoped to the Amazon Web Services
|
|
220
|
+
* 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
|
|
221
|
+
* can have the same name. Two streams in the same Amazon Web Services account but in two
|
|
222
|
+
* different Regions can also have the same name.</p>
|
|
216
223
|
*/
|
|
217
224
|
StreamName: string | undefined;
|
|
218
225
|
/**
|
|
@@ -220,7 +227,14 @@ export interface CreateStreamInput {
|
|
|
220
227
|
* function of the number of shards; more shards are required for greater provisioned
|
|
221
228
|
* throughput.</p>
|
|
222
229
|
*/
|
|
223
|
-
ShardCount
|
|
230
|
+
ShardCount?: number;
|
|
231
|
+
/**
|
|
232
|
+
* <p> Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,
|
|
233
|
+
* you can choose between an <b>on-demand</b> capacity mode and a
|
|
234
|
+
* <b>provisioned</b> capacity mode for your data
|
|
235
|
+
* streams.</p>
|
|
236
|
+
*/
|
|
237
|
+
StreamModeDetails?: StreamModeDetails;
|
|
224
238
|
}
|
|
225
239
|
export declare namespace CreateStreamInput {
|
|
226
240
|
/**
|
|
@@ -272,7 +286,8 @@ export declare namespace DeleteStreamInput {
|
|
|
272
286
|
export interface DeregisterStreamConsumerInput {
|
|
273
287
|
/**
|
|
274
288
|
* <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
|
|
289
|
+
* 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
|
|
290
|
+
* Namespaces</a>.</p>
|
|
276
291
|
*/
|
|
277
292
|
StreamARN?: string;
|
|
278
293
|
/**
|
|
@@ -311,6 +326,14 @@ export interface DescribeLimitsOutput {
|
|
|
311
326
|
* <p>The number of open shards.</p>
|
|
312
327
|
*/
|
|
313
328
|
OpenShardCount: number | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* <p> Indicates the number of data streams with the on-demand capacity mode.</p>
|
|
331
|
+
*/
|
|
332
|
+
OnDemandStreamCount: number | undefined;
|
|
333
|
+
/**
|
|
334
|
+
* <p> The maximum number of data streams with the on-demand capacity mode. </p>
|
|
335
|
+
*/
|
|
336
|
+
OnDemandStreamCountLimit: number | undefined;
|
|
314
337
|
}
|
|
315
338
|
export declare namespace DescribeLimitsOutput {
|
|
316
339
|
/**
|
|
@@ -327,12 +350,17 @@ export interface DescribeStreamInput {
|
|
|
327
350
|
*/
|
|
328
351
|
StreamName: string | undefined;
|
|
329
352
|
/**
|
|
330
|
-
* <p>The maximum number of shards to return in a single call. The default value is 100.
|
|
331
|
-
*
|
|
353
|
+
* <p>The maximum number of shards to return in a single call. The default value is 100. If
|
|
354
|
+
* you specify a value greater than 100, at most 100 results are returned.</p>
|
|
332
355
|
*/
|
|
333
356
|
Limit?: number;
|
|
334
357
|
/**
|
|
335
358
|
* <p>The shard ID of the shard to start with.</p>
|
|
359
|
+
* <p>Specify this parameter to indicate that you want to describe the stream starting with
|
|
360
|
+
* the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
|
|
361
|
+
* <p>If you don't specify this parameter, the default behavior for
|
|
362
|
+
* <code>DescribeStream</code> is to describe the stream starting with the first shard
|
|
363
|
+
* in the stream.</p>
|
|
336
364
|
*/
|
|
337
365
|
ExclusiveStartShardId?: string;
|
|
338
366
|
}
|
|
@@ -362,8 +390,8 @@ export declare enum MetricsName {
|
|
|
362
390
|
export interface EnhancedMetrics {
|
|
363
391
|
/**
|
|
364
392
|
* <p>List of shard-level metrics.</p>
|
|
365
|
-
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>"
|
|
366
|
-
*
|
|
393
|
+
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enhances
|
|
394
|
+
* every metric.</p>
|
|
367
395
|
* <ul>
|
|
368
396
|
* <li>
|
|
369
397
|
* <p>
|
|
@@ -519,6 +547,11 @@ export interface StreamDescription {
|
|
|
519
547
|
* </ul>
|
|
520
548
|
*/
|
|
521
549
|
StreamStatus: StreamStatus | string | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
552
|
+
* 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>
|
|
553
|
+
*/
|
|
554
|
+
StreamModeDetails?: StreamModeDetails;
|
|
522
555
|
/**
|
|
523
556
|
* <p>The shards that comprise the stream.</p>
|
|
524
557
|
*/
|
|
@@ -542,8 +575,8 @@ export interface StreamDescription {
|
|
|
542
575
|
*/
|
|
543
576
|
EnhancedMonitoring: EnhancedMetrics[] | undefined;
|
|
544
577
|
/**
|
|
545
|
-
* <p>The server-side encryption type used on the stream. This parameter can be one of
|
|
546
|
-
*
|
|
578
|
+
* <p>The server-side encryption type used on the stream. This parameter can be one of the
|
|
579
|
+
* following values:</p>
|
|
547
580
|
* <ul>
|
|
548
581
|
* <li>
|
|
549
582
|
* <p>
|
|
@@ -552,16 +585,16 @@ export interface StreamDescription {
|
|
|
552
585
|
* <li>
|
|
553
586
|
* <p>
|
|
554
587
|
* <code>KMS</code>: Use server-side encryption on the records in the stream
|
|
555
|
-
* using a customer-managed
|
|
588
|
+
* using a customer-managed Amazon Web Services KMS key.</p>
|
|
556
589
|
* </li>
|
|
557
590
|
* </ul>
|
|
558
591
|
*/
|
|
559
592
|
EncryptionType?: EncryptionType | string;
|
|
560
593
|
/**
|
|
561
|
-
* <p>The GUID for the customer-managed
|
|
562
|
-
* be a globally unique identifier, a fully specified ARN to either an alias
|
|
563
|
-
* an alias name prefixed by "alias/".You can also use a master key owned by
|
|
564
|
-
* Streams by specifying the alias <code>aws/kinesis</code>.</p>
|
|
594
|
+
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
595
|
+
* This value can be a globally unique identifier, a fully specified ARN to either an alias
|
|
596
|
+
* or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
|
|
597
|
+
* Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
|
|
565
598
|
* <ul>
|
|
566
599
|
* <li>
|
|
567
600
|
* <p>Key ARN example:
|
|
@@ -602,8 +635,8 @@ export declare namespace StreamDescription {
|
|
|
602
635
|
*/
|
|
603
636
|
export interface DescribeStreamOutput {
|
|
604
637
|
/**
|
|
605
|
-
* <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array
|
|
606
|
-
*
|
|
638
|
+
* <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of
|
|
639
|
+
* shard objects that comprise the stream, and whether there are more shards
|
|
607
640
|
* available.</p>
|
|
608
641
|
*/
|
|
609
642
|
StreamDescription: StreamDescription | undefined;
|
|
@@ -617,7 +650,8 @@ export declare namespace DescribeStreamOutput {
|
|
|
617
650
|
export interface DescribeStreamConsumerInput {
|
|
618
651
|
/**
|
|
619
652
|
* <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
|
|
653
|
+
* 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
|
|
654
|
+
* Namespaces</a>.</p>
|
|
621
655
|
*/
|
|
622
656
|
StreamARN?: string;
|
|
623
657
|
/**
|
|
@@ -703,6 +737,11 @@ export interface StreamDescriptionSummary {
|
|
|
703
737
|
* </ul>
|
|
704
738
|
*/
|
|
705
739
|
StreamStatus: StreamStatus | string | undefined;
|
|
740
|
+
/**
|
|
741
|
+
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
742
|
+
* 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>
|
|
743
|
+
*/
|
|
744
|
+
StreamModeDetails?: StreamModeDetails;
|
|
706
745
|
/**
|
|
707
746
|
* <p>The current retention period, in hours.</p>
|
|
708
747
|
*/
|
|
@@ -732,10 +771,10 @@ export interface StreamDescriptionSummary {
|
|
|
732
771
|
*/
|
|
733
772
|
EncryptionType?: EncryptionType | string;
|
|
734
773
|
/**
|
|
735
|
-
* <p>The GUID for the customer-managed
|
|
736
|
-
* be a globally unique identifier, a fully specified ARN to either an alias
|
|
737
|
-
* an alias name prefixed by "alias/".You can also use a master key owned by
|
|
738
|
-
* Streams by specifying the alias <code>aws/kinesis</code>.</p>
|
|
774
|
+
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
775
|
+
* This value can be a globally unique identifier, a fully specified ARN to either an alias
|
|
776
|
+
* or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
|
|
777
|
+
* Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p>
|
|
739
778
|
* <ul>
|
|
740
779
|
* <li>
|
|
741
780
|
* <p>Key ARN example:
|
|
@@ -797,14 +836,13 @@ export declare namespace DescribeStreamSummaryOutput {
|
|
|
797
836
|
*/
|
|
798
837
|
export interface DisableEnhancedMonitoringInput {
|
|
799
838
|
/**
|
|
800
|
-
* <p>The name of the Kinesis data stream for which to disable enhanced
|
|
801
|
-
* monitoring.</p>
|
|
839
|
+
* <p>The name of the Kinesis data stream for which to disable enhanced monitoring.</p>
|
|
802
840
|
*/
|
|
803
841
|
StreamName: string | undefined;
|
|
804
842
|
/**
|
|
805
843
|
* <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
|
-
*
|
|
844
|
+
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" disables
|
|
845
|
+
* every metric.</p>
|
|
808
846
|
* <ul>
|
|
809
847
|
* <li>
|
|
810
848
|
* <p>
|
|
@@ -868,13 +906,13 @@ export interface EnhancedMonitoringOutput {
|
|
|
868
906
|
*/
|
|
869
907
|
StreamName?: string;
|
|
870
908
|
/**
|
|
871
|
-
* <p>Represents the current state of the metrics that are in the enhanced state before
|
|
872
|
-
*
|
|
909
|
+
* <p>Represents the current state of the metrics that are in the enhanced state before the
|
|
910
|
+
* operation.</p>
|
|
873
911
|
*/
|
|
874
912
|
CurrentShardLevelMetrics?: (MetricsName | string)[];
|
|
875
913
|
/**
|
|
876
|
-
* <p>Represents the list of all the metrics that would be in the enhanced state after
|
|
877
|
-
*
|
|
914
|
+
* <p>Represents the list of all the metrics that would be in the enhanced state after the
|
|
915
|
+
* operation.</p>
|
|
878
916
|
*/
|
|
879
917
|
DesiredShardLevelMetrics?: (MetricsName | string)[];
|
|
880
918
|
}
|
|
@@ -894,8 +932,8 @@ export interface EnableEnhancedMonitoringInput {
|
|
|
894
932
|
StreamName: string | undefined;
|
|
895
933
|
/**
|
|
896
934
|
* <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
|
-
*
|
|
935
|
+
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enables
|
|
936
|
+
* every metric.</p>
|
|
899
937
|
* <ul>
|
|
900
938
|
* <li>
|
|
901
939
|
* <p>
|
|
@@ -961,12 +999,6 @@ export interface ExpiredIteratorException extends __SmithyException, $MetadataBe
|
|
|
961
999
|
*/
|
|
962
1000
|
message?: string;
|
|
963
1001
|
}
|
|
964
|
-
export declare namespace ExpiredIteratorException {
|
|
965
|
-
/**
|
|
966
|
-
* @internal
|
|
967
|
-
*/
|
|
968
|
-
const filterSensitiveLog: (obj: ExpiredIteratorException) => any;
|
|
969
|
-
}
|
|
970
1002
|
/**
|
|
971
1003
|
* <p>The pagination token passed to the operation is expired.</p>
|
|
972
1004
|
*/
|
|
@@ -975,12 +1007,6 @@ export interface ExpiredNextTokenException extends __SmithyException, $MetadataB
|
|
|
975
1007
|
$fault: "client";
|
|
976
1008
|
message?: string;
|
|
977
1009
|
}
|
|
978
|
-
export declare namespace ExpiredNextTokenException {
|
|
979
|
-
/**
|
|
980
|
-
* @internal
|
|
981
|
-
*/
|
|
982
|
-
const filterSensitiveLog: (obj: ExpiredNextTokenException) => any;
|
|
983
|
-
}
|
|
984
1010
|
/**
|
|
985
1011
|
* <p>Represents the input for <a>GetRecords</a>.</p>
|
|
986
1012
|
*/
|
|
@@ -1005,8 +1031,8 @@ export declare namespace GetRecordsInput {
|
|
|
1005
1031
|
const filterSensitiveLog: (obj: GetRecordsInput) => any;
|
|
1006
1032
|
}
|
|
1007
1033
|
/**
|
|
1008
|
-
* <p>The unit of data of the Kinesis data stream, which is composed of a sequence
|
|
1009
|
-
*
|
|
1034
|
+
* <p>The unit of data of the Kinesis data stream, which is composed of a sequence number, a
|
|
1035
|
+
* partition key, and a data blob.</p>
|
|
1010
1036
|
*/
|
|
1011
1037
|
export interface _Record {
|
|
1012
1038
|
/**
|
|
@@ -1039,7 +1065,7 @@ export interface _Record {
|
|
|
1039
1065
|
* <li>
|
|
1040
1066
|
* <p>
|
|
1041
1067
|
* <code>KMS</code>: Use server-side encryption on the records in the stream
|
|
1042
|
-
* using a customer-managed
|
|
1068
|
+
* using a customer-managed Amazon Web Services KMS key.</p>
|
|
1043
1069
|
* </li>
|
|
1044
1070
|
* </ul>
|
|
1045
1071
|
*/
|
|
@@ -1060,18 +1086,22 @@ export interface GetRecordsOutput {
|
|
|
1060
1086
|
*/
|
|
1061
1087
|
Records: _Record[] | undefined;
|
|
1062
1088
|
/**
|
|
1063
|
-
* <p>The next position in the shard from which to start sequentially reading data
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1089
|
+
* <p>The next position in the shard from which to start sequentially reading data records.
|
|
1090
|
+
* If set to <code>null</code>, the shard has been closed and the requested iterator does
|
|
1091
|
+
* not return any more data. </p>
|
|
1066
1092
|
*/
|
|
1067
1093
|
NextShardIterator?: string;
|
|
1068
1094
|
/**
|
|
1069
|
-
* <p>The number of milliseconds the <a>GetRecords</a> response is from the
|
|
1070
|
-
*
|
|
1071
|
-
*
|
|
1072
|
-
*
|
|
1095
|
+
* <p>The number of milliseconds the <a>GetRecords</a> response is from the tip
|
|
1096
|
+
* of the stream, indicating how far behind current time the consumer is. A value of zero
|
|
1097
|
+
* indicates that record processing is caught up, and there are no new records to process
|
|
1098
|
+
* at this moment.</p>
|
|
1073
1099
|
*/
|
|
1074
1100
|
MillisBehindLatest?: number;
|
|
1101
|
+
/**
|
|
1102
|
+
* <p>The list of the current shard's child shards, returned in the <code>GetRecords</code>
|
|
1103
|
+
* API's response only when the end of the current shard is reached.</p>
|
|
1104
|
+
*/
|
|
1075
1105
|
ChildShards?: ChildShard[];
|
|
1076
1106
|
}
|
|
1077
1107
|
export declare namespace GetRecordsOutput {
|
|
@@ -1092,12 +1122,6 @@ export interface KMSAccessDeniedException extends __SmithyException, $MetadataBe
|
|
|
1092
1122
|
*/
|
|
1093
1123
|
message?: string;
|
|
1094
1124
|
}
|
|
1095
|
-
export declare namespace KMSAccessDeniedException {
|
|
1096
|
-
/**
|
|
1097
|
-
* @internal
|
|
1098
|
-
*/
|
|
1099
|
-
const filterSensitiveLog: (obj: KMSAccessDeniedException) => any;
|
|
1100
|
-
}
|
|
1101
1125
|
/**
|
|
1102
1126
|
* <p>The request was rejected because the specified customer master key (CMK) isn't
|
|
1103
1127
|
* enabled.</p>
|
|
@@ -1110,17 +1134,11 @@ export interface KMSDisabledException extends __SmithyException, $MetadataBearer
|
|
|
1110
1134
|
*/
|
|
1111
1135
|
message?: string;
|
|
1112
1136
|
}
|
|
1113
|
-
export declare namespace KMSDisabledException {
|
|
1114
|
-
/**
|
|
1115
|
-
* @internal
|
|
1116
|
-
*/
|
|
1117
|
-
const filterSensitiveLog: (obj: KMSDisabledException) => any;
|
|
1118
|
-
}
|
|
1119
1137
|
/**
|
|
1120
|
-
* <p>The request was rejected because the state of the specified resource isn't valid
|
|
1121
|
-
*
|
|
1122
|
-
* Customer Master Key</a> in the <i>
|
|
1123
|
-
* Guide</i>.</p>
|
|
1138
|
+
* <p>The request was rejected because the state of the specified resource isn't valid for
|
|
1139
|
+
* 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
|
|
1140
|
+
* Customer Master Key</a> in the <i>Amazon Web Services Key Management
|
|
1141
|
+
* Service Developer Guide</i>.</p>
|
|
1124
1142
|
*/
|
|
1125
1143
|
export interface KMSInvalidStateException extends __SmithyException, $MetadataBearer {
|
|
1126
1144
|
name: "KMSInvalidStateException";
|
|
@@ -1130,12 +1148,6 @@ export interface KMSInvalidStateException extends __SmithyException, $MetadataBe
|
|
|
1130
1148
|
*/
|
|
1131
1149
|
message?: string;
|
|
1132
1150
|
}
|
|
1133
|
-
export declare namespace KMSInvalidStateException {
|
|
1134
|
-
/**
|
|
1135
|
-
* @internal
|
|
1136
|
-
*/
|
|
1137
|
-
const filterSensitiveLog: (obj: KMSInvalidStateException) => any;
|
|
1138
|
-
}
|
|
1139
1151
|
/**
|
|
1140
1152
|
* <p>The request was rejected because the specified entity or resource can't be
|
|
1141
1153
|
* found.</p>
|
|
@@ -1148,14 +1160,8 @@ export interface KMSNotFoundException extends __SmithyException, $MetadataBearer
|
|
|
1148
1160
|
*/
|
|
1149
1161
|
message?: string;
|
|
1150
1162
|
}
|
|
1151
|
-
export declare namespace KMSNotFoundException {
|
|
1152
|
-
/**
|
|
1153
|
-
* @internal
|
|
1154
|
-
*/
|
|
1155
|
-
const filterSensitiveLog: (obj: KMSNotFoundException) => any;
|
|
1156
|
-
}
|
|
1157
1163
|
/**
|
|
1158
|
-
* <p>The
|
|
1164
|
+
* <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
|
|
1159
1165
|
*/
|
|
1160
1166
|
export interface KMSOptInRequired extends __SmithyException, $MetadataBearer {
|
|
1161
1167
|
name: "KMSOptInRequired";
|
|
@@ -1165,16 +1171,11 @@ export interface KMSOptInRequired extends __SmithyException, $MetadataBearer {
|
|
|
1165
1171
|
*/
|
|
1166
1172
|
message?: string;
|
|
1167
1173
|
}
|
|
1168
|
-
export declare namespace KMSOptInRequired {
|
|
1169
|
-
/**
|
|
1170
|
-
* @internal
|
|
1171
|
-
*/
|
|
1172
|
-
const filterSensitiveLog: (obj: KMSOptInRequired) => any;
|
|
1173
|
-
}
|
|
1174
1174
|
/**
|
|
1175
1175
|
* <p>The request was denied due to request throttling. For more information about
|
|
1176
1176
|
* throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
|
|
1177
|
-
* the <i>
|
|
1177
|
+
* the <i>Amazon Web Services Key Management Service Developer
|
|
1178
|
+
* Guide</i>.</p>
|
|
1178
1179
|
*/
|
|
1179
1180
|
export interface KMSThrottlingException extends __SmithyException, $MetadataBearer {
|
|
1180
1181
|
name: "KMSThrottlingException";
|
|
@@ -1184,19 +1185,12 @@ export interface KMSThrottlingException extends __SmithyException, $MetadataBear
|
|
|
1184
1185
|
*/
|
|
1185
1186
|
message?: string;
|
|
1186
1187
|
}
|
|
1187
|
-
export declare namespace KMSThrottlingException {
|
|
1188
|
-
/**
|
|
1189
|
-
* @internal
|
|
1190
|
-
*/
|
|
1191
|
-
const filterSensitiveLog: (obj: KMSThrottlingException) => any;
|
|
1192
|
-
}
|
|
1193
1188
|
/**
|
|
1194
1189
|
* <p>The request rate for the stream is too high, or the requested data is too large for
|
|
1195
1190
|
* the available throughput. Reduce the frequency or size of your requests. For more
|
|
1196
1191
|
* information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Streams Limits</a> in the
|
|
1197
1192
|
* <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
|
|
1199
|
-
* Reference</i>.</p>
|
|
1193
|
+
* Exponential Backoff in Amazon Web Services</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
1200
1194
|
*/
|
|
1201
1195
|
export interface ProvisionedThroughputExceededException extends __SmithyException, $MetadataBearer {
|
|
1202
1196
|
name: "ProvisionedThroughputExceededException";
|
|
@@ -1206,12 +1200,6 @@ export interface ProvisionedThroughputExceededException extends __SmithyExceptio
|
|
|
1206
1200
|
*/
|
|
1207
1201
|
message?: string;
|
|
1208
1202
|
}
|
|
1209
|
-
export declare namespace ProvisionedThroughputExceededException {
|
|
1210
|
-
/**
|
|
1211
|
-
* @internal
|
|
1212
|
-
*/
|
|
1213
|
-
const filterSensitiveLog: (obj: ProvisionedThroughputExceededException) => any;
|
|
1214
|
-
}
|
|
1215
1203
|
export declare enum ShardIteratorType {
|
|
1216
1204
|
AFTER_SEQUENCE_NUMBER = "AFTER_SEQUENCE_NUMBER",
|
|
1217
1205
|
AT_SEQUENCE_NUMBER = "AT_SEQUENCE_NUMBER",
|
|
@@ -1255,20 +1243,20 @@ export interface GetShardIteratorInput {
|
|
|
1255
1243
|
* </li>
|
|
1256
1244
|
* <li>
|
|
1257
1245
|
*
|
|
1258
|
-
* <p>TRIM_HORIZON - Start reading at the last untrimmed record in the shard in
|
|
1259
|
-
*
|
|
1246
|
+
* <p>TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the
|
|
1247
|
+
* system, which is the oldest data record in the shard.</p>
|
|
1260
1248
|
* </li>
|
|
1261
1249
|
* <li>
|
|
1262
1250
|
*
|
|
1263
|
-
* <p>LATEST - Start reading just after the most recent record in the shard, so
|
|
1264
|
-
*
|
|
1251
|
+
* <p>LATEST - Start reading just after the most recent record in the shard, so that
|
|
1252
|
+
* you always read the most recent data in the shard.</p>
|
|
1265
1253
|
* </li>
|
|
1266
1254
|
* </ul>
|
|
1267
1255
|
*/
|
|
1268
1256
|
ShardIteratorType: ShardIteratorType | string | undefined;
|
|
1269
1257
|
/**
|
|
1270
|
-
* <p>The sequence number of the data record in the shard from which to start reading.
|
|
1271
|
-
*
|
|
1258
|
+
* <p>The sequence number of the data record in the shard from which to start reading. Used
|
|
1259
|
+
* with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.</p>
|
|
1272
1260
|
*/
|
|
1273
1261
|
StartingSequenceNumber?: string;
|
|
1274
1262
|
/**
|
|
@@ -1334,12 +1322,6 @@ export interface InternalFailureException extends __SmithyException {
|
|
|
1334
1322
|
$fault: "server";
|
|
1335
1323
|
message?: string;
|
|
1336
1324
|
}
|
|
1337
|
-
export declare namespace InternalFailureException {
|
|
1338
|
-
/**
|
|
1339
|
-
* @internal
|
|
1340
|
-
*/
|
|
1341
|
-
const filterSensitiveLog: (obj: InternalFailureException) => any;
|
|
1342
|
-
}
|
|
1343
1325
|
export declare enum ShardFilterType {
|
|
1344
1326
|
AFTER_SHARD_ID = "AFTER_SHARD_ID",
|
|
1345
1327
|
AT_LATEST = "AT_LATEST",
|
|
@@ -1348,9 +1330,67 @@ export declare enum ShardFilterType {
|
|
|
1348
1330
|
FROM_TIMESTAMP = "FROM_TIMESTAMP",
|
|
1349
1331
|
FROM_TRIM_HORIZON = "FROM_TRIM_HORIZON"
|
|
1350
1332
|
}
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>The request parameter used to filter out the response of the <code>ListShards</code>
|
|
1335
|
+
* API.</p>
|
|
1336
|
+
*/
|
|
1351
1337
|
export interface ShardFilter {
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The shard type specified in the <code>ShardFilter</code> parameter. This is a required
|
|
1340
|
+
* property of the <code>ShardFilter</code> parameter.</p>
|
|
1341
|
+
* <p>You can specify the following valid values: </p>
|
|
1342
|
+
* <ul>
|
|
1343
|
+
* <li>
|
|
1344
|
+
* <p>
|
|
1345
|
+
* <code>AFTER_SHARD_ID</code> - the response includes all the shards, starting
|
|
1346
|
+
* with the shard whose ID immediately follows the <code>ShardId</code> that you
|
|
1347
|
+
* provided. </p>
|
|
1348
|
+
* </li>
|
|
1349
|
+
* <li>
|
|
1350
|
+
* <p>
|
|
1351
|
+
* <code>AT_TRIM_HORIZON</code> - the response includes all the shards that were
|
|
1352
|
+
* open at <code>TRIM_HORIZON</code>.</p>
|
|
1353
|
+
* </li>
|
|
1354
|
+
* <li>
|
|
1355
|
+
* <p>
|
|
1356
|
+
* <code>FROM_TRIM_HORIZON</code> - (default), the response includes all the
|
|
1357
|
+
* shards within the retention period of the data stream (trim to tip).</p>
|
|
1358
|
+
* </li>
|
|
1359
|
+
* <li>
|
|
1360
|
+
* <p>
|
|
1361
|
+
* <code>AT_LATEST</code> - the response includes only the currently open shards
|
|
1362
|
+
* of the data stream.</p>
|
|
1363
|
+
* </li>
|
|
1364
|
+
* <li>
|
|
1365
|
+
* <p>
|
|
1366
|
+
* <code>AT_TIMESTAMP</code> - the response includes all shards whose start
|
|
1367
|
+
* timestamp is less than or equal to the given timestamp and end timestamp is
|
|
1368
|
+
* greater than or equal to the given timestamp or still open. </p>
|
|
1369
|
+
* </li>
|
|
1370
|
+
* <li>
|
|
1371
|
+
* <p>
|
|
1372
|
+
* <code>FROM_TIMESTAMP</code> - the response incldues all closed shards whose
|
|
1373
|
+
* end timestamp is greater than or equal to the given timestamp and also all open
|
|
1374
|
+
* shards. Corrected to <code>TRIM_HORIZON</code> of the data stream if
|
|
1375
|
+
* <code>FROM_TIMESTAMP</code> is less than the <code>TRIM_HORIZON</code>
|
|
1376
|
+
* value.</p>
|
|
1377
|
+
* </li>
|
|
1378
|
+
* </ul>
|
|
1379
|
+
*/
|
|
1352
1380
|
Type: ShardFilterType | string | undefined;
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>The exclusive start <code>shardID</code> speified in the <code>ShardFilter</code>
|
|
1383
|
+
* parameter. This property can only be used if the <code>AFTER_SHARD_ID</code> shard type
|
|
1384
|
+
* is specified.</p>
|
|
1385
|
+
*/
|
|
1353
1386
|
ShardId?: string;
|
|
1387
|
+
/**
|
|
1388
|
+
* <p>The timestamps specified in the <code>ShardFilter</code> parameter. A timestamp is a
|
|
1389
|
+
* Unix epoch date with precision in milliseconds. For example,
|
|
1390
|
+
* 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if
|
|
1391
|
+
* <code>FROM_TIMESTAMP</code> or <code>AT_TIMESTAMP</code> shard types are
|
|
1392
|
+
* specified.</p>
|
|
1393
|
+
*/
|
|
1354
1394
|
Timestamp?: Date;
|
|
1355
1395
|
}
|
|
1356
1396
|
export declare namespace ShardFilter {
|
|
@@ -1367,18 +1407,18 @@ export interface ListShardsInput {
|
|
|
1367
1407
|
*/
|
|
1368
1408
|
StreamName?: string;
|
|
1369
1409
|
/**
|
|
1370
|
-
* <p>When the number of shards in the data stream is greater than the default value for
|
|
1371
|
-
*
|
|
1410
|
+
* <p>When the number of shards in the data stream is greater than the default value for the
|
|
1411
|
+
* <code>MaxResults</code> parameter, or if you explicitly specify a value for
|
|
1372
1412
|
* <code>MaxResults</code> that is less than the number of shards in the data stream,
|
|
1373
1413
|
* the response includes a pagination token named <code>NextToken</code>. You can specify
|
|
1374
1414
|
* this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
|
|
1375
1415
|
* list the next set of shards.</p>
|
|
1376
|
-
* <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if
|
|
1377
|
-
*
|
|
1416
|
+
* <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you
|
|
1417
|
+
* specify <code>NextToken</code> because the latter unambiguously identifies the
|
|
1378
1418
|
* stream.</p>
|
|
1379
|
-
* <p>You can optionally specify a value for the <code>MaxResults</code> parameter when
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1419
|
+
* <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you
|
|
1420
|
+
* specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that is
|
|
1421
|
+
* less than the number of shards that the operation returns if you don't specify
|
|
1382
1422
|
* <code>MaxResults</code>, the response will contain a new <code>NextToken</code>
|
|
1383
1423
|
* value. You can use the new <code>NextToken</code> value in a subsequent call to the
|
|
1384
1424
|
* <code>ListShards</code> operation.</p>
|
|
@@ -1386,14 +1426,13 @@ export interface ListShardsInput {
|
|
|
1386
1426
|
* <p>Tokens expire after 300 seconds. When you obtain a value for
|
|
1387
1427
|
* <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
|
|
1388
1428
|
* 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>
|
|
1429
|
+
* <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
|
|
1391
1430
|
* </important>
|
|
1392
1431
|
*/
|
|
1393
1432
|
NextToken?: string;
|
|
1394
1433
|
/**
|
|
1395
|
-
* <p>Specify this parameter to indicate that you want to list the shards starting with
|
|
1396
|
-
*
|
|
1434
|
+
* <p>Specify this parameter to indicate that you want to list the shards starting with the
|
|
1435
|
+
* shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
|
|
1397
1436
|
* <p>If you don't specify this parameter, the default behavior is for
|
|
1398
1437
|
* <code>ListShards</code> to list the shards starting with the first one in the
|
|
1399
1438
|
* stream.</p>
|
|
@@ -1402,8 +1441,8 @@ export interface ListShardsInput {
|
|
|
1402
1441
|
ExclusiveStartShardId?: string;
|
|
1403
1442
|
/**
|
|
1404
1443
|
* <p>The maximum number of shards to return in a single call to <code>ListShards</code>.
|
|
1405
|
-
* The
|
|
1406
|
-
*
|
|
1444
|
+
* The maximum number of shards to return in a single call. The default value is 1000. If
|
|
1445
|
+
* you specify a value greater than 1000, at most 1000 results are returned. </p>
|
|
1407
1446
|
* <p>When the number of shards to be listed is greater than the value of
|
|
1408
1447
|
* <code>MaxResults</code>, the response contains a <code>NextToken</code> value that
|
|
1409
1448
|
* you can use in a subsequent call to <code>ListShards</code> to list the next set of
|
|
@@ -1411,14 +1450,34 @@ export interface ListShardsInput {
|
|
|
1411
1450
|
*/
|
|
1412
1451
|
MaxResults?: number;
|
|
1413
1452
|
/**
|
|
1414
|
-
* <p>Specify this input parameter to distinguish data streams that have the same name.
|
|
1415
|
-
*
|
|
1416
|
-
*
|
|
1417
|
-
*
|
|
1453
|
+
* <p>Specify this input parameter to distinguish data streams that have the same name. For
|
|
1454
|
+
* example, if you create a data stream and then delete it, and you later create another
|
|
1455
|
+
* data stream with the same name, you can use this input parameter to specify which of the
|
|
1456
|
+
* two streams you want to list the shards for.</p>
|
|
1418
1457
|
* <p>You cannot specify this parameter if you specify the <code>NextToken</code>
|
|
1419
1458
|
* parameter.</p>
|
|
1420
1459
|
*/
|
|
1421
1460
|
StreamCreationTimestamp?: Date;
|
|
1461
|
+
/**
|
|
1462
|
+
* <p>Enables you to filter out the response of the <code>ListShards</code> API. You can
|
|
1463
|
+
* only specify one filter at a time. </p>
|
|
1464
|
+
* <p>If you use the <code>ShardFilter</code> parameter when invoking the ListShards API,
|
|
1465
|
+
* the <code>Type</code> is the required property and must be specified. If you specify the
|
|
1466
|
+
* <code>AT_TRIM_HORIZON</code>, <code>FROM_TRIM_HORIZON</code>, or
|
|
1467
|
+
* <code>AT_LATEST</code> types, you do not need to specify either the
|
|
1468
|
+
* <code>ShardId</code> or the <code>Timestamp</code> optional properties. </p>
|
|
1469
|
+
* <p>If you specify the <code>AFTER_SHARD_ID</code> type, you must also provide the value
|
|
1470
|
+
* for the optional <code>ShardId</code> property. The <code>ShardId</code> property is
|
|
1471
|
+
* identical in fuctionality to the <code>ExclusiveStartShardId</code> parameter of the
|
|
1472
|
+
* <code>ListShards</code> API. When <code>ShardId</code> property is specified, the
|
|
1473
|
+
* response includes the shards starting with the shard whose ID immediately follows the
|
|
1474
|
+
* <code>ShardId</code> that you provided. </p>
|
|
1475
|
+
* <p>If you specify the <code>AT_TIMESTAMP</code> or <code>FROM_TIMESTAMP_ID</code> type,
|
|
1476
|
+
* you must also provide the value for the optional <code>Timestamp</code> property. If you
|
|
1477
|
+
* specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp
|
|
1478
|
+
* are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the
|
|
1479
|
+
* provided timestamp to TIP are returned. </p>
|
|
1480
|
+
*/
|
|
1422
1481
|
ShardFilter?: ShardFilter;
|
|
1423
1482
|
}
|
|
1424
1483
|
export declare namespace ListShardsInput {
|
|
@@ -1436,8 +1495,8 @@ export interface ListShardsOutput {
|
|
|
1436
1495
|
*/
|
|
1437
1496
|
Shards?: Shard[];
|
|
1438
1497
|
/**
|
|
1439
|
-
* <p>When the number of shards in the data stream is greater than the default value for
|
|
1440
|
-
*
|
|
1498
|
+
* <p>When the number of shards in the data stream is greater than the default value for the
|
|
1499
|
+
* <code>MaxResults</code> parameter, or if you explicitly specify a value for
|
|
1441
1500
|
* <code>MaxResults</code> that is less than the number of shards in the data stream,
|
|
1442
1501
|
* the response includes a pagination token named <code>NextToken</code>. You can specify
|
|
1443
1502
|
* this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
|
|
@@ -1447,8 +1506,7 @@ export interface ListShardsOutput {
|
|
|
1447
1506
|
* <p>Tokens expire after 300 seconds. When you obtain a value for
|
|
1448
1507
|
* <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
|
|
1449
1508
|
* 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>
|
|
1509
|
+
* <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
|
|
1452
1510
|
* </important>
|
|
1453
1511
|
*/
|
|
1454
1512
|
NextToken?: string;
|
|
@@ -1462,7 +1520,8 @@ export declare namespace ListShardsOutput {
|
|
|
1462
1520
|
export interface ListStreamConsumersInput {
|
|
1463
1521
|
/**
|
|
1464
1522
|
* <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
|
|
1523
|
+
* 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
|
|
1524
|
+
* Namespaces</a>.</p>
|
|
1466
1525
|
*/
|
|
1467
1526
|
StreamARN: string | undefined;
|
|
1468
1527
|
/**
|
|
@@ -1493,7 +1552,8 @@ export interface ListStreamConsumersInput {
|
|
|
1493
1552
|
NextToken?: string;
|
|
1494
1553
|
/**
|
|
1495
1554
|
* <p>The maximum number of consumers that you want a single call of
|
|
1496
|
-
* <code>ListStreamConsumers</code> to return
|
|
1555
|
+
* <code>ListStreamConsumers</code> to return. The default value is 100. If you specify
|
|
1556
|
+
* a value greater than 100, at most 100 results are returned. </p>
|
|
1497
1557
|
*/
|
|
1498
1558
|
MaxResults?: number;
|
|
1499
1559
|
/**
|
|
@@ -1546,7 +1606,8 @@ export declare namespace ListStreamConsumersOutput {
|
|
|
1546
1606
|
*/
|
|
1547
1607
|
export interface ListStreamsInput {
|
|
1548
1608
|
/**
|
|
1549
|
-
* <p>The maximum number of streams to list
|
|
1609
|
+
* <p>The maximum number of streams to list. The default value is 100. If you specify a
|
|
1610
|
+
* value greater than 100, at most 100 results are returned.</p>
|
|
1550
1611
|
*/
|
|
1551
1612
|
Limit?: number;
|
|
1552
1613
|
/**
|
|
@@ -1565,8 +1626,8 @@ export declare namespace ListStreamsInput {
|
|
|
1565
1626
|
*/
|
|
1566
1627
|
export interface ListStreamsOutput {
|
|
1567
1628
|
/**
|
|
1568
|
-
* <p>The names of the streams that are associated with the
|
|
1569
|
-
*
|
|
1629
|
+
* <p>The names of the streams that are associated with the Amazon Web Services account
|
|
1630
|
+
* making the <code>ListStreams</code> request.</p>
|
|
1570
1631
|
*/
|
|
1571
1632
|
StreamNames: string[] | undefined;
|
|
1572
1633
|
/**
|
|
@@ -1589,8 +1650,8 @@ export interface ListTagsForStreamInput {
|
|
|
1589
1650
|
*/
|
|
1590
1651
|
StreamName: string | undefined;
|
|
1591
1652
|
/**
|
|
1592
|
-
* <p>The key to use as the starting point for the list of tags. If this parameter is
|
|
1593
|
-
*
|
|
1653
|
+
* <p>The key to use as the starting point for the list of tags. If this parameter is set,
|
|
1654
|
+
* <code>ListTagsForStream</code> gets all tags that occur after
|
|
1594
1655
|
* <code>ExclusiveStartTagKey</code>. </p>
|
|
1595
1656
|
*/
|
|
1596
1657
|
ExclusiveStartTagKey?: string;
|
|
@@ -1618,8 +1679,8 @@ export interface Tag {
|
|
|
1618
1679
|
*/
|
|
1619
1680
|
Key: string | undefined;
|
|
1620
1681
|
/**
|
|
1621
|
-
* <p>An optional string, typically used to describe or define the tag. Maximum length:
|
|
1622
|
-
*
|
|
1682
|
+
* <p>An optional string, typically used to describe or define the tag. Maximum length: 256
|
|
1683
|
+
* characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
|
|
1623
1684
|
* @</p>
|
|
1624
1685
|
*/
|
|
1625
1686
|
Value?: string;
|
|
@@ -1641,8 +1702,8 @@ export interface ListTagsForStreamOutput {
|
|
|
1641
1702
|
*/
|
|
1642
1703
|
Tags: Tag[] | undefined;
|
|
1643
1704
|
/**
|
|
1644
|
-
* <p>If set to <code>true</code>, more tags are available. To request additional tags,
|
|
1645
|
-
*
|
|
1705
|
+
* <p>If set to <code>true</code>, more tags are available. To request additional tags, set
|
|
1706
|
+
* <code>ExclusiveStartTagKey</code> to the key of the last tag returned.</p>
|
|
1646
1707
|
*/
|
|
1647
1708
|
HasMoreTags: boolean | undefined;
|
|
1648
1709
|
}
|
|
@@ -1661,8 +1722,7 @@ export interface MergeShardsInput {
|
|
|
1661
1722
|
*/
|
|
1662
1723
|
StreamName: string | undefined;
|
|
1663
1724
|
/**
|
|
1664
|
-
* <p>The shard ID of the shard to combine with the adjacent shard for the
|
|
1665
|
-
* merge.</p>
|
|
1725
|
+
* <p>The shard ID of the shard to combine with the adjacent shard for the merge.</p>
|
|
1666
1726
|
*/
|
|
1667
1727
|
ShardToMerge: string | undefined;
|
|
1668
1728
|
/**
|
|
@@ -1676,6 +1736,16 @@ export declare namespace MergeShardsInput {
|
|
|
1676
1736
|
*/
|
|
1677
1737
|
const filterSensitiveLog: (obj: MergeShardsInput) => any;
|
|
1678
1738
|
}
|
|
1739
|
+
/**
|
|
1740
|
+
* <p>
|
|
1741
|
+
*
|
|
1742
|
+
* </p>
|
|
1743
|
+
*/
|
|
1744
|
+
export interface ValidationException extends __SmithyException, $MetadataBearer {
|
|
1745
|
+
name: "ValidationException";
|
|
1746
|
+
$fault: "client";
|
|
1747
|
+
message?: string;
|
|
1748
|
+
}
|
|
1679
1749
|
/**
|
|
1680
1750
|
* <p>Represents the input for <code>PutRecord</code>.</p>
|
|
1681
1751
|
*/
|
|
@@ -1702,16 +1772,16 @@ export interface PutRecordInput {
|
|
|
1702
1772
|
*/
|
|
1703
1773
|
PartitionKey: string | undefined;
|
|
1704
1774
|
/**
|
|
1705
|
-
* <p>The hash value used to explicitly determine the shard the data record is assigned
|
|
1706
|
-
*
|
|
1775
|
+
* <p>The hash value used to explicitly determine the shard the data record is assigned to
|
|
1776
|
+
* by overriding the partition key hash.</p>
|
|
1707
1777
|
*/
|
|
1708
1778
|
ExplicitHashKey?: string;
|
|
1709
1779
|
/**
|
|
1710
|
-
* <p>Guarantees strictly increasing sequence numbers, for puts from the same client and
|
|
1711
|
-
*
|
|
1712
|
-
*
|
|
1713
|
-
*
|
|
1714
|
-
*
|
|
1780
|
+
* <p>Guarantees strictly increasing sequence numbers, for puts from the same client and to
|
|
1781
|
+
* the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of record
|
|
1782
|
+
* <i>n</i> to the sequence number of record <i>n-1</i> (as
|
|
1783
|
+
* returned in the result when putting record <i>n-1</i>). If this parameter
|
|
1784
|
+
* is not set, records are coarsely ordered based on arrival time.</p>
|
|
1715
1785
|
*/
|
|
1716
1786
|
SequenceNumberForOrdering?: string;
|
|
1717
1787
|
}
|
|
@@ -1730,14 +1800,14 @@ export interface PutRecordOutput {
|
|
|
1730
1800
|
*/
|
|
1731
1801
|
ShardId: string | undefined;
|
|
1732
1802
|
/**
|
|
1733
|
-
* <p>The sequence number identifier that was assigned to the put data record. The
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1803
|
+
* <p>The sequence number identifier that was assigned to the put data record. The sequence
|
|
1804
|
+
* number for the record is unique across all records in the stream. A sequence number is
|
|
1805
|
+
* the identifier associated with every record put into the stream.</p>
|
|
1736
1806
|
*/
|
|
1737
1807
|
SequenceNumber: string | undefined;
|
|
1738
1808
|
/**
|
|
1739
|
-
* <p>The encryption type to use on the record. This parameter can be one of the
|
|
1740
|
-
*
|
|
1809
|
+
* <p>The encryption type to use on the record. This parameter can be one of the following
|
|
1810
|
+
* values:</p>
|
|
1741
1811
|
* <ul>
|
|
1742
1812
|
* <li>
|
|
1743
1813
|
* <p>
|
|
@@ -1746,7 +1816,7 @@ export interface PutRecordOutput {
|
|
|
1746
1816
|
* <li>
|
|
1747
1817
|
* <p>
|
|
1748
1818
|
* <code>KMS</code>: Use server-side encryption on the records in the stream
|
|
1749
|
-
* using a customer-managed
|
|
1819
|
+
* using a customer-managed Amazon Web Services KMS key.</p>
|
|
1750
1820
|
* </li>
|
|
1751
1821
|
* </ul>
|
|
1752
1822
|
*/
|
|
@@ -1770,8 +1840,8 @@ export interface PutRecordsRequestEntry {
|
|
|
1770
1840
|
*/
|
|
1771
1841
|
Data: Uint8Array | undefined;
|
|
1772
1842
|
/**
|
|
1773
|
-
* <p>The hash value used to determine explicitly the shard that the data record is
|
|
1774
|
-
*
|
|
1843
|
+
* <p>The hash value used to determine explicitly the shard that the data record is assigned
|
|
1844
|
+
* to by overriding the partition key hash.</p>
|
|
1775
1845
|
*/
|
|
1776
1846
|
ExplicitHashKey?: string;
|
|
1777
1847
|
/**
|
|
@@ -1811,11 +1881,10 @@ export declare namespace PutRecordsInput {
|
|
|
1811
1881
|
const filterSensitiveLog: (obj: PutRecordsInput) => any;
|
|
1812
1882
|
}
|
|
1813
1883
|
/**
|
|
1814
|
-
* <p>Represents the result of an individual record from a <code>PutRecords</code>
|
|
1815
|
-
*
|
|
1816
|
-
* <code>
|
|
1817
|
-
*
|
|
1818
|
-
* <code>ErrorMessage</code> in the result.</p>
|
|
1884
|
+
* <p>Represents the result of an individual record from a <code>PutRecords</code> request.
|
|
1885
|
+
* A record that is successfully added to a stream includes <code>SequenceNumber</code> and
|
|
1886
|
+
* <code>ShardId</code> in the result. A record that fails to be added to the stream
|
|
1887
|
+
* includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result.</p>
|
|
1819
1888
|
*/
|
|
1820
1889
|
export interface PutRecordsResultEntry {
|
|
1821
1890
|
/**
|
|
@@ -1827,14 +1896,14 @@ export interface PutRecordsResultEntry {
|
|
|
1827
1896
|
*/
|
|
1828
1897
|
ShardId?: string;
|
|
1829
1898
|
/**
|
|
1830
|
-
* <p>The error code for an individual record result. <code>ErrorCodes</code> can be
|
|
1831
|
-
*
|
|
1832
|
-
*
|
|
1899
|
+
* <p>The error code for an individual record result. <code>ErrorCodes</code> can be either
|
|
1900
|
+
* <code>ProvisionedThroughputExceededException</code> or
|
|
1901
|
+
* <code>InternalFailure</code>.</p>
|
|
1833
1902
|
*/
|
|
1834
1903
|
ErrorCode?: string;
|
|
1835
1904
|
/**
|
|
1836
|
-
* <p>The error message for an individual record result. An <code>ErrorCode</code> value
|
|
1837
|
-
*
|
|
1905
|
+
* <p>The error message for an individual record result. An <code>ErrorCode</code> value of
|
|
1906
|
+
* <code>ProvisionedThroughputExceededException</code> has an error message that
|
|
1838
1907
|
* includes the account ID, stream name, and shard ID. An <code>ErrorCode</code> value of
|
|
1839
1908
|
* <code>InternalFailure</code> has the error message <code>"Internal Service
|
|
1840
1909
|
* Failure"</code>.</p>
|
|
@@ -1858,11 +1927,10 @@ export interface PutRecordsOutput {
|
|
|
1858
1927
|
*/
|
|
1859
1928
|
FailedRecordCount?: number;
|
|
1860
1929
|
/**
|
|
1861
|
-
* <p>An array of successfully and unsuccessfully processed record results
|
|
1862
|
-
*
|
|
1863
|
-
*
|
|
1864
|
-
*
|
|
1865
|
-
* <code>ErrorMessage</code> in the result.</p>
|
|
1930
|
+
* <p>An array of successfully and unsuccessfully processed record results. A record that is
|
|
1931
|
+
* successfully added to a stream includes <code>SequenceNumber</code> and
|
|
1932
|
+
* <code>ShardId</code> in the result. A record that fails to be added to a stream
|
|
1933
|
+
* includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result.</p>
|
|
1866
1934
|
*/
|
|
1867
1935
|
Records: PutRecordsResultEntry[] | undefined;
|
|
1868
1936
|
/**
|
|
@@ -1876,7 +1944,7 @@ export interface PutRecordsOutput {
|
|
|
1876
1944
|
* <li>
|
|
1877
1945
|
* <p>
|
|
1878
1946
|
* <code>KMS</code>: Use server-side encryption on the records using a
|
|
1879
|
-
* customer-managed
|
|
1947
|
+
* customer-managed Amazon Web Services KMS key.</p>
|
|
1880
1948
|
* </li>
|
|
1881
1949
|
* </ul>
|
|
1882
1950
|
*/
|
|
@@ -1891,7 +1959,8 @@ export declare namespace PutRecordsOutput {
|
|
|
1891
1959
|
export interface RegisterStreamConsumerInput {
|
|
1892
1960
|
/**
|
|
1893
1961
|
* <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
|
|
1962
|
+
* 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
|
|
1963
|
+
* Namespaces</a>.</p>
|
|
1895
1964
|
*/
|
|
1896
1965
|
StreamARN: string | undefined;
|
|
1897
1966
|
/**
|
|
@@ -1951,8 +2020,8 @@ export interface SplitShardInput {
|
|
|
1951
2020
|
*/
|
|
1952
2021
|
ShardToSplit: string | undefined;
|
|
1953
2022
|
/**
|
|
1954
|
-
* <p>A hash key value for the starting hash key of one of the child shards created by
|
|
1955
|
-
*
|
|
2023
|
+
* <p>A hash key value for the starting hash key of one of the child shards created by the
|
|
2024
|
+
* split. The hash key range for a given shard constitutes a set of ordered contiguous
|
|
1956
2025
|
* positive integers. The value for <code>NewStartingHashKey</code> must be in the range of
|
|
1957
2026
|
* hash keys being mapped into the shard. The <code>NewStartingHashKey</code> hash key
|
|
1958
2027
|
* value and all higher hash key values in hash key range are distributed to one of the
|
|
@@ -1977,11 +2046,11 @@ export interface StartStreamEncryptionInput {
|
|
|
1977
2046
|
*/
|
|
1978
2047
|
EncryptionType: EncryptionType | string | undefined;
|
|
1979
2048
|
/**
|
|
1980
|
-
* <p>The GUID for the customer-managed
|
|
1981
|
-
* be a globally unique identifier, a fully specified Amazon Resource Name
|
|
1982
|
-
* an alias or a key, or an alias name prefixed by "alias/".You can also
|
|
1983
|
-
* owned by Kinesis Data Streams by specifying the alias
|
|
1984
|
-
*
|
|
2049
|
+
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
2050
|
+
* This value can be a globally unique identifier, a fully specified Amazon Resource Name
|
|
2051
|
+
* (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
|
|
2052
|
+
* use a master key owned by Kinesis Data Streams by specifying the alias
|
|
2053
|
+
* <code>aws/kinesis</code>.</p>
|
|
1985
2054
|
* <ul>
|
|
1986
2055
|
* <li>
|
|
1987
2056
|
* <p>Key ARN example:
|
|
@@ -2027,11 +2096,11 @@ export interface StopStreamEncryptionInput {
|
|
|
2027
2096
|
*/
|
|
2028
2097
|
EncryptionType: EncryptionType | string | undefined;
|
|
2029
2098
|
/**
|
|
2030
|
-
* <p>The GUID for the customer-managed
|
|
2031
|
-
* be a globally unique identifier, a fully specified Amazon Resource Name
|
|
2032
|
-
* an alias or a key, or an alias name prefixed by "alias/".You can also
|
|
2033
|
-
* owned by Kinesis Data Streams by specifying the alias
|
|
2034
|
-
*
|
|
2099
|
+
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
2100
|
+
* This value can be a globally unique identifier, a fully specified Amazon Resource Name
|
|
2101
|
+
* (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
|
|
2102
|
+
* use a master key owned by Kinesis Data Streams by specifying the alias
|
|
2103
|
+
* <code>aws/kinesis</code>.</p>
|
|
2035
2104
|
* <ul>
|
|
2036
2105
|
* <li>
|
|
2037
2106
|
* <p>Key ARN example:
|
|
@@ -2068,7 +2137,7 @@ export declare namespace StopStreamEncryptionInput {
|
|
|
2068
2137
|
const filterSensitiveLog: (obj: StopStreamEncryptionInput) => any;
|
|
2069
2138
|
}
|
|
2070
2139
|
/**
|
|
2071
|
-
* <p
|
|
2140
|
+
* <p>The starting position in the data stream from which to start streaming.</p>
|
|
2072
2141
|
*/
|
|
2073
2142
|
export interface StartingPosition {
|
|
2074
2143
|
/**
|
|
@@ -2124,7 +2193,7 @@ export interface SubscribeToShardInput {
|
|
|
2124
2193
|
*/
|
|
2125
2194
|
ShardId: string | undefined;
|
|
2126
2195
|
/**
|
|
2127
|
-
* <p
|
|
2196
|
+
* <p>The starting position in the data stream from which to start streaming.</p>
|
|
2128
2197
|
*/
|
|
2129
2198
|
StartingPosition: StartingPosition | undefined;
|
|
2130
2199
|
}
|
|
@@ -2156,6 +2225,10 @@ export interface SubscribeToShardEvent {
|
|
|
2156
2225
|
* processing is caught up, and there are no new records to process at this moment.</p>
|
|
2157
2226
|
*/
|
|
2158
2227
|
MillisBehindLatest: number | undefined;
|
|
2228
|
+
/**
|
|
2229
|
+
* <p>The list of the child shards of the current shard, returned only at the end of the
|
|
2230
|
+
* current shard.</p>
|
|
2231
|
+
*/
|
|
2159
2232
|
ChildShards?: ChildShard[];
|
|
2160
2233
|
}
|
|
2161
2234
|
export declare namespace SubscribeToShardEvent {
|
|
@@ -2240,10 +2313,10 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2240
2313
|
$unknown?: never;
|
|
2241
2314
|
}
|
|
2242
2315
|
/**
|
|
2243
|
-
* <p>The request was rejected because the state of the specified resource isn't valid
|
|
2244
|
-
*
|
|
2245
|
-
* Customer Master Key</a> in the <i>
|
|
2246
|
-
* Guide</i>.</p>
|
|
2316
|
+
* <p>The request was rejected because the state of the specified resource isn't valid for
|
|
2317
|
+
* 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
|
|
2318
|
+
* Customer Master Key</a> in the <i>Amazon Web Services Key Management
|
|
2319
|
+
* Service Developer Guide</i>.</p>
|
|
2247
2320
|
*/
|
|
2248
2321
|
interface KMSInvalidStateExceptionMember {
|
|
2249
2322
|
SubscribeToShardEvent?: never;
|
|
@@ -2293,7 +2366,7 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2293
2366
|
$unknown?: never;
|
|
2294
2367
|
}
|
|
2295
2368
|
/**
|
|
2296
|
-
* <p>The
|
|
2369
|
+
* <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
|
|
2297
2370
|
*/
|
|
2298
2371
|
interface KMSOptInRequiredMember {
|
|
2299
2372
|
SubscribeToShardEvent?: never;
|
|
@@ -2311,7 +2384,8 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2311
2384
|
/**
|
|
2312
2385
|
* <p>The request was denied due to request throttling. For more information about
|
|
2313
2386
|
* throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
|
|
2314
|
-
* the <i>
|
|
2387
|
+
* the <i>Amazon Web Services Key Management Service Developer
|
|
2388
|
+
* Guide</i>.</p>
|
|
2315
2389
|
*/
|
|
2316
2390
|
interface KMSThrottlingExceptionMember {
|
|
2317
2391
|
SubscribeToShardEvent?: never;
|
|
@@ -2396,8 +2470,8 @@ export interface UpdateShardCountInput {
|
|
|
2396
2470
|
*/
|
|
2397
2471
|
StreamName: string | undefined;
|
|
2398
2472
|
/**
|
|
2399
|
-
* <p>The new number of shards. This value has the following default limits. By default,
|
|
2400
|
-
*
|
|
2473
|
+
* <p>The new number of shards. This value has the following default limits. By default, you
|
|
2474
|
+
* cannot do the following: </p>
|
|
2401
2475
|
* <ul>
|
|
2402
2476
|
* <li>
|
|
2403
2477
|
* <p>Set this value to more than double your current shard count for a
|
|
@@ -2407,13 +2481,13 @@ export interface UpdateShardCountInput {
|
|
|
2407
2481
|
* <p>Set this value below half your current shard count for a stream.</p>
|
|
2408
2482
|
* </li>
|
|
2409
2483
|
* <li>
|
|
2410
|
-
* <p>Set this value to more than
|
|
2411
|
-
* shard count per stream is
|
|
2484
|
+
* <p>Set this value to more than 10000 shards in a stream (the default limit for
|
|
2485
|
+
* shard count per stream is 10000 per account per region), unless you request a
|
|
2412
2486
|
* limit increase.</p>
|
|
2413
2487
|
* </li>
|
|
2414
2488
|
* <li>
|
|
2415
|
-
* <p>Scale a stream with more than
|
|
2416
|
-
* less than
|
|
2489
|
+
* <p>Scale a stream with more than 10000 shards down unless you set this value to
|
|
2490
|
+
* less than 10000 shards.</p>
|
|
2417
2491
|
* </li>
|
|
2418
2492
|
* </ul>
|
|
2419
2493
|
*/
|
|
@@ -2449,3 +2523,20 @@ export declare namespace UpdateShardCountOutput {
|
|
|
2449
2523
|
*/
|
|
2450
2524
|
const filterSensitiveLog: (obj: UpdateShardCountOutput) => any;
|
|
2451
2525
|
}
|
|
2526
|
+
export interface UpdateStreamModeInput {
|
|
2527
|
+
/**
|
|
2528
|
+
* <p> Specifies the ARN of the data stream whose capacity mode you want to update. </p>
|
|
2529
|
+
*/
|
|
2530
|
+
StreamARN: string | undefined;
|
|
2531
|
+
/**
|
|
2532
|
+
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
2533
|
+
* 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>
|
|
2534
|
+
*/
|
|
2535
|
+
StreamModeDetails: StreamModeDetails | undefined;
|
|
2536
|
+
}
|
|
2537
|
+
export declare namespace UpdateStreamModeInput {
|
|
2538
|
+
/**
|
|
2539
|
+
* @internal
|
|
2540
|
+
*/
|
|
2541
|
+
const filterSensitiveLog: (obj: UpdateStreamModeInput) => any;
|
|
2542
|
+
}
|