@aws-sdk/client-kinesis 3.36.0 → 3.39.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 (96) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/Kinesis.js +0 -5
  3. package/dist-cjs/KinesisClient.js +0 -10
  4. package/dist-cjs/commands/AddTagsToStreamCommand.js +0 -32
  5. package/dist-cjs/commands/CreateStreamCommand.js +0 -64
  6. package/dist-cjs/commands/DecreaseStreamRetentionPeriodCommand.js +0 -29
  7. package/dist-cjs/commands/DeleteStreamCommand.js +0 -42
  8. package/dist-cjs/commands/DeregisterStreamConsumerCommand.js +0 -31
  9. package/dist-cjs/commands/DescribeLimitsCommand.js +0 -27
  10. package/dist-cjs/commands/DescribeStreamCommand.js +0 -40
  11. package/dist-cjs/commands/DescribeStreamConsumerCommand.js +0 -31
  12. package/dist-cjs/commands/DescribeStreamSummaryCommand.js +0 -31
  13. package/dist-cjs/commands/DisableEnhancedMonitoringCommand.js +0 -24
  14. package/dist-cjs/commands/EnableEnhancedMonitoringCommand.js +0 -24
  15. package/dist-cjs/commands/GetRecordsCommand.js +0 -70
  16. package/dist-cjs/commands/GetShardIteratorCommand.js +0 -57
  17. package/dist-cjs/commands/IncreaseStreamRetentionPeriodCommand.js +0 -32
  18. package/dist-cjs/commands/ListShardsCommand.js +0 -32
  19. package/dist-cjs/commands/ListStreamConsumersCommand.js +0 -26
  20. package/dist-cjs/commands/ListStreamsCommand.js +0 -39
  21. package/dist-cjs/commands/ListTagsForStreamCommand.js +0 -25
  22. package/dist-cjs/commands/MergeShardsCommand.js +0 -59
  23. package/dist-cjs/commands/PutRecordCommand.js +0 -59
  24. package/dist-cjs/commands/PutRecordsCommand.js +0 -79
  25. package/dist-cjs/commands/RegisterStreamConsumerCommand.js +0 -37
  26. package/dist-cjs/commands/RemoveTagsFromStreamCommand.js +0 -29
  27. package/dist-cjs/commands/SplitShardCommand.js +0 -65
  28. package/dist-cjs/commands/StartStreamEncryptionCommand.js +0 -39
  29. package/dist-cjs/commands/StopStreamEncryptionCommand.js +0 -39
  30. package/dist-cjs/commands/SubscribeToShardCommand.js +0 -45
  31. package/dist-cjs/commands/UpdateShardCountCommand.js +0 -67
  32. package/dist-cjs/commands/index.js +31 -0
  33. package/dist-cjs/endpoints.js +6 -1
  34. package/dist-cjs/index.js +5 -34
  35. package/dist-cjs/models/models_0.js +0 -225
  36. package/dist-cjs/pagination/ListStreamConsumersPaginator.js +0 -10
  37. package/dist-cjs/pagination/index.js +5 -0
  38. package/dist-cjs/protocols/Aws_json1_1.js +0 -5
  39. package/dist-cjs/runtimeConfig.browser.js +1 -5
  40. package/dist-cjs/runtimeConfig.js +1 -5
  41. package/dist-cjs/runtimeConfig.native.js +0 -3
  42. package/dist-cjs/runtimeConfig.shared.js +0 -3
  43. package/dist-cjs/waiters/index.js +5 -0
  44. package/dist-cjs/waiters/waitForStreamExists.js +0 -9
  45. package/dist-cjs/waiters/waitForStreamNotExists.js +0 -9
  46. package/dist-es/commands/index.js +28 -0
  47. package/dist-es/endpoints.js +6 -1
  48. package/dist-es/index.js +5 -34
  49. package/dist-es/pagination/index.js +2 -0
  50. package/dist-es/waiters/index.js +2 -0
  51. package/dist-types/commands/index.d.ts +28 -0
  52. package/dist-types/index.d.ts +5 -34
  53. package/dist-types/pagination/index.d.ts +2 -0
  54. package/dist-types/ts3.4/Kinesis.d.ts +29 -591
  55. package/dist-types/ts3.4/KinesisClient.d.ts +25 -94
  56. package/dist-types/ts3.4/commands/AddTagsToStreamCommand.d.ts +2 -28
  57. package/dist-types/ts3.4/commands/CreateStreamCommand.d.ts +2 -60
  58. package/dist-types/ts3.4/commands/DecreaseStreamRetentionPeriodCommand.d.ts +2 -25
  59. package/dist-types/ts3.4/commands/DeleteStreamCommand.d.ts +2 -38
  60. package/dist-types/ts3.4/commands/DeregisterStreamConsumerCommand.d.ts +2 -27
  61. package/dist-types/ts3.4/commands/DescribeLimitsCommand.d.ts +2 -23
  62. package/dist-types/ts3.4/commands/DescribeStreamCommand.d.ts +2 -36
  63. package/dist-types/ts3.4/commands/DescribeStreamConsumerCommand.d.ts +2 -27
  64. package/dist-types/ts3.4/commands/DescribeStreamSummaryCommand.d.ts +2 -27
  65. package/dist-types/ts3.4/commands/DisableEnhancedMonitoringCommand.d.ts +2 -20
  66. package/dist-types/ts3.4/commands/EnableEnhancedMonitoringCommand.d.ts +2 -20
  67. package/dist-types/ts3.4/commands/GetRecordsCommand.d.ts +2 -66
  68. package/dist-types/ts3.4/commands/GetShardIteratorCommand.d.ts +2 -53
  69. package/dist-types/ts3.4/commands/IncreaseStreamRetentionPeriodCommand.d.ts +2 -28
  70. package/dist-types/ts3.4/commands/ListShardsCommand.d.ts +2 -28
  71. package/dist-types/ts3.4/commands/ListStreamConsumersCommand.d.ts +2 -22
  72. package/dist-types/ts3.4/commands/ListStreamsCommand.d.ts +2 -35
  73. package/dist-types/ts3.4/commands/ListTagsForStreamCommand.d.ts +2 -21
  74. package/dist-types/ts3.4/commands/MergeShardsCommand.d.ts +2 -55
  75. package/dist-types/ts3.4/commands/PutRecordCommand.d.ts +2 -55
  76. package/dist-types/ts3.4/commands/PutRecordsCommand.d.ts +2 -75
  77. package/dist-types/ts3.4/commands/RegisterStreamConsumerCommand.d.ts +2 -33
  78. package/dist-types/ts3.4/commands/RemoveTagsFromStreamCommand.d.ts +2 -25
  79. package/dist-types/ts3.4/commands/SplitShardCommand.d.ts +2 -61
  80. package/dist-types/ts3.4/commands/StartStreamEncryptionCommand.d.ts +2 -35
  81. package/dist-types/ts3.4/commands/StopStreamEncryptionCommand.d.ts +2 -35
  82. package/dist-types/ts3.4/commands/SubscribeToShardCommand.d.ts +2 -41
  83. package/dist-types/ts3.4/commands/UpdateShardCountCommand.d.ts +2 -63
  84. package/dist-types/ts3.4/commands/index.d.ts +28 -0
  85. package/dist-types/ts3.4/index.d.ts +5 -34
  86. package/dist-types/ts3.4/models/models_0.d.ts +316 -1659
  87. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  88. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  89. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  90. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  91. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  92. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  93. package/dist-types/ts3.4/waiters/waitForStreamExists.d.ts +2 -9
  94. package/dist-types/ts3.4/waiters/waitForStreamNotExists.d.ts +2 -9
  95. package/dist-types/waiters/index.d.ts +2 -0
  96. package/package.json +36 -36
@@ -1,130 +1,80 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- /**
3
- * <p>Represents the input for <code>AddTagsToStream</code>.</p>
4
- */
2
+
5
3
  export interface AddTagsToStreamInput {
6
- /**
7
- * <p>The name of the stream.</p>
8
- */
4
+
9
5
  StreamName: string | undefined;
10
- /**
11
- * <p>A set of up to 10 key-value pairs to use to create the tags.</p>
12
- */
6
+
13
7
  Tags: {
14
8
  [key: string]: string;
15
9
  } | undefined;
16
10
  }
17
11
  export declare namespace AddTagsToStreamInput {
18
- /**
19
- * @internal
20
- */
12
+
21
13
  const filterSensitiveLog: (obj: AddTagsToStreamInput) => any;
22
14
  }
23
- /**
24
- * <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
25
- * For more information, see the returned message.</p>
26
- */
15
+
27
16
  export interface InvalidArgumentException extends __SmithyException, $MetadataBearer {
28
17
  name: "InvalidArgumentException";
29
18
  $fault: "client";
30
- /**
31
- * <p>A message that provides information about the error.</p>
32
- */
19
+
33
20
  message?: string;
34
21
  }
35
22
  export declare namespace InvalidArgumentException {
36
- /**
37
- * @internal
38
- */
23
+
39
24
  const filterSensitiveLog: (obj: InvalidArgumentException) => any;
40
25
  }
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>
44
- */
26
+
45
27
  export interface LimitExceededException extends __SmithyException, $MetadataBearer {
46
28
  name: "LimitExceededException";
47
29
  $fault: "client";
48
- /**
49
- * <p>A message that provides information about the error.</p>
50
- */
30
+
51
31
  message?: string;
52
32
  }
53
33
  export declare namespace LimitExceededException {
54
- /**
55
- * @internal
56
- */
34
+
57
35
  const filterSensitiveLog: (obj: LimitExceededException) => any;
58
36
  }
59
- /**
60
- * <p>The resource is not available for this operation. For successful operation, the
61
- * resource must be in the <code>ACTIVE</code> state.</p>
62
- */
37
+
63
38
  export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
64
39
  name: "ResourceInUseException";
65
40
  $fault: "client";
66
- /**
67
- * <p>A message that provides information about the error.</p>
68
- */
41
+
69
42
  message?: string;
70
43
  }
71
44
  export declare namespace ResourceInUseException {
72
- /**
73
- * @internal
74
- */
45
+
75
46
  const filterSensitiveLog: (obj: ResourceInUseException) => any;
76
47
  }
77
- /**
78
- * <p>The requested resource could not be found. The stream might not be specified
79
- * correctly.</p>
80
- */
48
+
81
49
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
82
50
  name: "ResourceNotFoundException";
83
51
  $fault: "client";
84
- /**
85
- * <p>A message that provides information about the error.</p>
86
- */
52
+
87
53
  message?: string;
88
54
  }
89
55
  export declare namespace ResourceNotFoundException {
90
- /**
91
- * @internal
92
- */
56
+
93
57
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
94
58
  }
95
- /**
96
- * <p>The range of possible hash key values for the shard, which is a set of ordered
97
- * contiguous positive integers.</p>
98
- */
59
+
99
60
  export interface HashKeyRange {
100
- /**
101
- * <p>The starting hash key of the hash key range.</p>
102
- */
61
+
103
62
  StartingHashKey: string | undefined;
104
- /**
105
- * <p>The ending hash key of the hash key range.</p>
106
- */
63
+
107
64
  EndingHashKey: string | undefined;
108
65
  }
109
66
  export declare namespace HashKeyRange {
110
- /**
111
- * @internal
112
- */
67
+
113
68
  const filterSensitiveLog: (obj: HashKeyRange) => any;
114
69
  }
115
70
  export interface ChildShard {
116
71
  ShardId: string | undefined;
117
72
  ParentShards: string[] | undefined;
118
- /**
119
- * <p>The range of possible hash key values for the shard, which is a set of ordered
120
- * contiguous positive integers.</p>
121
- */
73
+
122
74
  HashKeyRange: HashKeyRange | undefined;
123
75
  }
124
76
  export declare namespace ChildShard {
125
- /**
126
- * @internal
127
- */
77
+
128
78
  const filterSensitiveLog: (obj: ChildShard) => any;
129
79
  }
130
80
  export declare enum ConsumerStatus {
@@ -132,214 +82,110 @@ export declare enum ConsumerStatus {
132
82
  CREATING = "CREATING",
133
83
  DELETING = "DELETING"
134
84
  }
135
- /**
136
- * <p>An object that represents the details of the consumer you registered. This type of
137
- * object is returned by <a>RegisterStreamConsumer</a>.</p>
138
- */
85
+
139
86
  export interface Consumer {
140
- /**
141
- * <p>The name of the consumer is something you choose when you register the
142
- * consumer.</p>
143
- */
87
+
144
88
  ConsumerName: string | undefined;
145
- /**
146
- * <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
147
- * this ARN to be able to call <a>SubscribeToShard</a>.</p>
148
- * <p>If you delete a consumer and then create a new one with the same name, it won't have
149
- * the same ARN. That's because consumer ARNs contain the creation timestamp. This is
150
- * important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
151
- */
89
+
152
90
  ConsumerARN: string | undefined;
153
- /**
154
- * <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
155
- * states.</p>
156
- */
91
+
157
92
  ConsumerStatus: ConsumerStatus | string | undefined;
158
- /**
159
- * <p></p>
160
- */
93
+
161
94
  ConsumerCreationTimestamp: Date | undefined;
162
95
  }
163
96
  export declare namespace Consumer {
164
- /**
165
- * @internal
166
- */
97
+
167
98
  const filterSensitiveLog: (obj: Consumer) => any;
168
99
  }
169
- /**
170
- * <p>An object that represents the details of a registered consumer. This type of object is
171
- * returned by <a>DescribeStreamConsumer</a>.</p>
172
- */
100
+
173
101
  export interface ConsumerDescription {
174
- /**
175
- * <p>The name of the consumer is something you choose when you register the
176
- * consumer.</p>
177
- */
102
+
178
103
  ConsumerName: string | undefined;
179
- /**
180
- * <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
181
- * this ARN to be able to call <a>SubscribeToShard</a>.</p>
182
- * <p>If you delete a consumer and then create a new one with the same name, it won't have
183
- * the same ARN. That's because consumer ARNs contain the creation timestamp. This is
184
- * important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
185
- */
104
+
186
105
  ConsumerARN: string | undefined;
187
- /**
188
- * <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
189
- * states.</p>
190
- */
106
+
191
107
  ConsumerStatus: ConsumerStatus | string | undefined;
192
- /**
193
- * <p></p>
194
- */
108
+
195
109
  ConsumerCreationTimestamp: Date | undefined;
196
- /**
197
- * <p>The ARN of the stream with which you registered the consumer.</p>
198
- */
110
+
199
111
  StreamARN: string | undefined;
200
112
  }
201
113
  export declare namespace ConsumerDescription {
202
- /**
203
- * @internal
204
- */
114
+
205
115
  const filterSensitiveLog: (obj: ConsumerDescription) => any;
206
116
  }
207
- /**
208
- * <p>Represents the input for <code>CreateStream</code>.</p>
209
- */
117
+
210
118
  export interface CreateStreamInput {
211
- /**
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>
216
- */
119
+
217
120
  StreamName: string | undefined;
218
- /**
219
- * <p>The number of shards that the stream will use. The throughput of the stream is a
220
- * function of the number of shards; more shards are required for greater provisioned
221
- * throughput.</p>
222
- */
121
+
223
122
  ShardCount: number | undefined;
224
123
  }
225
124
  export declare namespace CreateStreamInput {
226
- /**
227
- * @internal
228
- */
125
+
229
126
  const filterSensitiveLog: (obj: CreateStreamInput) => any;
230
127
  }
231
- /**
232
- * <p>Represents the input for <a>DecreaseStreamRetentionPeriod</a>.</p>
233
- */
128
+
234
129
  export interface DecreaseStreamRetentionPeriodInput {
235
- /**
236
- * <p>The name of the stream to modify.</p>
237
- */
130
+
238
131
  StreamName: string | undefined;
239
- /**
240
- * <p>The new retention period of the stream, in hours. Must be less than the current
241
- * retention period.</p>
242
- */
132
+
243
133
  RetentionPeriodHours: number | undefined;
244
134
  }
245
135
  export declare namespace DecreaseStreamRetentionPeriodInput {
246
- /**
247
- * @internal
248
- */
136
+
249
137
  const filterSensitiveLog: (obj: DecreaseStreamRetentionPeriodInput) => any;
250
138
  }
251
- /**
252
- * <p>Represents the input for <a>DeleteStream</a>.</p>
253
- */
139
+
254
140
  export interface DeleteStreamInput {
255
- /**
256
- * <p>The name of the stream to delete.</p>
257
- */
141
+
258
142
  StreamName: string | undefined;
259
- /**
260
- * <p>If this parameter is unset (<code>null</code>) or if you set it to <code>false</code>,
261
- * and the stream has registered consumers, the call to <code>DeleteStream</code> fails
262
- * with a <code>ResourceInUseException</code>. </p>
263
- */
143
+
264
144
  EnforceConsumerDeletion?: boolean;
265
145
  }
266
146
  export declare namespace DeleteStreamInput {
267
- /**
268
- * @internal
269
- */
147
+
270
148
  const filterSensitiveLog: (obj: DeleteStreamInput) => any;
271
149
  }
272
150
  export interface DeregisterStreamConsumerInput {
273
- /**
274
- * <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>
276
- */
151
+
277
152
  StreamARN?: string;
278
- /**
279
- * <p>The name that you gave to the consumer.</p>
280
- */
153
+
281
154
  ConsumerName?: string;
282
- /**
283
- * <p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you
284
- * don't know the ARN of the consumer that you want to deregister, you can use the
285
- * ListStreamConsumers operation to get a list of the descriptions of all the consumers
286
- * that are currently registered with a given data stream. The description of a consumer
287
- * contains its ARN.</p>
288
- */
155
+
289
156
  ConsumerARN?: string;
290
157
  }
291
158
  export declare namespace DeregisterStreamConsumerInput {
292
- /**
293
- * @internal
294
- */
159
+
295
160
  const filterSensitiveLog: (obj: DeregisterStreamConsumerInput) => any;
296
161
  }
297
162
  export interface DescribeLimitsInput {
298
163
  }
299
164
  export declare namespace DescribeLimitsInput {
300
- /**
301
- * @internal
302
- */
165
+
303
166
  const filterSensitiveLog: (obj: DescribeLimitsInput) => any;
304
167
  }
305
168
  export interface DescribeLimitsOutput {
306
- /**
307
- * <p>The maximum number of shards.</p>
308
- */
169
+
309
170
  ShardLimit: number | undefined;
310
- /**
311
- * <p>The number of open shards.</p>
312
- */
171
+
313
172
  OpenShardCount: number | undefined;
314
173
  }
315
174
  export declare namespace DescribeLimitsOutput {
316
- /**
317
- * @internal
318
- */
175
+
319
176
  const filterSensitiveLog: (obj: DescribeLimitsOutput) => any;
320
177
  }
321
- /**
322
- * <p>Represents the input for <code>DescribeStream</code>.</p>
323
- */
178
+
324
179
  export interface DescribeStreamInput {
325
- /**
326
- * <p>The name of the stream to describe.</p>
327
- */
180
+
328
181
  StreamName: string | undefined;
329
- /**
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>
332
- */
182
+
333
183
  Limit?: number;
334
- /**
335
- * <p>The shard ID of the shard to start with.</p>
336
- */
184
+
337
185
  ExclusiveStartShardId?: string;
338
186
  }
339
187
  export declare namespace DescribeStreamInput {
340
- /**
341
- * @internal
342
- */
188
+
343
189
  const filterSensitiveLog: (obj: DescribeStreamInput) => any;
344
190
  }
345
191
  export declare enum EncryptionType {
@@ -356,118 +202,41 @@ export declare enum MetricsName {
356
202
  READ_PROVISIONED_THROUGHPUT_EXCEEDED = "ReadProvisionedThroughputExceeded",
357
203
  WRITE_PROVISIONED_THROUGHPUT_EXCEEDED = "WriteProvisionedThroughputExceeded"
358
204
  }
359
- /**
360
- * <p>Represents enhanced metrics types.</p>
361
- */
205
+
362
206
  export interface EnhancedMetrics {
363
- /**
364
- * <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>
367
- * <ul>
368
- * <li>
369
- * <p>
370
- * <code>IncomingBytes</code>
371
- * </p>
372
- * </li>
373
- * <li>
374
- * <p>
375
- * <code>IncomingRecords</code>
376
- * </p>
377
- * </li>
378
- * <li>
379
- * <p>
380
- * <code>OutgoingBytes</code>
381
- * </p>
382
- * </li>
383
- * <li>
384
- * <p>
385
- * <code>OutgoingRecords</code>
386
- * </p>
387
- * </li>
388
- * <li>
389
- * <p>
390
- * <code>WriteProvisionedThroughputExceeded</code>
391
- * </p>
392
- * </li>
393
- * <li>
394
- * <p>
395
- * <code>ReadProvisionedThroughputExceeded</code>
396
- * </p>
397
- * </li>
398
- * <li>
399
- * <p>
400
- * <code>IteratorAgeMilliseconds</code>
401
- * </p>
402
- * </li>
403
- * <li>
404
- * <p>
405
- * <code>ALL</code>
406
- * </p>
407
- * </li>
408
- * </ul>
409
- * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
410
- * Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
411
- * Kinesis Data Streams Developer Guide</i>.</p>
412
- */
207
+
413
208
  ShardLevelMetrics?: (MetricsName | string)[];
414
209
  }
415
210
  export declare namespace EnhancedMetrics {
416
- /**
417
- * @internal
418
- */
211
+
419
212
  const filterSensitiveLog: (obj: EnhancedMetrics) => any;
420
213
  }
421
- /**
422
- * <p>The range of possible sequence numbers for the shard.</p>
423
- */
214
+
424
215
  export interface SequenceNumberRange {
425
- /**
426
- * <p>The starting sequence number for the range.</p>
427
- */
216
+
428
217
  StartingSequenceNumber: string | undefined;
429
- /**
430
- * <p>The ending sequence number for the range. Shards that are in the OPEN state have an
431
- * ending sequence number of <code>null</code>.</p>
432
- */
218
+
433
219
  EndingSequenceNumber?: string;
434
220
  }
435
221
  export declare namespace SequenceNumberRange {
436
- /**
437
- * @internal
438
- */
222
+
439
223
  const filterSensitiveLog: (obj: SequenceNumberRange) => any;
440
224
  }
441
- /**
442
- * <p>A uniquely identified group of data records in a Kinesis data stream.</p>
443
- */
225
+
444
226
  export interface Shard {
445
- /**
446
- * <p>The unique identifier of the shard within the stream.</p>
447
- */
227
+
448
228
  ShardId: string | undefined;
449
- /**
450
- * <p>The shard ID of the shard's parent.</p>
451
- */
229
+
452
230
  ParentShardId?: string;
453
- /**
454
- * <p>The shard ID of the shard adjacent to the shard's parent.</p>
455
- */
231
+
456
232
  AdjacentParentShardId?: string;
457
- /**
458
- * <p>The range of possible hash key values for the shard, which is a set of ordered
459
- * contiguous positive integers.</p>
460
- */
233
+
461
234
  HashKeyRange: HashKeyRange | undefined;
462
- /**
463
- * <p>The range of possible sequence numbers for the shard.</p>
464
- */
235
+
465
236
  SequenceNumberRange: SequenceNumberRange | undefined;
466
237
  }
467
238
  export declare namespace Shard {
468
- /**
469
- * @internal
470
- */
239
+
471
240
  const filterSensitiveLog: (obj: Shard) => any;
472
241
  }
473
242
  export declare enum StreamStatus {
@@ -476,740 +245,278 @@ export declare enum StreamStatus {
476
245
  DELETING = "DELETING",
477
246
  UPDATING = "UPDATING"
478
247
  }
479
- /**
480
- * <p>Represents the output for <a>DescribeStream</a>.</p>
481
- */
248
+
482
249
  export interface StreamDescription {
483
- /**
484
- * <p>The name of the stream being described.</p>
485
- */
250
+
486
251
  StreamName: string | undefined;
487
- /**
488
- * <p>The Amazon Resource Name (ARN) for the stream being described.</p>
489
- */
252
+
490
253
  StreamARN: string | undefined;
491
- /**
492
- * <p>The current status of the stream being described. The stream status is one of the
493
- * following states:</p>
494
- * <ul>
495
- * <li>
496
- * <p>
497
- * <code>CREATING</code> - The stream is being created. Kinesis Data Streams
498
- * immediately returns and sets <code>StreamStatus</code> to
499
- * <code>CREATING</code>.</p>
500
- * </li>
501
- * <li>
502
- * <p>
503
- * <code>DELETING</code> - The stream is being deleted. The specified stream is in
504
- * the <code>DELETING</code> state until Kinesis Data Streams completes the
505
- * deletion.</p>
506
- * </li>
507
- * <li>
508
- * <p>
509
- * <code>ACTIVE</code> - The stream exists and is ready for read and write
510
- * operations or deletion. You should perform read and write operations only on an
511
- * <code>ACTIVE</code> stream.</p>
512
- * </li>
513
- * <li>
514
- * <p>
515
- * <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
516
- * write operations continue to work while the stream is in the
517
- * <code>UPDATING</code> state.</p>
518
- * </li>
519
- * </ul>
520
- */
254
+
521
255
  StreamStatus: StreamStatus | string | undefined;
522
- /**
523
- * <p>The shards that comprise the stream.</p>
524
- */
256
+
525
257
  Shards: Shard[] | undefined;
526
- /**
527
- * <p>If set to <code>true</code>, more shards in the stream are available to
528
- * describe.</p>
529
- */
258
+
530
259
  HasMoreShards: boolean | undefined;
531
- /**
532
- * <p>The current retention period, in hours. Minimum value of 24. Maximum value of
533
- * 168.</p>
534
- */
260
+
535
261
  RetentionPeriodHours: number | undefined;
536
- /**
537
- * <p>The approximate time that the stream was created.</p>
538
- */
262
+
539
263
  StreamCreationTimestamp: Date | undefined;
540
- /**
541
- * <p>Represents the current enhanced monitoring settings of the stream.</p>
542
- */
264
+
543
265
  EnhancedMonitoring: EnhancedMetrics[] | undefined;
544
- /**
545
- * <p>The server-side encryption type used on the stream. This parameter can be one of
546
- * the following values:</p>
547
- * <ul>
548
- * <li>
549
- * <p>
550
- * <code>NONE</code>: Do not encrypt the records in the stream.</p>
551
- * </li>
552
- * <li>
553
- * <p>
554
- * <code>KMS</code>: Use server-side encryption on the records in the stream
555
- * using a customer-managed AWS KMS key.</p>
556
- * </li>
557
- * </ul>
558
- */
266
+
559
267
  EncryptionType?: EncryptionType | string;
560
- /**
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>
565
- * <ul>
566
- * <li>
567
- * <p>Key ARN example:
568
- * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
569
- * </p>
570
- * </li>
571
- * <li>
572
- * <p>Alias ARN example:
573
- * <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
574
- * </p>
575
- * </li>
576
- * <li>
577
- * <p>Globally unique key ID example:
578
- * <code>12345678-1234-1234-1234-123456789012</code>
579
- * </p>
580
- * </li>
581
- * <li>
582
- * <p>Alias name example: <code>alias/MyAliasName</code>
583
- * </p>
584
- * </li>
585
- * <li>
586
- * <p>Master key owned by Kinesis Data Streams:
587
- * <code>alias/aws/kinesis</code>
588
- * </p>
589
- * </li>
590
- * </ul>
591
- */
268
+
592
269
  KeyId?: string;
593
270
  }
594
271
  export declare namespace StreamDescription {
595
- /**
596
- * @internal
597
- */
272
+
598
273
  const filterSensitiveLog: (obj: StreamDescription) => any;
599
274
  }
600
- /**
601
- * <p>Represents the output for <code>DescribeStream</code>.</p>
602
- */
275
+
603
276
  export interface DescribeStreamOutput {
604
- /**
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
607
- * available.</p>
608
- */
277
+
609
278
  StreamDescription: StreamDescription | undefined;
610
279
  }
611
280
  export declare namespace DescribeStreamOutput {
612
- /**
613
- * @internal
614
- */
281
+
615
282
  const filterSensitiveLog: (obj: DescribeStreamOutput) => any;
616
283
  }
617
284
  export interface DescribeStreamConsumerInput {
618
- /**
619
- * <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>
621
- */
285
+
622
286
  StreamARN?: string;
623
- /**
624
- * <p>The name that you gave to the consumer.</p>
625
- */
287
+
626
288
  ConsumerName?: string;
627
- /**
628
- * <p>The ARN returned by Kinesis Data Streams when you registered the consumer.</p>
629
- */
289
+
630
290
  ConsumerARN?: string;
631
291
  }
632
292
  export declare namespace DescribeStreamConsumerInput {
633
- /**
634
- * @internal
635
- */
293
+
636
294
  const filterSensitiveLog: (obj: DescribeStreamConsumerInput) => any;
637
295
  }
638
296
  export interface DescribeStreamConsumerOutput {
639
- /**
640
- * <p>An object that represents the details of the consumer.</p>
641
- */
297
+
642
298
  ConsumerDescription: ConsumerDescription | undefined;
643
299
  }
644
300
  export declare namespace DescribeStreamConsumerOutput {
645
- /**
646
- * @internal
647
- */
301
+
648
302
  const filterSensitiveLog: (obj: DescribeStreamConsumerOutput) => any;
649
303
  }
650
304
  export interface DescribeStreamSummaryInput {
651
- /**
652
- * <p>The name of the stream to describe.</p>
653
- */
305
+
654
306
  StreamName: string | undefined;
655
307
  }
656
308
  export declare namespace DescribeStreamSummaryInput {
657
- /**
658
- * @internal
659
- */
309
+
660
310
  const filterSensitiveLog: (obj: DescribeStreamSummaryInput) => any;
661
311
  }
662
- /**
663
- * <p>Represents the output for <a>DescribeStreamSummary</a>
664
- * </p>
665
- */
312
+
666
313
  export interface StreamDescriptionSummary {
667
- /**
668
- * <p>The name of the stream being described.</p>
669
- */
314
+
670
315
  StreamName: string | undefined;
671
- /**
672
- * <p>The Amazon Resource Name (ARN) for the stream being described.</p>
673
- */
316
+
674
317
  StreamARN: string | undefined;
675
- /**
676
- * <p>The current status of the stream being described. The stream status is one of the
677
- * following states:</p>
678
- * <ul>
679
- * <li>
680
- * <p>
681
- * <code>CREATING</code> - The stream is being created. Kinesis Data Streams
682
- * immediately returns and sets <code>StreamStatus</code> to
683
- * <code>CREATING</code>.</p>
684
- * </li>
685
- * <li>
686
- * <p>
687
- * <code>DELETING</code> - The stream is being deleted. The specified stream is in
688
- * the <code>DELETING</code> state until Kinesis Data Streams completes the
689
- * deletion.</p>
690
- * </li>
691
- * <li>
692
- * <p>
693
- * <code>ACTIVE</code> - The stream exists and is ready for read and write
694
- * operations or deletion. You should perform read and write operations only on an
695
- * <code>ACTIVE</code> stream.</p>
696
- * </li>
697
- * <li>
698
- * <p>
699
- * <code>UPDATING</code> - Shards in the stream are being merged or split. Read and
700
- * write operations continue to work while the stream is in the
701
- * <code>UPDATING</code> state.</p>
702
- * </li>
703
- * </ul>
704
- */
318
+
705
319
  StreamStatus: StreamStatus | string | undefined;
706
- /**
707
- * <p>The current retention period, in hours.</p>
708
- */
320
+
709
321
  RetentionPeriodHours: number | undefined;
710
- /**
711
- * <p>The approximate time that the stream was created.</p>
712
- */
322
+
713
323
  StreamCreationTimestamp: Date | undefined;
714
- /**
715
- * <p>Represents the current enhanced monitoring settings of the stream.</p>
716
- */
324
+
717
325
  EnhancedMonitoring: EnhancedMetrics[] | undefined;
718
- /**
719
- * <p>The encryption type used. This value is one of the following:</p>
720
- * <ul>
721
- * <li>
722
- * <p>
723
- * <code>KMS</code>
724
- * </p>
725
- * </li>
726
- * <li>
727
- * <p>
728
- * <code>NONE</code>
729
- * </p>
730
- * </li>
731
- * </ul>
732
- */
326
+
733
327
  EncryptionType?: EncryptionType | string;
734
- /**
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>
739
- * <ul>
740
- * <li>
741
- * <p>Key ARN example:
742
- * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
743
- * </p>
744
- * </li>
745
- * <li>
746
- * <p>Alias ARN example: <code>
747
- * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
748
- * </p>
749
- * </li>
750
- * <li>
751
- * <p>Globally unique key ID example:
752
- * <code>12345678-1234-1234-1234-123456789012</code>
753
- * </p>
754
- * </li>
755
- * <li>
756
- * <p>Alias name example: <code>alias/MyAliasName</code>
757
- * </p>
758
- * </li>
759
- * <li>
760
- * <p>Master key owned by Kinesis Data Streams:
761
- * <code>alias/aws/kinesis</code>
762
- * </p>
763
- * </li>
764
- * </ul>
765
- */
328
+
766
329
  KeyId?: string;
767
- /**
768
- * <p>The number of open shards in the stream.</p>
769
- */
330
+
770
331
  OpenShardCount: number | undefined;
771
- /**
772
- * <p>The number of enhanced fan-out consumers registered with the stream.</p>
773
- */
332
+
774
333
  ConsumerCount?: number;
775
334
  }
776
335
  export declare namespace StreamDescriptionSummary {
777
- /**
778
- * @internal
779
- */
336
+
780
337
  const filterSensitiveLog: (obj: StreamDescriptionSummary) => any;
781
338
  }
782
339
  export interface DescribeStreamSummaryOutput {
783
- /**
784
- * <p>A <a>StreamDescriptionSummary</a> containing information about the
785
- * stream.</p>
786
- */
340
+
787
341
  StreamDescriptionSummary: StreamDescriptionSummary | undefined;
788
342
  }
789
343
  export declare namespace DescribeStreamSummaryOutput {
790
- /**
791
- * @internal
792
- */
344
+
793
345
  const filterSensitiveLog: (obj: DescribeStreamSummaryOutput) => any;
794
346
  }
795
- /**
796
- * <p>Represents the input for <a>DisableEnhancedMonitoring</a>.</p>
797
- */
347
+
798
348
  export interface DisableEnhancedMonitoringInput {
799
- /**
800
- * <p>The name of the Kinesis data stream for which to disable enhanced
801
- * monitoring.</p>
802
- */
349
+
803
350
  StreamName: string | undefined;
804
- /**
805
- * <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>
808
- * <ul>
809
- * <li>
810
- * <p>
811
- * <code>IncomingBytes</code>
812
- * </p>
813
- * </li>
814
- * <li>
815
- * <p>
816
- * <code>IncomingRecords</code>
817
- * </p>
818
- * </li>
819
- * <li>
820
- * <p>
821
- * <code>OutgoingBytes</code>
822
- * </p>
823
- * </li>
824
- * <li>
825
- * <p>
826
- * <code>OutgoingRecords</code>
827
- * </p>
828
- * </li>
829
- * <li>
830
- * <p>
831
- * <code>WriteProvisionedThroughputExceeded</code>
832
- * </p>
833
- * </li>
834
- * <li>
835
- * <p>
836
- * <code>ReadProvisionedThroughputExceeded</code>
837
- * </p>
838
- * </li>
839
- * <li>
840
- * <p>
841
- * <code>IteratorAgeMilliseconds</code>
842
- * </p>
843
- * </li>
844
- * <li>
845
- * <p>
846
- * <code>ALL</code>
847
- * </p>
848
- * </li>
849
- * </ul>
850
- * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
851
- * Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
852
- * Kinesis Data Streams Developer Guide</i>.</p>
853
- */
351
+
854
352
  ShardLevelMetrics: (MetricsName | string)[] | undefined;
855
353
  }
856
354
  export declare namespace DisableEnhancedMonitoringInput {
857
- /**
858
- * @internal
859
- */
355
+
860
356
  const filterSensitiveLog: (obj: DisableEnhancedMonitoringInput) => any;
861
357
  }
862
- /**
863
- * <p>Represents the output for <a>EnableEnhancedMonitoring</a> and <a>DisableEnhancedMonitoring</a>.</p>
864
- */
358
+
865
359
  export interface EnhancedMonitoringOutput {
866
- /**
867
- * <p>The name of the Kinesis data stream.</p>
868
- */
360
+
869
361
  StreamName?: string;
870
- /**
871
- * <p>Represents the current state of the metrics that are in the enhanced state before
872
- * the operation.</p>
873
- */
362
+
874
363
  CurrentShardLevelMetrics?: (MetricsName | string)[];
875
- /**
876
- * <p>Represents the list of all the metrics that would be in the enhanced state after
877
- * the operation.</p>
878
- */
364
+
879
365
  DesiredShardLevelMetrics?: (MetricsName | string)[];
880
366
  }
881
367
  export declare namespace EnhancedMonitoringOutput {
882
- /**
883
- * @internal
884
- */
368
+
885
369
  const filterSensitiveLog: (obj: EnhancedMonitoringOutput) => any;
886
370
  }
887
- /**
888
- * <p>Represents the input for <a>EnableEnhancedMonitoring</a>.</p>
889
- */
371
+
890
372
  export interface EnableEnhancedMonitoringInput {
891
- /**
892
- * <p>The name of the stream for which to enable enhanced monitoring.</p>
893
- */
373
+
894
374
  StreamName: string | undefined;
895
- /**
896
- * <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>
899
- * <ul>
900
- * <li>
901
- * <p>
902
- * <code>IncomingBytes</code>
903
- * </p>
904
- * </li>
905
- * <li>
906
- * <p>
907
- * <code>IncomingRecords</code>
908
- * </p>
909
- * </li>
910
- * <li>
911
- * <p>
912
- * <code>OutgoingBytes</code>
913
- * </p>
914
- * </li>
915
- * <li>
916
- * <p>
917
- * <code>OutgoingRecords</code>
918
- * </p>
919
- * </li>
920
- * <li>
921
- * <p>
922
- * <code>WriteProvisionedThroughputExceeded</code>
923
- * </p>
924
- * </li>
925
- * <li>
926
- * <p>
927
- * <code>ReadProvisionedThroughputExceeded</code>
928
- * </p>
929
- * </li>
930
- * <li>
931
- * <p>
932
- * <code>IteratorAgeMilliseconds</code>
933
- * </p>
934
- * </li>
935
- * <li>
936
- * <p>
937
- * <code>ALL</code>
938
- * </p>
939
- * </li>
940
- * </ul>
941
- * <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
942
- * Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
943
- * Kinesis Data Streams Developer Guide</i>.</p>
944
- */
375
+
945
376
  ShardLevelMetrics: (MetricsName | string)[] | undefined;
946
377
  }
947
378
  export declare namespace EnableEnhancedMonitoringInput {
948
- /**
949
- * @internal
950
- */
379
+
951
380
  const filterSensitiveLog: (obj: EnableEnhancedMonitoringInput) => any;
952
381
  }
953
- /**
954
- * <p>The provided iterator exceeds the maximum age allowed.</p>
955
- */
382
+
956
383
  export interface ExpiredIteratorException extends __SmithyException, $MetadataBearer {
957
384
  name: "ExpiredIteratorException";
958
385
  $fault: "client";
959
- /**
960
- * <p>A message that provides information about the error.</p>
961
- */
386
+
962
387
  message?: string;
963
388
  }
964
389
  export declare namespace ExpiredIteratorException {
965
- /**
966
- * @internal
967
- */
390
+
968
391
  const filterSensitiveLog: (obj: ExpiredIteratorException) => any;
969
392
  }
970
- /**
971
- * <p>The pagination token passed to the operation is expired.</p>
972
- */
393
+
973
394
  export interface ExpiredNextTokenException extends __SmithyException, $MetadataBearer {
974
395
  name: "ExpiredNextTokenException";
975
396
  $fault: "client";
976
397
  message?: string;
977
398
  }
978
399
  export declare namespace ExpiredNextTokenException {
979
- /**
980
- * @internal
981
- */
400
+
982
401
  const filterSensitiveLog: (obj: ExpiredNextTokenException) => any;
983
402
  }
984
- /**
985
- * <p>Represents the input for <a>GetRecords</a>.</p>
986
- */
403
+
987
404
  export interface GetRecordsInput {
988
- /**
989
- * <p>The position in the shard from which you want to start sequentially reading data
990
- * records. A shard iterator specifies this position using the sequence number of a data
991
- * record in the shard.</p>
992
- */
405
+
993
406
  ShardIterator: string | undefined;
994
- /**
995
- * <p>The maximum number of records to return. Specify a value of up to 10,000. If you
996
- * specify a value that is greater than 10,000, <a>GetRecords</a> throws
997
- * <code>InvalidArgumentException</code>. The default value is 10,000.</p>
998
- */
407
+
999
408
  Limit?: number;
1000
409
  }
1001
410
  export declare namespace GetRecordsInput {
1002
- /**
1003
- * @internal
1004
- */
411
+
1005
412
  const filterSensitiveLog: (obj: GetRecordsInput) => any;
1006
413
  }
1007
- /**
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>
1010
- */
414
+
1011
415
  export interface _Record {
1012
- /**
1013
- * <p>The unique identifier of the record within its shard.</p>
1014
- */
416
+
1015
417
  SequenceNumber: string | undefined;
1016
- /**
1017
- * <p>The approximate time that the record was inserted into the stream.</p>
1018
- */
418
+
1019
419
  ApproximateArrivalTimestamp?: Date;
1020
- /**
1021
- * <p>The data blob. The data in the blob is both opaque and immutable to Kinesis Data
1022
- * Streams, which does not inspect, interpret, or change the data in the blob in any way.
1023
- * When the data blob (the payload before base64-encoding) is added to the partition key
1024
- * size, the total size must not exceed the maximum record size (1 MiB).</p>
1025
- */
420
+
1026
421
  Data: Uint8Array | undefined;
1027
- /**
1028
- * <p>Identifies which shard in the stream the data record is assigned to.</p>
1029
- */
422
+
1030
423
  PartitionKey: string | undefined;
1031
- /**
1032
- * <p>The encryption type used on the record. This parameter can be one of the following
1033
- * values:</p>
1034
- * <ul>
1035
- * <li>
1036
- * <p>
1037
- * <code>NONE</code>: Do not encrypt the records in the stream.</p>
1038
- * </li>
1039
- * <li>
1040
- * <p>
1041
- * <code>KMS</code>: Use server-side encryption on the records in the stream
1042
- * using a customer-managed AWS KMS key.</p>
1043
- * </li>
1044
- * </ul>
1045
- */
424
+
1046
425
  EncryptionType?: EncryptionType | string;
1047
426
  }
1048
427
  export declare namespace _Record {
1049
- /**
1050
- * @internal
1051
- */
428
+
1052
429
  const filterSensitiveLog: (obj: _Record) => any;
1053
430
  }
1054
- /**
1055
- * <p>Represents the output for <a>GetRecords</a>.</p>
1056
- */
431
+
1057
432
  export interface GetRecordsOutput {
1058
- /**
1059
- * <p>The data records retrieved from the shard.</p>
1060
- */
433
+
1061
434
  Records: _Record[] | undefined;
1062
- /**
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>
1066
- */
435
+
1067
436
  NextShardIterator?: string;
1068
- /**
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>
1073
- */
437
+
1074
438
  MillisBehindLatest?: number;
1075
439
  ChildShards?: ChildShard[];
1076
440
  }
1077
441
  export declare namespace GetRecordsOutput {
1078
- /**
1079
- * @internal
1080
- */
442
+
1081
443
  const filterSensitiveLog: (obj: GetRecordsOutput) => any;
1082
444
  }
1083
- /**
1084
- * <p>The ciphertext references a key that doesn't exist or that you don't have access
1085
- * to.</p>
1086
- */
445
+
1087
446
  export interface KMSAccessDeniedException extends __SmithyException, $MetadataBearer {
1088
447
  name: "KMSAccessDeniedException";
1089
448
  $fault: "client";
1090
- /**
1091
- * <p>A message that provides information about the error.</p>
1092
- */
449
+
1093
450
  message?: string;
1094
451
  }
1095
452
  export declare namespace KMSAccessDeniedException {
1096
- /**
1097
- * @internal
1098
- */
453
+
1099
454
  const filterSensitiveLog: (obj: KMSAccessDeniedException) => any;
1100
455
  }
1101
- /**
1102
- * <p>The request was rejected because the specified customer master key (CMK) isn't
1103
- * enabled.</p>
1104
- */
456
+
1105
457
  export interface KMSDisabledException extends __SmithyException, $MetadataBearer {
1106
458
  name: "KMSDisabledException";
1107
459
  $fault: "client";
1108
- /**
1109
- * <p>A message that provides information about the error.</p>
1110
- */
460
+
1111
461
  message?: string;
1112
462
  }
1113
463
  export declare namespace KMSDisabledException {
1114
- /**
1115
- * @internal
1116
- */
464
+
1117
465
  const filterSensitiveLog: (obj: KMSDisabledException) => any;
1118
466
  }
1119
- /**
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>
1124
- */
467
+
1125
468
  export interface KMSInvalidStateException extends __SmithyException, $MetadataBearer {
1126
469
  name: "KMSInvalidStateException";
1127
470
  $fault: "client";
1128
- /**
1129
- * <p>A message that provides information about the error.</p>
1130
- */
471
+
1131
472
  message?: string;
1132
473
  }
1133
474
  export declare namespace KMSInvalidStateException {
1134
- /**
1135
- * @internal
1136
- */
475
+
1137
476
  const filterSensitiveLog: (obj: KMSInvalidStateException) => any;
1138
477
  }
1139
- /**
1140
- * <p>The request was rejected because the specified entity or resource can't be
1141
- * found.</p>
1142
- */
478
+
1143
479
  export interface KMSNotFoundException extends __SmithyException, $MetadataBearer {
1144
480
  name: "KMSNotFoundException";
1145
481
  $fault: "client";
1146
- /**
1147
- * <p>A message that provides information about the error.</p>
1148
- */
482
+
1149
483
  message?: string;
1150
484
  }
1151
485
  export declare namespace KMSNotFoundException {
1152
- /**
1153
- * @internal
1154
- */
486
+
1155
487
  const filterSensitiveLog: (obj: KMSNotFoundException) => any;
1156
488
  }
1157
- /**
1158
- * <p>The AWS access key ID needs a subscription for the service.</p>
1159
- */
489
+
1160
490
  export interface KMSOptInRequired extends __SmithyException, $MetadataBearer {
1161
491
  name: "KMSOptInRequired";
1162
492
  $fault: "client";
1163
- /**
1164
- * <p>A message that provides information about the error.</p>
1165
- */
493
+
1166
494
  message?: string;
1167
495
  }
1168
496
  export declare namespace KMSOptInRequired {
1169
- /**
1170
- * @internal
1171
- */
497
+
1172
498
  const filterSensitiveLog: (obj: KMSOptInRequired) => any;
1173
499
  }
1174
- /**
1175
- * <p>The request was denied due to request throttling. For more information about
1176
- * 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>
1178
- */
500
+
1179
501
  export interface KMSThrottlingException extends __SmithyException, $MetadataBearer {
1180
502
  name: "KMSThrottlingException";
1181
503
  $fault: "client";
1182
- /**
1183
- * <p>A message that provides information about the error.</p>
1184
- */
504
+
1185
505
  message?: string;
1186
506
  }
1187
507
  export declare namespace KMSThrottlingException {
1188
- /**
1189
- * @internal
1190
- */
508
+
1191
509
  const filterSensitiveLog: (obj: KMSThrottlingException) => any;
1192
510
  }
1193
- /**
1194
- * <p>The request rate for the stream is too high, or the requested data is too large for
1195
- * the available throughput. Reduce the frequency or size of your requests. For more
1196
- * information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Streams Limits</a> in the
1197
- * <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>
1200
- */
511
+
1201
512
  export interface ProvisionedThroughputExceededException extends __SmithyException, $MetadataBearer {
1202
513
  name: "ProvisionedThroughputExceededException";
1203
514
  $fault: "client";
1204
- /**
1205
- * <p>A message that provides information about the error.</p>
1206
- */
515
+
1207
516
  message?: string;
1208
517
  }
1209
518
  export declare namespace ProvisionedThroughputExceededException {
1210
- /**
1211
- * @internal
1212
- */
519
+
1213
520
  const filterSensitiveLog: (obj: ProvisionedThroughputExceededException) => any;
1214
521
  }
1215
522
  export declare enum ShardIteratorType {
@@ -1219,125 +526,51 @@ export declare enum ShardIteratorType {
1219
526
  LATEST = "LATEST",
1220
527
  TRIM_HORIZON = "TRIM_HORIZON"
1221
528
  }
1222
- /**
1223
- * <p>Represents the input for <code>GetShardIterator</code>.</p>
1224
- */
529
+
1225
530
  export interface GetShardIteratorInput {
1226
- /**
1227
- * <p>The name of the Amazon Kinesis data stream.</p>
1228
- */
531
+
1229
532
  StreamName: string | undefined;
1230
- /**
1231
- * <p>The shard ID of the Kinesis Data Streams shard to get the iterator for.</p>
1232
- */
533
+
1233
534
  ShardId: string | undefined;
1234
- /**
1235
- * <p>Determines how the shard iterator is used to start reading data records from the
1236
- * shard.</p>
1237
- * <p>The following are the valid Amazon Kinesis shard iterator types:</p>
1238
- * <ul>
1239
- * <li>
1240
- *
1241
- * <p>AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific
1242
- * sequence number, provided in the value
1243
- * <code>StartingSequenceNumber</code>.</p>
1244
- * </li>
1245
- * <li>
1246
- *
1247
- * <p>AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a
1248
- * specific sequence number, provided in the value
1249
- * <code>StartingSequenceNumber</code>.</p>
1250
- * </li>
1251
- * <li>
1252
- *
1253
- * <p>AT_TIMESTAMP - Start reading from the position denoted by a specific time
1254
- * stamp, provided in the value <code>Timestamp</code>.</p>
1255
- * </li>
1256
- * <li>
1257
- *
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>
1260
- * </li>
1261
- * <li>
1262
- *
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>
1265
- * </li>
1266
- * </ul>
1267
- */
535
+
1268
536
  ShardIteratorType: ShardIteratorType | string | undefined;
1269
- /**
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>
1272
- */
537
+
1273
538
  StartingSequenceNumber?: string;
1274
- /**
1275
- * <p>The time stamp of the data record from which to start reading. Used with shard
1276
- * iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in
1277
- * milliseconds. For example, <code>2016-04-04T19:58:46.480-00:00</code> or
1278
- * <code>1459799926.480</code>. If a record with this exact time stamp does not exist,
1279
- * the iterator returned is for the next (later) record. If the time stamp is older than
1280
- * the current trim horizon, the iterator returned is for the oldest untrimmed data record
1281
- * (TRIM_HORIZON).</p>
1282
- */
539
+
1283
540
  Timestamp?: Date;
1284
541
  }
1285
542
  export declare namespace GetShardIteratorInput {
1286
- /**
1287
- * @internal
1288
- */
543
+
1289
544
  const filterSensitiveLog: (obj: GetShardIteratorInput) => any;
1290
545
  }
1291
- /**
1292
- * <p>Represents the output for <code>GetShardIterator</code>.</p>
1293
- */
546
+
1294
547
  export interface GetShardIteratorOutput {
1295
- /**
1296
- * <p>The position in the shard from which to start reading data records sequentially. A
1297
- * shard iterator specifies this position using the sequence number of a data record in a
1298
- * shard.</p>
1299
- */
548
+
1300
549
  ShardIterator?: string;
1301
550
  }
1302
551
  export declare namespace GetShardIteratorOutput {
1303
- /**
1304
- * @internal
1305
- */
552
+
1306
553
  const filterSensitiveLog: (obj: GetShardIteratorOutput) => any;
1307
554
  }
1308
- /**
1309
- * <p>Represents the input for <a>IncreaseStreamRetentionPeriod</a>.</p>
1310
- */
555
+
1311
556
  export interface IncreaseStreamRetentionPeriodInput {
1312
- /**
1313
- * <p>The name of the stream to modify.</p>
1314
- */
557
+
1315
558
  StreamName: string | undefined;
1316
- /**
1317
- * <p>The new retention period of the stream, in hours. Must be more than the current
1318
- * retention period.</p>
1319
- */
559
+
1320
560
  RetentionPeriodHours: number | undefined;
1321
561
  }
1322
562
  export declare namespace IncreaseStreamRetentionPeriodInput {
1323
- /**
1324
- * @internal
1325
- */
563
+
1326
564
  const filterSensitiveLog: (obj: IncreaseStreamRetentionPeriodInput) => any;
1327
565
  }
1328
- /**
1329
- * <p>The processing of the request failed because of an unknown error, exception, or
1330
- * failure.</p>
1331
- */
566
+
1332
567
  export interface InternalFailureException extends __SmithyException {
1333
568
  name: "InternalFailureException";
1334
569
  $fault: "server";
1335
570
  message?: string;
1336
571
  }
1337
572
  export declare namespace InternalFailureException {
1338
- /**
1339
- * @internal
1340
- */
573
+
1341
574
  const filterSensitiveLog: (obj: InternalFailureException) => any;
1342
575
  }
1343
576
  export declare enum ShardFilterType {
@@ -1354,827 +587,321 @@ export interface ShardFilter {
1354
587
  Timestamp?: Date;
1355
588
  }
1356
589
  export declare namespace ShardFilter {
1357
- /**
1358
- * @internal
1359
- */
590
+
1360
591
  const filterSensitiveLog: (obj: ShardFilter) => any;
1361
592
  }
1362
593
  export interface ListShardsInput {
1363
- /**
1364
- * <p>The name of the data stream whose shards you want to list. </p>
1365
- * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1366
- * parameter.</p>
1367
- */
594
+
1368
595
  StreamName?: string;
1369
- /**
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
1372
- * <code>MaxResults</code> that is less than the number of shards in the data stream,
1373
- * the response includes a pagination token named <code>NextToken</code>. You can specify
1374
- * this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
1375
- * 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
1378
- * 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
1382
- * <code>MaxResults</code>, the response will contain a new <code>NextToken</code>
1383
- * value. You can use the new <code>NextToken</code> value in a subsequent call to the
1384
- * <code>ListShards</code> operation.</p>
1385
- * <important>
1386
- * <p>Tokens expire after 300 seconds. When you obtain a value for
1387
- * <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
1388
- * 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>
1391
- * </important>
1392
- */
596
+
1393
597
  NextToken?: string;
1394
- /**
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>
1397
- * <p>If you don't specify this parameter, the default behavior is for
1398
- * <code>ListShards</code> to list the shards starting with the first one in the
1399
- * stream.</p>
1400
- * <p>You cannot specify this parameter if you specify <code>NextToken</code>.</p>
1401
- */
598
+
1402
599
  ExclusiveStartShardId?: string;
1403
- /**
1404
- * <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>
1407
- * <p>When the number of shards to be listed is greater than the value of
1408
- * <code>MaxResults</code>, the response contains a <code>NextToken</code> value that
1409
- * you can use in a subsequent call to <code>ListShards</code> to list the next set of
1410
- * shards.</p>
1411
- */
600
+
1412
601
  MaxResults?: number;
1413
- /**
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>
1418
- * <p>You cannot specify this parameter if you specify the <code>NextToken</code>
1419
- * parameter.</p>
1420
- */
602
+
1421
603
  StreamCreationTimestamp?: Date;
1422
604
  ShardFilter?: ShardFilter;
1423
605
  }
1424
606
  export declare namespace ListShardsInput {
1425
- /**
1426
- * @internal
1427
- */
607
+
1428
608
  const filterSensitiveLog: (obj: ListShardsInput) => any;
1429
609
  }
1430
610
  export interface ListShardsOutput {
1431
- /**
1432
- * <p>An array of JSON objects. Each object represents one shard and specifies the IDs of
1433
- * the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each
1434
- * object also contains the starting and ending hash keys and the starting and ending
1435
- * sequence numbers for the shard.</p>
1436
- */
611
+
1437
612
  Shards?: Shard[];
1438
- /**
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
1441
- * <code>MaxResults</code> that is less than the number of shards in the data stream,
1442
- * the response includes a pagination token named <code>NextToken</code>. You can specify
1443
- * this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to
1444
- * list the next set of shards. For more information about the use of this pagination token
1445
- * when calling the <code>ListShards</code> operation, see <a>ListShardsInput$NextToken</a>.</p>
1446
- * <important>
1447
- * <p>Tokens expire after 300 seconds. When you obtain a value for
1448
- * <code>NextToken</code> in the response to a call to <code>ListShards</code>, you
1449
- * 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>
1452
- * </important>
1453
- */
613
+
1454
614
  NextToken?: string;
1455
615
  }
1456
616
  export declare namespace ListShardsOutput {
1457
- /**
1458
- * @internal
1459
- */
617
+
1460
618
  const filterSensitiveLog: (obj: ListShardsOutput) => any;
1461
619
  }
1462
620
  export interface ListStreamConsumersInput {
1463
- /**
1464
- * <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>
1466
- */
621
+
1467
622
  StreamARN: string | undefined;
1468
- /**
1469
- * <p>When the number of consumers that are registered with the data stream is greater than
1470
- * the default value for the <code>MaxResults</code> parameter, or if you explicitly
1471
- * specify a value for <code>MaxResults</code> that is less than the number of consumers
1472
- * that are registered with the data stream, the response includes a pagination token named
1473
- * <code>NextToken</code>. You can specify this <code>NextToken</code> value in a
1474
- * subsequent call to <code>ListStreamConsumers</code> to list the next set of registered
1475
- * consumers.</p>
1476
- * <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you
1477
- * specify <code>NextToken</code> because the latter unambiguously identifies the
1478
- * stream.</p>
1479
- * <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you
1480
- * specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that is
1481
- * less than the number of consumers that the operation returns if you don't specify
1482
- * <code>MaxResults</code>, the response will contain a new <code>NextToken</code>
1483
- * value. You can use the new <code>NextToken</code> value in a subsequent call to the
1484
- * <code>ListStreamConsumers</code> operation to list the next set of consumers.</p>
1485
- * <important>
1486
- * <p>Tokens expire after 300 seconds. When you obtain a value for
1487
- * <code>NextToken</code> in the response to a call to
1488
- * <code>ListStreamConsumers</code>, you have 300 seconds to use that value. If you
1489
- * specify an expired token in a call to <code>ListStreamConsumers</code>, you get
1490
- * <code>ExpiredNextTokenException</code>.</p>
1491
- * </important>
1492
- */
623
+
1493
624
  NextToken?: string;
1494
- /**
1495
- * <p>The maximum number of consumers that you want a single call of
1496
- * <code>ListStreamConsumers</code> to return.</p>
1497
- */
625
+
1498
626
  MaxResults?: number;
1499
- /**
1500
- * <p>Specify this input parameter to distinguish data streams that have the same name. For
1501
- * example, if you create a data stream and then delete it, and you later create another
1502
- * data stream with the same name, you can use this input parameter to specify which of the
1503
- * two streams you want to list the consumers for. </p>
1504
- * <p>You can't specify this parameter if you specify the NextToken parameter. </p>
1505
- */
627
+
1506
628
  StreamCreationTimestamp?: Date;
1507
629
  }
1508
630
  export declare namespace ListStreamConsumersInput {
1509
- /**
1510
- * @internal
1511
- */
631
+
1512
632
  const filterSensitiveLog: (obj: ListStreamConsumersInput) => any;
1513
633
  }
1514
634
  export interface ListStreamConsumersOutput {
1515
- /**
1516
- * <p>An array of JSON objects. Each object represents one registered consumer.</p>
1517
- */
635
+
1518
636
  Consumers?: Consumer[];
1519
- /**
1520
- * <p>When the number of consumers that are registered with the data stream is greater than
1521
- * the default value for the <code>MaxResults</code> parameter, or if you explicitly
1522
- * specify a value for <code>MaxResults</code> that is less than the number of registered
1523
- * consumers, the response includes a pagination token named <code>NextToken</code>. You
1524
- * can specify this <code>NextToken</code> value in a subsequent call to
1525
- * <code>ListStreamConsumers</code> to list the next set of registered consumers. For
1526
- * more information about the use of this pagination token when calling the
1527
- * <code>ListStreamConsumers</code> operation, see <a>ListStreamConsumersInput$NextToken</a>.</p>
1528
- * <important>
1529
- * <p>Tokens expire after 300 seconds. When you obtain a value for
1530
- * <code>NextToken</code> in the response to a call to
1531
- * <code>ListStreamConsumers</code>, you have 300 seconds to use that value. If you
1532
- * specify an expired token in a call to <code>ListStreamConsumers</code>, you get
1533
- * <code>ExpiredNextTokenException</code>.</p>
1534
- * </important>
1535
- */
637
+
1536
638
  NextToken?: string;
1537
639
  }
1538
640
  export declare namespace ListStreamConsumersOutput {
1539
- /**
1540
- * @internal
1541
- */
641
+
1542
642
  const filterSensitiveLog: (obj: ListStreamConsumersOutput) => any;
1543
643
  }
1544
- /**
1545
- * <p>Represents the input for <code>ListStreams</code>.</p>
1546
- */
644
+
1547
645
  export interface ListStreamsInput {
1548
- /**
1549
- * <p>The maximum number of streams to list.</p>
1550
- */
646
+
1551
647
  Limit?: number;
1552
- /**
1553
- * <p>The name of the stream to start the list with.</p>
1554
- */
648
+
1555
649
  ExclusiveStartStreamName?: string;
1556
650
  }
1557
651
  export declare namespace ListStreamsInput {
1558
- /**
1559
- * @internal
1560
- */
652
+
1561
653
  const filterSensitiveLog: (obj: ListStreamsInput) => any;
1562
654
  }
1563
- /**
1564
- * <p>Represents the output for <code>ListStreams</code>.</p>
1565
- */
655
+
1566
656
  export interface ListStreamsOutput {
1567
- /**
1568
- * <p>The names of the streams that are associated with the AWS account making the
1569
- * <code>ListStreams</code> request.</p>
1570
- */
657
+
1571
658
  StreamNames: string[] | undefined;
1572
- /**
1573
- * <p>If set to <code>true</code>, there are more streams available to list.</p>
1574
- */
659
+
1575
660
  HasMoreStreams: boolean | undefined;
1576
661
  }
1577
662
  export declare namespace ListStreamsOutput {
1578
- /**
1579
- * @internal
1580
- */
663
+
1581
664
  const filterSensitiveLog: (obj: ListStreamsOutput) => any;
1582
665
  }
1583
- /**
1584
- * <p>Represents the input for <code>ListTagsForStream</code>.</p>
1585
- */
666
+
1586
667
  export interface ListTagsForStreamInput {
1587
- /**
1588
- * <p>The name of the stream.</p>
1589
- */
668
+
1590
669
  StreamName: string | undefined;
1591
- /**
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
1594
- * <code>ExclusiveStartTagKey</code>. </p>
1595
- */
670
+
1596
671
  ExclusiveStartTagKey?: string;
1597
- /**
1598
- * <p>The number of tags to return. If this number is less than the total number of tags
1599
- * associated with the stream, <code>HasMoreTags</code> is set to <code>true</code>. To
1600
- * list additional tags, set <code>ExclusiveStartTagKey</code> to the last key in the
1601
- * response.</p>
1602
- */
672
+
1603
673
  Limit?: number;
1604
674
  }
1605
675
  export declare namespace ListTagsForStreamInput {
1606
- /**
1607
- * @internal
1608
- */
676
+
1609
677
  const filterSensitiveLog: (obj: ListTagsForStreamInput) => any;
1610
678
  }
1611
- /**
1612
- * <p>Metadata assigned to the stream, consisting of a key-value pair.</p>
1613
- */
679
+
1614
680
  export interface Tag {
1615
- /**
1616
- * <p>A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
1617
- * Unicode letters, digits, white space, _ . / = + - % @</p>
1618
- */
681
+
1619
682
  Key: string | undefined;
1620
- /**
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, _ . / = + - %
1623
- * @</p>
1624
- */
683
+
1625
684
  Value?: string;
1626
685
  }
1627
686
  export declare namespace Tag {
1628
- /**
1629
- * @internal
1630
- */
687
+
1631
688
  const filterSensitiveLog: (obj: Tag) => any;
1632
689
  }
1633
- /**
1634
- * <p>Represents the output for <code>ListTagsForStream</code>.</p>
1635
- */
690
+
1636
691
  export interface ListTagsForStreamOutput {
1637
- /**
1638
- * <p>A list of tags associated with <code>StreamName</code>, starting with the first tag
1639
- * after <code>ExclusiveStartTagKey</code> and up to the specified <code>Limit</code>.
1640
- * </p>
1641
- */
692
+
1642
693
  Tags: Tag[] | undefined;
1643
- /**
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>
1646
- */
694
+
1647
695
  HasMoreTags: boolean | undefined;
1648
696
  }
1649
697
  export declare namespace ListTagsForStreamOutput {
1650
- /**
1651
- * @internal
1652
- */
698
+
1653
699
  const filterSensitiveLog: (obj: ListTagsForStreamOutput) => any;
1654
700
  }
1655
- /**
1656
- * <p>Represents the input for <code>MergeShards</code>.</p>
1657
- */
701
+
1658
702
  export interface MergeShardsInput {
1659
- /**
1660
- * <p>The name of the stream for the merge.</p>
1661
- */
703
+
1662
704
  StreamName: string | undefined;
1663
- /**
1664
- * <p>The shard ID of the shard to combine with the adjacent shard for the
1665
- * merge.</p>
1666
- */
705
+
1667
706
  ShardToMerge: string | undefined;
1668
- /**
1669
- * <p>The shard ID of the adjacent shard for the merge.</p>
1670
- */
707
+
1671
708
  AdjacentShardToMerge: string | undefined;
1672
709
  }
1673
710
  export declare namespace MergeShardsInput {
1674
- /**
1675
- * @internal
1676
- */
711
+
1677
712
  const filterSensitiveLog: (obj: MergeShardsInput) => any;
1678
713
  }
1679
- /**
1680
- * <p>Represents the input for <code>PutRecord</code>.</p>
1681
- */
714
+
1682
715
  export interface PutRecordInput {
1683
- /**
1684
- * <p>The name of the stream to put the data record into.</p>
1685
- */
716
+
1686
717
  StreamName: string | undefined;
1687
- /**
1688
- * <p>The data blob to put into the record, which is base64-encoded when the blob is
1689
- * serialized. When the data blob (the payload before base64-encoding) is added to the
1690
- * partition key size, the total size must not exceed the maximum record size (1
1691
- * MiB).</p>
1692
- */
718
+
1693
719
  Data: Uint8Array | undefined;
1694
- /**
1695
- * <p>Determines which shard in the stream the data record is assigned to. Partition keys
1696
- * are Unicode strings with a maximum length limit of 256 characters for each key. Amazon
1697
- * Kinesis Data Streams uses the partition key as input to a hash function that maps the
1698
- * partition key and associated data to a specific shard. Specifically, an MD5 hash
1699
- * function is used to map partition keys to 128-bit integer values and to map associated
1700
- * data records to shards. As a result of this hashing mechanism, all data records with the
1701
- * same partition key map to the same shard within the stream.</p>
1702
- */
720
+
1703
721
  PartitionKey: string | undefined;
1704
- /**
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>
1707
- */
722
+
1708
723
  ExplicitHashKey?: string;
1709
- /**
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>
1715
- */
724
+
1716
725
  SequenceNumberForOrdering?: string;
1717
726
  }
1718
727
  export declare namespace PutRecordInput {
1719
- /**
1720
- * @internal
1721
- */
728
+
1722
729
  const filterSensitiveLog: (obj: PutRecordInput) => any;
1723
730
  }
1724
- /**
1725
- * <p>Represents the output for <code>PutRecord</code>.</p>
1726
- */
731
+
1727
732
  export interface PutRecordOutput {
1728
- /**
1729
- * <p>The shard ID of the shard where the data record was placed.</p>
1730
- */
733
+
1731
734
  ShardId: string | undefined;
1732
- /**
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>
1736
- */
735
+
1737
736
  SequenceNumber: string | undefined;
1738
- /**
1739
- * <p>The encryption type to use on the record. This parameter can be one of the
1740
- * following values:</p>
1741
- * <ul>
1742
- * <li>
1743
- * <p>
1744
- * <code>NONE</code>: Do not encrypt the records in the stream.</p>
1745
- * </li>
1746
- * <li>
1747
- * <p>
1748
- * <code>KMS</code>: Use server-side encryption on the records in the stream
1749
- * using a customer-managed AWS KMS key.</p>
1750
- * </li>
1751
- * </ul>
1752
- */
737
+
1753
738
  EncryptionType?: EncryptionType | string;
1754
739
  }
1755
740
  export declare namespace PutRecordOutput {
1756
- /**
1757
- * @internal
1758
- */
741
+
1759
742
  const filterSensitiveLog: (obj: PutRecordOutput) => any;
1760
743
  }
1761
- /**
1762
- * <p>Represents the output for <code>PutRecords</code>.</p>
1763
- */
744
+
1764
745
  export interface PutRecordsRequestEntry {
1765
- /**
1766
- * <p>The data blob to put into the record, which is base64-encoded when the blob is
1767
- * serialized. When the data blob (the payload before base64-encoding) is added to the
1768
- * partition key size, the total size must not exceed the maximum record size (1
1769
- * MiB).</p>
1770
- */
746
+
1771
747
  Data: Uint8Array | undefined;
1772
- /**
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>
1775
- */
748
+
1776
749
  ExplicitHashKey?: string;
1777
- /**
1778
- * <p>Determines which shard in the stream the data record is assigned to. Partition keys
1779
- * are Unicode strings with a maximum length limit of 256 characters for each key. Amazon
1780
- * Kinesis Data Streams uses the partition key as input to a hash function that maps the
1781
- * partition key and associated data to a specific shard. Specifically, an MD5 hash
1782
- * function is used to map partition keys to 128-bit integer values and to map associated
1783
- * data records to shards. As a result of this hashing mechanism, all data records with the
1784
- * same partition key map to the same shard within the stream.</p>
1785
- */
750
+
1786
751
  PartitionKey: string | undefined;
1787
752
  }
1788
753
  export declare namespace PutRecordsRequestEntry {
1789
- /**
1790
- * @internal
1791
- */
754
+
1792
755
  const filterSensitiveLog: (obj: PutRecordsRequestEntry) => any;
1793
756
  }
1794
- /**
1795
- * <p>A <code>PutRecords</code> request.</p>
1796
- */
757
+
1797
758
  export interface PutRecordsInput {
1798
- /**
1799
- * <p>The records associated with the request.</p>
1800
- */
759
+
1801
760
  Records: PutRecordsRequestEntry[] | undefined;
1802
- /**
1803
- * <p>The stream name associated with the request.</p>
1804
- */
761
+
1805
762
  StreamName: string | undefined;
1806
763
  }
1807
764
  export declare namespace PutRecordsInput {
1808
- /**
1809
- * @internal
1810
- */
765
+
1811
766
  const filterSensitiveLog: (obj: PutRecordsInput) => any;
1812
767
  }
1813
- /**
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>
1819
- */
768
+
1820
769
  export interface PutRecordsResultEntry {
1821
- /**
1822
- * <p>The sequence number for an individual record result.</p>
1823
- */
770
+
1824
771
  SequenceNumber?: string;
1825
- /**
1826
- * <p>The shard ID for an individual record result.</p>
1827
- */
772
+
1828
773
  ShardId?: string;
1829
- /**
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>
1833
- */
774
+
1834
775
  ErrorCode?: string;
1835
- /**
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
1838
- * includes the account ID, stream name, and shard ID. An <code>ErrorCode</code> value of
1839
- * <code>InternalFailure</code> has the error message <code>"Internal Service
1840
- * Failure"</code>.</p>
1841
- */
776
+
1842
777
  ErrorMessage?: string;
1843
778
  }
1844
779
  export declare namespace PutRecordsResultEntry {
1845
- /**
1846
- * @internal
1847
- */
780
+
1848
781
  const filterSensitiveLog: (obj: PutRecordsResultEntry) => any;
1849
782
  }
1850
- /**
1851
- * <p>
1852
- * <code>PutRecords</code> results.</p>
1853
- */
783
+
1854
784
  export interface PutRecordsOutput {
1855
- /**
1856
- * <p>The number of unsuccessfully processed records in a <code>PutRecords</code>
1857
- * request.</p>
1858
- */
785
+
1859
786
  FailedRecordCount?: number;
1860
- /**
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>
1866
- */
787
+
1867
788
  Records: PutRecordsResultEntry[] | undefined;
1868
- /**
1869
- * <p>The encryption type used on the records. This parameter can be one of the following
1870
- * values:</p>
1871
- * <ul>
1872
- * <li>
1873
- * <p>
1874
- * <code>NONE</code>: Do not encrypt the records.</p>
1875
- * </li>
1876
- * <li>
1877
- * <p>
1878
- * <code>KMS</code>: Use server-side encryption on the records using a
1879
- * customer-managed AWS KMS key.</p>
1880
- * </li>
1881
- * </ul>
1882
- */
789
+
1883
790
  EncryptionType?: EncryptionType | string;
1884
791
  }
1885
792
  export declare namespace PutRecordsOutput {
1886
- /**
1887
- * @internal
1888
- */
793
+
1889
794
  const filterSensitiveLog: (obj: PutRecordsOutput) => any;
1890
795
  }
1891
796
  export interface RegisterStreamConsumerInput {
1892
- /**
1893
- * <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>
1895
- */
797
+
1896
798
  StreamARN: string | undefined;
1897
- /**
1898
- * <p>For a given Kinesis data stream, each consumer must have a unique name. However,
1899
- * consumer names don't have to be unique across data streams.</p>
1900
- */
799
+
1901
800
  ConsumerName: string | undefined;
1902
801
  }
1903
802
  export declare namespace RegisterStreamConsumerInput {
1904
- /**
1905
- * @internal
1906
- */
803
+
1907
804
  const filterSensitiveLog: (obj: RegisterStreamConsumerInput) => any;
1908
805
  }
1909
806
  export interface RegisterStreamConsumerOutput {
1910
- /**
1911
- * <p>An object that represents the details of the consumer you registered. When you
1912
- * register a consumer, it gets an ARN that is generated by Kinesis Data Streams.</p>
1913
- */
807
+
1914
808
  Consumer: Consumer | undefined;
1915
809
  }
1916
810
  export declare namespace RegisterStreamConsumerOutput {
1917
- /**
1918
- * @internal
1919
- */
811
+
1920
812
  const filterSensitiveLog: (obj: RegisterStreamConsumerOutput) => any;
1921
813
  }
1922
- /**
1923
- * <p>Represents the input for <code>RemoveTagsFromStream</code>.</p>
1924
- */
814
+
1925
815
  export interface RemoveTagsFromStreamInput {
1926
- /**
1927
- * <p>The name of the stream.</p>
1928
- */
816
+
1929
817
  StreamName: string | undefined;
1930
- /**
1931
- * <p>A list of tag keys. Each corresponding tag is removed from the stream.</p>
1932
- */
818
+
1933
819
  TagKeys: string[] | undefined;
1934
820
  }
1935
821
  export declare namespace RemoveTagsFromStreamInput {
1936
- /**
1937
- * @internal
1938
- */
822
+
1939
823
  const filterSensitiveLog: (obj: RemoveTagsFromStreamInput) => any;
1940
824
  }
1941
- /**
1942
- * <p>Represents the input for <code>SplitShard</code>.</p>
1943
- */
825
+
1944
826
  export interface SplitShardInput {
1945
- /**
1946
- * <p>The name of the stream for the shard split.</p>
1947
- */
827
+
1948
828
  StreamName: string | undefined;
1949
- /**
1950
- * <p>The shard ID of the shard to split.</p>
1951
- */
829
+
1952
830
  ShardToSplit: string | undefined;
1953
- /**
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
1956
- * positive integers. The value for <code>NewStartingHashKey</code> must be in the range of
1957
- * hash keys being mapped into the shard. The <code>NewStartingHashKey</code> hash key
1958
- * value and all higher hash key values in hash key range are distributed to one of the
1959
- * child shards. All the lower hash key values in the range are distributed to the other
1960
- * child shard.</p>
1961
- */
831
+
1962
832
  NewStartingHashKey: string | undefined;
1963
833
  }
1964
834
  export declare namespace SplitShardInput {
1965
- /**
1966
- * @internal
1967
- */
835
+
1968
836
  const filterSensitiveLog: (obj: SplitShardInput) => any;
1969
837
  }
1970
838
  export interface StartStreamEncryptionInput {
1971
- /**
1972
- * <p>The name of the stream for which to start encrypting records.</p>
1973
- */
839
+
1974
840
  StreamName: string | undefined;
1975
- /**
1976
- * <p>The encryption type to use. The only valid value is <code>KMS</code>.</p>
1977
- */
841
+
1978
842
  EncryptionType: EncryptionType | string | undefined;
1979
- /**
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>
1985
- * <ul>
1986
- * <li>
1987
- * <p>Key ARN example:
1988
- * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
1989
- * </p>
1990
- * </li>
1991
- * <li>
1992
- * <p>Alias ARN example:
1993
- * <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
1994
- * </p>
1995
- * </li>
1996
- * <li>
1997
- * <p>Globally unique key ID example:
1998
- * <code>12345678-1234-1234-1234-123456789012</code>
1999
- * </p>
2000
- * </li>
2001
- * <li>
2002
- * <p>Alias name example: <code>alias/MyAliasName</code>
2003
- * </p>
2004
- * </li>
2005
- * <li>
2006
- * <p>Master key owned by Kinesis Data Streams:
2007
- * <code>alias/aws/kinesis</code>
2008
- * </p>
2009
- * </li>
2010
- * </ul>
2011
- */
843
+
2012
844
  KeyId: string | undefined;
2013
845
  }
2014
846
  export declare namespace StartStreamEncryptionInput {
2015
- /**
2016
- * @internal
2017
- */
847
+
2018
848
  const filterSensitiveLog: (obj: StartStreamEncryptionInput) => any;
2019
849
  }
2020
850
  export interface StopStreamEncryptionInput {
2021
- /**
2022
- * <p>The name of the stream on which to stop encrypting records.</p>
2023
- */
851
+
2024
852
  StreamName: string | undefined;
2025
- /**
2026
- * <p>The encryption type. The only valid value is <code>KMS</code>.</p>
2027
- */
853
+
2028
854
  EncryptionType: EncryptionType | string | undefined;
2029
- /**
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>
2035
- * <ul>
2036
- * <li>
2037
- * <p>Key ARN example:
2038
- * <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code>
2039
- * </p>
2040
- * </li>
2041
- * <li>
2042
- * <p>Alias ARN example:
2043
- * <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code>
2044
- * </p>
2045
- * </li>
2046
- * <li>
2047
- * <p>Globally unique key ID example:
2048
- * <code>12345678-1234-1234-1234-123456789012</code>
2049
- * </p>
2050
- * </li>
2051
- * <li>
2052
- * <p>Alias name example: <code>alias/MyAliasName</code>
2053
- * </p>
2054
- * </li>
2055
- * <li>
2056
- * <p>Master key owned by Kinesis Data Streams:
2057
- * <code>alias/aws/kinesis</code>
2058
- * </p>
2059
- * </li>
2060
- * </ul>
2061
- */
855
+
2062
856
  KeyId: string | undefined;
2063
857
  }
2064
858
  export declare namespace StopStreamEncryptionInput {
2065
- /**
2066
- * @internal
2067
- */
859
+
2068
860
  const filterSensitiveLog: (obj: StopStreamEncryptionInput) => any;
2069
861
  }
2070
- /**
2071
- * <p></p>
2072
- */
862
+
2073
863
  export interface StartingPosition {
2074
- /**
2075
- * <p>You can set the starting position to one of the following values:</p>
2076
- * <p>
2077
- * <code>AT_SEQUENCE_NUMBER</code>: Start streaming from the position denoted by the
2078
- * sequence number specified in the <code>SequenceNumber</code> field.</p>
2079
- * <p>
2080
- * <code>AFTER_SEQUENCE_NUMBER</code>: Start streaming right after the position denoted
2081
- * by the sequence number specified in the <code>SequenceNumber</code> field.</p>
2082
- * <p>
2083
- * <code>AT_TIMESTAMP</code>: Start streaming from the position denoted by the time stamp
2084
- * specified in the <code>Timestamp</code> field.</p>
2085
- * <p>
2086
- * <code>TRIM_HORIZON</code>: Start streaming at the last untrimmed record in the shard,
2087
- * which is the oldest data record in the shard.</p>
2088
- * <p>
2089
- * <code>LATEST</code>: Start streaming just after the most recent record in the shard,
2090
- * so that you always read the most recent data in the shard.</p>
2091
- */
864
+
2092
865
  Type: ShardIteratorType | string | undefined;
2093
- /**
2094
- * <p>The sequence number of the data record in the shard from which to start streaming. To
2095
- * specify a sequence number, set <code>StartingPosition</code> to
2096
- * <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>.</p>
2097
- */
866
+
2098
867
  SequenceNumber?: string;
2099
- /**
2100
- * <p>The time stamp of the data record from which to start reading. To specify a time
2101
- * stamp, set <code>StartingPosition</code> to <code>Type AT_TIMESTAMP</code>. A time stamp
2102
- * is the Unix epoch date with precision in milliseconds. For example,
2103
- * <code>2016-04-04T19:58:46.480-00:00</code> or <code>1459799926.480</code>. If a
2104
- * record with this exact time stamp does not exist, records will be streamed from the next
2105
- * (later) record. If the time stamp is older than the current trim horizon, records will
2106
- * be streamed from the oldest untrimmed data record (<code>TRIM_HORIZON</code>).</p>
2107
- */
868
+
2108
869
  Timestamp?: Date;
2109
870
  }
2110
871
  export declare namespace StartingPosition {
2111
- /**
2112
- * @internal
2113
- */
872
+
2114
873
  const filterSensitiveLog: (obj: StartingPosition) => any;
2115
874
  }
2116
875
  export interface SubscribeToShardInput {
2117
- /**
2118
- * <p>For this parameter, use the value you obtained when you called <a>RegisterStreamConsumer</a>.</p>
2119
- */
876
+
2120
877
  ConsumerARN: string | undefined;
2121
- /**
2122
- * <p>The ID of the shard you want to subscribe to. To see a list of all the shards for a
2123
- * given stream, use <a>ListShards</a>.</p>
2124
- */
878
+
2125
879
  ShardId: string | undefined;
2126
- /**
2127
- * <p></p>
2128
- */
880
+
2129
881
  StartingPosition: StartingPosition | undefined;
2130
882
  }
2131
883
  export declare namespace SubscribeToShardInput {
2132
- /**
2133
- * @internal
2134
- */
884
+
2135
885
  const filterSensitiveLog: (obj: SubscribeToShardInput) => any;
2136
886
  }
2137
- /**
2138
- * <p>After you call <a>SubscribeToShard</a>, Kinesis Data Streams sends events
2139
- * of this type over an HTTP/2 connection to your consumer.</p>
2140
- */
887
+
2141
888
  export interface SubscribeToShardEvent {
2142
- /**
2143
- * <p></p>
2144
- */
889
+
2145
890
  Records: _Record[] | undefined;
2146
- /**
2147
- * <p>Use this as <code>SequenceNumber</code> in the next call to <a>SubscribeToShard</a>, with <code>StartingPosition</code> set to
2148
- * <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>. Use
2149
- * <code>ContinuationSequenceNumber</code> for checkpointing because it captures your
2150
- * shard progress even when no data is written to the shard.</p>
2151
- */
891
+
2152
892
  ContinuationSequenceNumber: string | undefined;
2153
- /**
2154
- * <p>The number of milliseconds the read records are from the tip of the stream, indicating
2155
- * how far behind current time the consumer is. A value of zero indicates that record
2156
- * processing is caught up, and there are no new records to process at this moment.</p>
2157
- */
893
+
2158
894
  MillisBehindLatest: number | undefined;
2159
895
  ChildShards?: ChildShard[];
2160
896
  }
2161
897
  export declare namespace SubscribeToShardEvent {
2162
- /**
2163
- * @internal
2164
- */
898
+
2165
899
  const filterSensitiveLog: (obj: SubscribeToShardEvent) => any;
2166
900
  }
2167
- /**
2168
- * <p>This is a tagged union for all of the types of events an enhanced fan-out consumer can
2169
- * receive over HTTP/2 after a call to <a>SubscribeToShard</a>.</p>
2170
- */
901
+
2171
902
  export declare type SubscribeToShardEventStream = SubscribeToShardEventStream.InternalFailureExceptionMember | SubscribeToShardEventStream.KMSAccessDeniedExceptionMember | SubscribeToShardEventStream.KMSDisabledExceptionMember | SubscribeToShardEventStream.KMSInvalidStateExceptionMember | SubscribeToShardEventStream.KMSNotFoundExceptionMember | SubscribeToShardEventStream.KMSOptInRequiredMember | SubscribeToShardEventStream.KMSThrottlingExceptionMember | SubscribeToShardEventStream.ResourceInUseExceptionMember | SubscribeToShardEventStream.ResourceNotFoundExceptionMember | SubscribeToShardEventStream.SubscribeToShardEventMember | SubscribeToShardEventStream.$UnknownMember;
2172
903
  export declare namespace SubscribeToShardEventStream {
2173
- /**
2174
- * <p>After you call <a>SubscribeToShard</a>, Kinesis Data Streams sends events
2175
- * of this type to your consumer. For an example of how to handle these events, see <a href="/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
2176
- * Using the Kinesis Data Streams API</a>.</p>
2177
- */
904
+
2178
905
  interface SubscribeToShardEventMember {
2179
906
  SubscribeToShardEvent: SubscribeToShardEvent;
2180
907
  ResourceNotFoundException?: never;
@@ -2188,10 +915,7 @@ export declare namespace SubscribeToShardEventStream {
2188
915
  InternalFailureException?: never;
2189
916
  $unknown?: never;
2190
917
  }
2191
- /**
2192
- * <p>The requested resource could not be found. The stream might not be specified
2193
- * correctly.</p>
2194
- */
918
+
2195
919
  interface ResourceNotFoundExceptionMember {
2196
920
  SubscribeToShardEvent?: never;
2197
921
  ResourceNotFoundException: ResourceNotFoundException;
@@ -2205,10 +929,7 @@ export declare namespace SubscribeToShardEventStream {
2205
929
  InternalFailureException?: never;
2206
930
  $unknown?: never;
2207
931
  }
2208
- /**
2209
- * <p>The resource is not available for this operation. For successful operation, the
2210
- * resource must be in the <code>ACTIVE</code> state.</p>
2211
- */
932
+
2212
933
  interface ResourceInUseExceptionMember {
2213
934
  SubscribeToShardEvent?: never;
2214
935
  ResourceNotFoundException?: never;
@@ -2222,10 +943,7 @@ export declare namespace SubscribeToShardEventStream {
2222
943
  InternalFailureException?: never;
2223
944
  $unknown?: never;
2224
945
  }
2225
- /**
2226
- * <p>The request was rejected because the specified customer master key (CMK) isn't
2227
- * enabled.</p>
2228
- */
946
+
2229
947
  interface KMSDisabledExceptionMember {
2230
948
  SubscribeToShardEvent?: never;
2231
949
  ResourceNotFoundException?: never;
@@ -2239,12 +957,7 @@ export declare namespace SubscribeToShardEventStream {
2239
957
  InternalFailureException?: never;
2240
958
  $unknown?: never;
2241
959
  }
2242
- /**
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>
2247
- */
960
+
2248
961
  interface KMSInvalidStateExceptionMember {
2249
962
  SubscribeToShardEvent?: never;
2250
963
  ResourceNotFoundException?: never;
@@ -2258,10 +971,7 @@ export declare namespace SubscribeToShardEventStream {
2258
971
  InternalFailureException?: never;
2259
972
  $unknown?: never;
2260
973
  }
2261
- /**
2262
- * <p>The ciphertext references a key that doesn't exist or that you don't have access
2263
- * to.</p>
2264
- */
974
+
2265
975
  interface KMSAccessDeniedExceptionMember {
2266
976
  SubscribeToShardEvent?: never;
2267
977
  ResourceNotFoundException?: never;
@@ -2275,10 +985,7 @@ export declare namespace SubscribeToShardEventStream {
2275
985
  InternalFailureException?: never;
2276
986
  $unknown?: never;
2277
987
  }
2278
- /**
2279
- * <p>The request was rejected because the specified entity or resource can't be
2280
- * found.</p>
2281
- */
988
+
2282
989
  interface KMSNotFoundExceptionMember {
2283
990
  SubscribeToShardEvent?: never;
2284
991
  ResourceNotFoundException?: never;
@@ -2292,9 +999,7 @@ export declare namespace SubscribeToShardEventStream {
2292
999
  InternalFailureException?: never;
2293
1000
  $unknown?: never;
2294
1001
  }
2295
- /**
2296
- * <p>The AWS access key ID needs a subscription for the service.</p>
2297
- */
1002
+
2298
1003
  interface KMSOptInRequiredMember {
2299
1004
  SubscribeToShardEvent?: never;
2300
1005
  ResourceNotFoundException?: never;
@@ -2308,11 +1013,7 @@ export declare namespace SubscribeToShardEventStream {
2308
1013
  InternalFailureException?: never;
2309
1014
  $unknown?: never;
2310
1015
  }
2311
- /**
2312
- * <p>The request was denied due to request throttling. For more information about
2313
- * 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>
2315
- */
1016
+
2316
1017
  interface KMSThrottlingExceptionMember {
2317
1018
  SubscribeToShardEvent?: never;
2318
1019
  ResourceNotFoundException?: never;
@@ -2326,10 +1027,7 @@ export declare namespace SubscribeToShardEventStream {
2326
1027
  InternalFailureException?: never;
2327
1028
  $unknown?: never;
2328
1029
  }
2329
- /**
2330
- * <p>The processing of the request failed because of an unknown error, exception, or
2331
- * failure.</p>
2332
- */
1030
+
2333
1031
  interface InternalFailureExceptionMember {
2334
1032
  SubscribeToShardEvent?: never;
2335
1033
  ResourceNotFoundException?: never;
@@ -2373,82 +1071,41 @@ export declare namespace SubscribeToShardEventStream {
2373
1071
  _: (name: string, value: any) => T;
2374
1072
  }
2375
1073
  const visit: <T>(value: SubscribeToShardEventStream, visitor: Visitor<T>) => T;
2376
- /**
2377
- * @internal
2378
- */
1074
+
2379
1075
  const filterSensitiveLog: (obj: SubscribeToShardEventStream) => any;
2380
1076
  }
2381
1077
  export interface SubscribeToShardOutput {
2382
- /**
2383
- * <p>The event stream that your consumer can use to read records from the shard.</p>
2384
- */
1078
+
2385
1079
  EventStream: AsyncIterable<SubscribeToShardEventStream> | undefined;
2386
1080
  }
2387
1081
  export declare namespace SubscribeToShardOutput {
2388
- /**
2389
- * @internal
2390
- */
1082
+
2391
1083
  const filterSensitiveLog: (obj: SubscribeToShardOutput) => any;
2392
1084
  }
2393
1085
  export declare enum ScalingType {
2394
1086
  UNIFORM_SCALING = "UNIFORM_SCALING"
2395
1087
  }
2396
1088
  export interface UpdateShardCountInput {
2397
- /**
2398
- * <p>The name of the stream.</p>
2399
- */
1089
+
2400
1090
  StreamName: string | undefined;
2401
- /**
2402
- * <p>The new number of shards. This value has the following default limits. By default,
2403
- * you cannot do the following: </p>
2404
- * <ul>
2405
- * <li>
2406
- * <p>Set this value to more than double your current shard count for a
2407
- * stream.</p>
2408
- * </li>
2409
- * <li>
2410
- * <p>Set this value below half your current shard count for a stream.</p>
2411
- * </li>
2412
- * <li>
2413
- * <p>Set this value to more than 500 shards in a stream (the default limit for
2414
- * shard count per stream is 500 per account per region), unless you request a
2415
- * limit increase.</p>
2416
- * </li>
2417
- * <li>
2418
- * <p>Scale a stream with more than 500 shards down unless you set this value to
2419
- * less than 500 shards.</p>
2420
- * </li>
2421
- * </ul>
2422
- */
1091
+
2423
1092
  TargetShardCount: number | undefined;
2424
- /**
2425
- * <p>The scaling type. Uniform scaling creates shards of equal size.</p>
2426
- */
1093
+
2427
1094
  ScalingType: ScalingType | string | undefined;
2428
1095
  }
2429
1096
  export declare namespace UpdateShardCountInput {
2430
- /**
2431
- * @internal
2432
- */
1097
+
2433
1098
  const filterSensitiveLog: (obj: UpdateShardCountInput) => any;
2434
1099
  }
2435
1100
  export interface UpdateShardCountOutput {
2436
- /**
2437
- * <p>The name of the stream.</p>
2438
- */
1101
+
2439
1102
  StreamName?: string;
2440
- /**
2441
- * <p>The current number of shards.</p>
2442
- */
1103
+
2443
1104
  CurrentShardCount?: number;
2444
- /**
2445
- * <p>The updated number of shards.</p>
2446
- */
1105
+
2447
1106
  TargetShardCount?: number;
2448
1107
  }
2449
1108
  export declare namespace UpdateShardCountOutput {
2450
- /**
2451
- * @internal
2452
- */
1109
+
2453
1110
  const filterSensitiveLog: (obj: UpdateShardCountOutput) => any;
2454
1111
  }