@aws-sdk/client-kinesis 3.312.0 → 3.316.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 (7) hide show
  1. package/dist-cjs/Kinesis.js +33 -406
  2. package/dist-cjs/protocols/Aws_json1_1.js +243 -770
  3. package/dist-es/Kinesis.js +33 -406
  4. package/dist-es/protocols/Aws_json1_1.js +244 -771
  5. package/dist-types/Kinesis.d.ts +38 -657
  6. package/dist-types/ts3.4/Kinesis.d.ts +2 -1
  7. package/package.json +6 -6
package/dist-types/Kinesis.d.ts CHANGED
@@ -29,806 +29,187 @@ import { SubscribeToShardCommandInput, SubscribeToShardCommandOutput } from "./c
29
29
  import { UpdateShardCountCommandInput, UpdateShardCountCommandOutput } from "./commands/UpdateShardCountCommand";
30
30
  import { UpdateStreamModeCommandInput, UpdateStreamModeCommandOutput } from "./commands/UpdateStreamModeCommand";
31
31
  import { KinesisClient } from "./KinesisClient";
32
- /**
33
- * @public
34
- * <fullname>Amazon Kinesis Data Streams Service API Reference</fullname>
35
- * <p>Amazon Kinesis Data Streams is a managed service that scales elastically for real-time
36
- * processing of streaming big data.</p>
37
- */
38
- export declare class Kinesis extends KinesisClient {
32
+ export interface Kinesis {
39
33
  /**
40
- * @public
41
- * <p>Adds or updates tags for the specified Kinesis data stream. You can assign up to 50
42
- * tags to a data stream.</p>
43
- * <note>
44
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
45
- * parameter rather than the <code>StreamName</code> input parameter.</p>
46
- * </note>
47
- * <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code>
48
- * overwrites any existing tags that correspond to the specified tag keys.</p>
49
- * <p>
50
- * <a>AddTagsToStream</a> has a limit of five transactions per second per
51
- * account.</p>
34
+ * @see {@link AddTagsToStreamCommand}
52
35
  */
53
36
  addTagsToStream(args: AddTagsToStreamCommandInput, options?: __HttpHandlerOptions): Promise<AddTagsToStreamCommandOutput>;
54
37
  addTagsToStream(args: AddTagsToStreamCommandInput, cb: (err: any, data?: AddTagsToStreamCommandOutput) => void): void;
55
38
  addTagsToStream(args: AddTagsToStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToStreamCommandOutput) => void): void;
56
39
  /**
57
- * @public
58
- * <p>Creates a Kinesis data stream. A stream captures and transports data records that are
59
- * continuously emitted from different data sources or <i>producers</i>.
60
- * Scale-out within a stream is explicitly supported by means of shards, which are uniquely
61
- * identified groups of data records in a stream.</p>
62
- * <p>You can create your data stream using either on-demand or provisioned capacity mode.
63
- * Data streams with an on-demand mode require no capacity planning and automatically scale
64
- * to handle gigabytes of write and read throughput per minute. With the on-demand mode,
65
- * Kinesis Data Streams automatically manages the shards in order to provide the necessary
66
- * throughput. For the data streams with a provisioned mode, you must specify the number of
67
- * shards for the data stream. Each shard can support reads up to five transactions per
68
- * second, up to a maximum data read total of 2 MiB per second. Each shard can support
69
- * writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per
70
- * second. If the amount of data input increases or decreases, you can add or remove
71
- * shards.</p>
72
- * <p>The stream name identifies the stream. The name is scoped to the Amazon Web Services
73
- * account used by the application. It is also scoped by Amazon Web Services Region. That
74
- * is, two streams in two different accounts can have the same name, and two streams in the
75
- * same account, but in two different Regions, can have the same name.</p>
76
- * <p>
77
- * <code>CreateStream</code> is an asynchronous operation. Upon receiving a
78
- * <code>CreateStream</code> request, Kinesis Data Streams immediately returns and sets
79
- * the stream status to <code>CREATING</code>. After the stream is created, Kinesis Data
80
- * Streams sets the stream status to <code>ACTIVE</code>. You should perform read and write
81
- * operations only on an <code>ACTIVE</code> stream. </p>
82
- * <p>You receive a <code>LimitExceededException</code> when making a
83
- * <code>CreateStream</code> request when you try to do one of the following:</p>
84
- * <ul>
85
- * <li>
86
- * <p>Have more than five streams in the <code>CREATING</code> state at any point in
87
- * time.</p>
88
- * </li>
89
- * <li>
90
- * <p>Create more shards than are authorized for your account.</p>
91
- * </li>
92
- * </ul>
93
- * <p>For the default shard limit for an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon
94
- * Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams
95
- * Developer Guide</i>. To increase this limit, <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact Amazon Web Services
96
- * Support</a>.</p>
97
- * <p>You can use <a>DescribeStreamSummary</a> to check the stream status, which
98
- * is returned in <code>StreamStatus</code>.</p>
99
- * <p>
100
- * <a>CreateStream</a> has a limit of five transactions per second per
101
- * account.</p>
40
+ * @see {@link CreateStreamCommand}
102
41
  */
103
42
  createStream(args: CreateStreamCommandInput, options?: __HttpHandlerOptions): Promise<CreateStreamCommandOutput>;
104
43
  createStream(args: CreateStreamCommandInput, cb: (err: any, data?: CreateStreamCommandOutput) => void): void;
105
44
  createStream(args: CreateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamCommandOutput) => void): void;
106
45
  /**
107
- * @public
108
- * <p>Decreases the Kinesis data stream's retention period, which is the length of time data
109
- * records are accessible after they are added to the stream. The minimum value of a
110
- * stream's retention period is 24 hours.</p>
111
- * <note>
112
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
113
- * parameter rather than the <code>StreamName</code> input parameter.</p>
114
- * </note>
115
- * <p>This operation may result in lost data. For example, if the stream's retention period
116
- * is 48 hours and is decreased to 24 hours, any data already in the stream that is older
117
- * than 24 hours is inaccessible.</p>
46
+ * @see {@link DecreaseStreamRetentionPeriodCommand}
118
47
  */
119
48
  decreaseStreamRetentionPeriod(args: DecreaseStreamRetentionPeriodCommandInput, options?: __HttpHandlerOptions): Promise<DecreaseStreamRetentionPeriodCommandOutput>;
120
49
  decreaseStreamRetentionPeriod(args: DecreaseStreamRetentionPeriodCommandInput, cb: (err: any, data?: DecreaseStreamRetentionPeriodCommandOutput) => void): void;
121
50
  decreaseStreamRetentionPeriod(args: DecreaseStreamRetentionPeriodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecreaseStreamRetentionPeriodCommandOutput) => void): void;
122
51
  /**
123
- * @public
124
- * <p>Deletes a Kinesis data stream and all its shards and data. You must shut down any
125
- * applications that are operating on the stream before you delete the stream. If an
126
- * application attempts to operate on a deleted stream, it receives the exception
127
- * <code>ResourceNotFoundException</code>.</p>
128
- * <note>
129
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
130
- * parameter rather than the <code>StreamName</code> input parameter.</p>
131
- * </note>
132
- * <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a
133
- * <code>DeleteStream</code> request, the specified stream is in the
134
- * <code>DELETING</code> state until Kinesis Data Streams completes the
135
- * deletion.</p>
136
- * <p>
137
- * <b>Note:</b> Kinesis Data Streams might continue to accept
138
- * data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the
139
- * <code>DELETING</code> state until the stream deletion is complete.</p>
140
- * <p>When you delete a stream, any shards in that stream are also deleted, and any tags are
141
- * dissociated from the stream.</p>
142
- * <p>You can use the <a>DescribeStreamSummary</a> operation to check the state
143
- * of the stream, which is returned in <code>StreamStatus</code>.</p>
144
- * <p>
145
- * <a>DeleteStream</a> has a limit of five transactions per second per
146
- * account.</p>
52
+ * @see {@link DeleteStreamCommand}
147
53
  */
148
54
  deleteStream(args: DeleteStreamCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStreamCommandOutput>;
149
55
  deleteStream(args: DeleteStreamCommandInput, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void;
150
56
  deleteStream(args: DeleteStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamCommandOutput) => void): void;
151
57
  /**
152
- * @public
153
- * <p>To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of
154
- * the data stream and the name you gave the consumer when you registered it. You may also
155
- * provide all three parameters, as long as they don't conflict with each other. If you
156
- * don't know the name or ARN of the consumer that you want to deregister, you can use the
157
- * <a>ListStreamConsumers</a> operation to get a list of the descriptions of
158
- * all the consumers that are currently registered with a given data stream. The
159
- * description of a consumer contains its name and ARN.</p>
160
- * <p>This operation has a limit of five transactions per second per stream.</p>
58
+ * @see {@link DeregisterStreamConsumerCommand}
161
59
  */
162
60
  deregisterStreamConsumer(args: DeregisterStreamConsumerCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterStreamConsumerCommandOutput>;
163
61
  deregisterStreamConsumer(args: DeregisterStreamConsumerCommandInput, cb: (err: any, data?: DeregisterStreamConsumerCommandOutput) => void): void;
164
62
  deregisterStreamConsumer(args: DeregisterStreamConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterStreamConsumerCommandOutput) => void): void;
165
63
  /**
166
- * @public
167
- * <p>Describes the shard limits and usage for the account.</p>
168
- * <p>If you update your account limits, the old limits might be returned for a few
169
- * minutes.</p>
170
- * <p>This operation has a limit of one transaction per second per account.</p>
64
+ * @see {@link DescribeLimitsCommand}
171
65
  */
172
66
  describeLimits(args: DescribeLimitsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLimitsCommandOutput>;
173
67
  describeLimits(args: DescribeLimitsCommandInput, cb: (err: any, data?: DescribeLimitsCommandOutput) => void): void;
174
68
  describeLimits(args: DescribeLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLimitsCommandOutput) => void): void;
175
69
  /**
176
- * @public
177
- * <p>Describes the specified Kinesis data stream.</p>
178
- * <note>
179
- * <p>This API has been revised. It's highly recommended that you use the <a>DescribeStreamSummary</a> API to get a summarized description of the
180
- * specified Kinesis data stream and the <a>ListShards</a> API to list the
181
- * shards in a specified data stream and obtain information about each shard. </p>
182
- * </note>
183
- * <note>
184
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
185
- * parameter rather than the <code>StreamName</code> input parameter.</p>
186
- * </note>
187
- * <p>The information returned includes the stream name, Amazon Resource Name (ARN),
188
- * creation time, enhanced metric configuration, and shard map. The shard map is an array
189
- * of shard objects. For each shard object, there is the hash key and sequence number
190
- * ranges that the shard spans, and the IDs of any earlier shards that played in a role in
191
- * creating the shard. Every record ingested in the stream is identified by a sequence
192
- * number, which is assigned when the record is put into the stream.</p>
193
- * <p>You can limit the number of shards returned by each call. For more information, see
194
- * <a href="https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html">Retrieving
195
- * Shards from a Stream</a> in the <i>Amazon Kinesis Data Streams Developer
196
- * Guide</i>.</p>
197
- * <p>There are no guarantees about the chronological order shards returned. To process
198
- * shards in chronological order, use the ID of the parent shard to track the lineage to
199
- * the oldest shard.</p>
200
- * <p>This operation has a limit of 10 transactions per second per account.</p>
70
+ * @see {@link DescribeStreamCommand}
201
71
  */
202
72
  describeStream(args: DescribeStreamCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStreamCommandOutput>;
203
73
  describeStream(args: DescribeStreamCommandInput, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void;
204
74
  describeStream(args: DescribeStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamCommandOutput) => void): void;
205
75
  /**
206
- * @public
207
- * <p>To get the description of a registered consumer, provide the ARN of the consumer.
208
- * Alternatively, you can provide the ARN of the data stream and the name you gave the
209
- * consumer when you registered it. You may also provide all three parameters, as long as
210
- * they don't conflict with each other. If you don't know the name or ARN of the consumer
211
- * that you want to describe, you can use the <a>ListStreamConsumers</a>
212
- * operation to get a list of the descriptions of all the consumers that are currently
213
- * registered with a given data stream.</p>
214
- * <p>This operation has a limit of 20 transactions per second per stream.</p>
76
+ * @see {@link DescribeStreamConsumerCommand}
215
77
  */
216
78
  describeStreamConsumer(args: DescribeStreamConsumerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStreamConsumerCommandOutput>;
217
79
  describeStreamConsumer(args: DescribeStreamConsumerCommandInput, cb: (err: any, data?: DescribeStreamConsumerCommandOutput) => void): void;
218
80
  describeStreamConsumer(args: DescribeStreamConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamConsumerCommandOutput) => void): void;
219
81
  /**
220
- * @public
221
- * <p>Provides a summarized description of the specified Kinesis data stream without the
222
- * shard list.</p>
223
- * <note>
224
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
225
- * parameter rather than the <code>StreamName</code> input parameter.</p>
226
- * </note>
227
- * <p>The information returned includes the stream name, Amazon Resource Name (ARN), status,
228
- * record retention period, approximate creation time, monitoring, encryption details, and
229
- * open shard count. </p>
230
- * <p>
231
- * <a>DescribeStreamSummary</a> has a limit of 20 transactions per second per
232
- * account.</p>
82
+ * @see {@link DescribeStreamSummaryCommand}
233
83
  */
234
84
  describeStreamSummary(args: DescribeStreamSummaryCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStreamSummaryCommandOutput>;
235
85
  describeStreamSummary(args: DescribeStreamSummaryCommandInput, cb: (err: any, data?: DescribeStreamSummaryCommandOutput) => void): void;
236
86
  describeStreamSummary(args: DescribeStreamSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamSummaryCommandOutput) => void): void;
237
87
  /**
238
- * @public
239
- * <p>Disables enhanced monitoring.</p>
240
- * <note>
241
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
242
- * parameter rather than the <code>StreamName</code> input parameter.</p>
243
- * </note>
88
+ * @see {@link DisableEnhancedMonitoringCommand}
244
89
  */
245
90
  disableEnhancedMonitoring(args: DisableEnhancedMonitoringCommandInput, options?: __HttpHandlerOptions): Promise<DisableEnhancedMonitoringCommandOutput>;
246
91
  disableEnhancedMonitoring(args: DisableEnhancedMonitoringCommandInput, cb: (err: any, data?: DisableEnhancedMonitoringCommandOutput) => void): void;
247
92
  disableEnhancedMonitoring(args: DisableEnhancedMonitoringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableEnhancedMonitoringCommandOutput) => void): void;
248
93
  /**
249
- * @public
250
- * <p>Enables enhanced Kinesis data stream monitoring for shard-level metrics.</p>
251
- * <note>
252
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
253
- * parameter rather than the <code>StreamName</code> input parameter.</p>
254
- * </note>
94
+ * @see {@link EnableEnhancedMonitoringCommand}
255
95
  */
256
96
  enableEnhancedMonitoring(args: EnableEnhancedMonitoringCommandInput, options?: __HttpHandlerOptions): Promise<EnableEnhancedMonitoringCommandOutput>;
257
97
  enableEnhancedMonitoring(args: EnableEnhancedMonitoringCommandInput, cb: (err: any, data?: EnableEnhancedMonitoringCommandOutput) => void): void;
258
98
  enableEnhancedMonitoring(args: EnableEnhancedMonitoringCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableEnhancedMonitoringCommandOutput) => void): void;
259
99
  /**
260
- * @public
261
- * <p>Gets data records from a Kinesis data stream's shard.</p>
262
- * <note>
263
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
264
- * parameter in addition to the <code>ShardIterator</code> parameter.</p>
265
- * </note>
266
- * <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard
267
- * iterator specifies the position in the shard from which you want to start reading data
268
- * records sequentially. If there are no records available in the portion of the shard that
269
- * the iterator points to, <a>GetRecords</a> returns an empty list. It might
270
- * take multiple calls to get to a portion of the shard that contains records.</p>
271
- * <p>You can scale by provisioning multiple shards per stream while considering service
272
- * limits (for more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Data Streams
273
- * Limits</a> in the <i>Amazon Kinesis Data Streams Developer
274
- * Guide</i>). Your application should have one thread per shard, each reading
275
- * continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the
276
- * shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in
277
- * <code>NextShardIterator</code>. Specify the shard iterator returned in
278
- * <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>.
279
- * If the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>.
280
- * You can terminate the loop when the shard is closed, or when the shard iterator reaches
281
- * the record with the sequence number or other attribute that marks it as the last record
282
- * to process.</p>
283
- * <p>Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per
284
- * second. You can ensure that your calls don't exceed the maximum supported size or
285
- * throughput by using the <code>Limit</code> parameter to specify the maximum number of
286
- * records that <a>GetRecords</a> can return. Consider your average record size
287
- * when determining this limit. The maximum number of records that can be returned per call
288
- * is 10,000.</p>
289
- * <p>The size of the data returned by <a>GetRecords</a> varies depending on the
290
- * utilization of the shard. It is recommended that consumer applications retrieve records
291
- * via the <code>GetRecords</code> command using the 5 TPS limit to remain caught up.
292
- * Retrieving records less frequently can lead to consumer applications falling behind. The
293
- * maximum size of data that <a>GetRecords</a> can return is 10 MiB. If a call
294
- * returns this amount of data, subsequent calls made within the next 5 seconds throw
295
- * <code>ProvisionedThroughputExceededException</code>. If there is insufficient
296
- * provisioned throughput on the stream, subsequent calls made within the next 1 second
297
- * throw <code>ProvisionedThroughputExceededException</code>. <a>GetRecords</a>
298
- * doesn't return any data when it throws an exception. For this reason, we recommend that
299
- * you wait 1 second between calls to <a>GetRecords</a>. However, it's possible
300
- * that the application will get exceptions for longer than 1 second.</p>
301
- * <p>To detect whether the application is falling behind in processing, you can use the
302
- * <code>MillisBehindLatest</code> response attribute. You can also monitor the stream
303
- * using CloudWatch metrics and other mechanisms (see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html">Monitoring</a> in the <i>Amazon
304
- * Kinesis Data Streams Developer Guide</i>).</p>
305
- * <p>Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>,
306
- * that is set when a stream successfully receives and stores a record. This is commonly
307
- * referred to as a server-side time stamp, whereas a client-side time stamp is set when a
308
- * data producer creates or sends the record to a stream (a data producer is any data
309
- * source putting data records into a stream, for example with <a>PutRecords</a>). The time stamp has millisecond precision. There are no guarantees about the time
310
- * stamp accuracy, or that the time stamp is always increasing. For example, records in a
311
- * shard or across a stream might have time stamps that are out of order.</p>
312
- * <p>This operation has a limit of five transactions per second per shard.</p>
100
+ * @see {@link GetRecordsCommand}
313
101
  */
314
102
  getRecords(args: GetRecordsCommandInput, options?: __HttpHandlerOptions): Promise<GetRecordsCommandOutput>;
315
103
  getRecords(args: GetRecordsCommandInput, cb: (err: any, data?: GetRecordsCommandOutput) => void): void;
316
104
  getRecords(args: GetRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordsCommandOutput) => void): void;
317
105
  /**
318
- * @public
319
- * <p>Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is
320
- * returned to the requester.</p>
321
- * <note>
322
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
323
- * parameter rather than the <code>StreamName</code> input parameter.</p>
324
- * </note>
325
- * <p>A shard iterator specifies the shard position from which to start reading data records
326
- * sequentially. The position is specified using the sequence number of a data record in a
327
- * shard. A sequence number is the identifier associated with every record ingested in the
328
- * stream, and is assigned when a record is put into the stream. Each stream has one or
329
- * more shards.</p>
330
- * <p>You must specify the shard iterator type. For example, you can set the
331
- * <code>ShardIteratorType</code> parameter to read exactly from the position denoted
332
- * by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard
333
- * iterator type. Alternatively, the parameter can read right after the sequence number by
334
- * using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers
335
- * returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>,
336
- * <a>GetRecords</a>, or <a>DescribeStream</a>. In the request,
337
- * you can specify the shard iterator type <code>AT_TIMESTAMP</code> to read records from
338
- * an arbitrary point in time, <code>TRIM_HORIZON</code> to cause
339
- * <code>ShardIterator</code> to point to the last untrimmed record in the shard in the
340
- * system (the oldest data record in the shard), or <code>LATEST</code> so that you always
341
- * read the most recent data in the shard. </p>
342
- * <p>When you read repeatedly from a stream, use a <a>GetShardIterator</a>
343
- * request to get the first shard iterator for use in your first <a>GetRecords</a> request and for subsequent reads use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code>. A new shard
344
- * iterator is returned by every <a>GetRecords</a> request in
345
- * <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code>
346
- * parameter of the next <a>GetRecords</a> request. </p>
347
- * <p>If a <a>GetShardIterator</a> request is made too often, you receive a
348
- * <code>ProvisionedThroughputExceededException</code>. For more information about
349
- * throughput limits, see <a>GetRecords</a>, and <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Streams Limits</a> in the
350
- * <i>Amazon Kinesis Data Streams Developer Guide</i>.</p>
351
- * <p>If the shard is closed, <a>GetShardIterator</a> returns a valid iterator
352
- * for the last sequence number of the shard. A shard can be closed as a result of using
353
- * <a>SplitShard</a> or <a>MergeShards</a>.</p>
354
- * <p>
355
- * <a>GetShardIterator</a> has a limit of five transactions per second per
356
- * account per open shard.</p>
106
+ * @see {@link GetShardIteratorCommand}
357
107
  */
358
108
  getShardIterator(args: GetShardIteratorCommandInput, options?: __HttpHandlerOptions): Promise<GetShardIteratorCommandOutput>;
359
109
  getShardIterator(args: GetShardIteratorCommandInput, cb: (err: any, data?: GetShardIteratorCommandOutput) => void): void;
360
110
  getShardIterator(args: GetShardIteratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetShardIteratorCommandOutput) => void): void;
361
111
  /**
362
- * @public
363
- * <p>Increases the Kinesis data stream's retention period, which is the length of time data
364
- * records are accessible after they are added to the stream. The maximum value of a
365
- * stream's retention period is 8760 hours (365 days).</p>
366
- * <note>
367
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
368
- * parameter rather than the <code>StreamName</code> input parameter.</p>
369
- * </note>
370
- * <p>If you choose a longer stream retention period, this operation increases the time
371
- * period during which records that have not yet expired are accessible. However, it does
372
- * not make previous, expired data (older than the stream's previous retention period)
373
- * accessible after the operation has been called. For example, if a stream's retention
374
- * period is set to 24 hours and is increased to 168 hours, any data that is older than 24
375
- * hours remains inaccessible to consumer applications.</p>
112
+ * @see {@link IncreaseStreamRetentionPeriodCommand}
376
113
  */
377
114
  increaseStreamRetentionPeriod(args: IncreaseStreamRetentionPeriodCommandInput, options?: __HttpHandlerOptions): Promise<IncreaseStreamRetentionPeriodCommandOutput>;
378
115
  increaseStreamRetentionPeriod(args: IncreaseStreamRetentionPeriodCommandInput, cb: (err: any, data?: IncreaseStreamRetentionPeriodCommandOutput) => void): void;
379
116
  increaseStreamRetentionPeriod(args: IncreaseStreamRetentionPeriodCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IncreaseStreamRetentionPeriodCommandOutput) => void): void;
380
117
  /**
381
- * @public
382
- * <p>Lists the shards in a stream and provides information about each shard. This operation
383
- * has a limit of 1000 transactions per second per data stream.</p>
384
- * <note>
385
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
386
- * parameter rather than the <code>StreamName</code> input parameter.</p>
387
- * </note>
388
- * <p>This action does not list expired shards. For information about expired shards, see
389
- * <a href="https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing">Data Routing, Data Persistence, and Shard State after a Reshard</a>. </p>
390
- * <important>
391
- * <p>This API is a new operation that is used by the Amazon Kinesis Client Library
392
- * (KCL). If you have a fine-grained IAM policy that only allows specific operations,
393
- * you must update your policy to allow calls to this API. For more information, see
394
- * <a href="https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html">Controlling Access to Amazon Kinesis Data Streams Resources Using
395
- * IAM</a>.</p>
396
- * </important>
118
+ * @see {@link ListShardsCommand}
397
119
  */
398
120
  listShards(args: ListShardsCommandInput, options?: __HttpHandlerOptions): Promise<ListShardsCommandOutput>;
399
121
  listShards(args: ListShardsCommandInput, cb: (err: any, data?: ListShardsCommandOutput) => void): void;
400
122
  listShards(args: ListShardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListShardsCommandOutput) => void): void;
401
123
  /**
402
- * @public
403
- * <p>Lists the consumers registered to receive data from a stream using enhanced fan-out,
404
- * and provides information about each consumer.</p>
405
- * <p>This operation has a limit of 5 transactions per second per stream.</p>
124
+ * @see {@link ListStreamConsumersCommand}
406
125
  */
407
126
  listStreamConsumers(args: ListStreamConsumersCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamConsumersCommandOutput>;
408
127
  listStreamConsumers(args: ListStreamConsumersCommandInput, cb: (err: any, data?: ListStreamConsumersCommandOutput) => void): void;
409
128
  listStreamConsumers(args: ListStreamConsumersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamConsumersCommandOutput) => void): void;
410
129
  /**
411
- * @public
412
- * <p>Lists your Kinesis data streams.</p>
413
- * <p>The number of streams may be too large to return from a single call to
414
- * <code>ListStreams</code>. You can limit the number of returned streams using the
415
- * <code>Limit</code> parameter. If you do not specify a value for the
416
- * <code>Limit</code> parameter, Kinesis Data Streams uses the default limit, which is
417
- * currently 100.</p>
418
- * <p>You can detect if there are more streams available to list by using the
419
- * <code>HasMoreStreams</code> flag from the returned output. If there are more streams
420
- * available, you can request more streams by using the name of the last stream returned by
421
- * the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code>
422
- * parameter in a subsequent request to <code>ListStreams</code>. The group of stream names
423
- * returned by the subsequent request is then added to the list. You can continue this
424
- * process until all the stream names have been collected in the list. </p>
425
- * <p>
426
- * <a>ListStreams</a> has a limit of five transactions per second per
427
- * account.</p>
130
+ * @see {@link ListStreamsCommand}
428
131
  */
429
132
  listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamsCommandOutput>;
430
133
  listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
431
134
  listStreams(args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
432
135
  /**
433
- * @public
434
- * <p>Lists the tags for the specified Kinesis data stream. This operation has a limit of
435
- * five transactions per second per account.</p>
436
- * <note>
437
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
438
- * parameter rather than the <code>StreamName</code> input parameter.</p>
439
- * </note>
136
+ * @see {@link ListTagsForStreamCommand}
440
137
  */
441
138
  listTagsForStream(args: ListTagsForStreamCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForStreamCommandOutput>;
442
139
  listTagsForStream(args: ListTagsForStreamCommandInput, cb: (err: any, data?: ListTagsForStreamCommandOutput) => void): void;
443
140
  listTagsForStream(args: ListTagsForStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForStreamCommandOutput) => void): void;
444
141
  /**
445
- * @public
446
- * <p>Merges two adjacent shards in a Kinesis data stream and combines them into a single
447
- * shard to reduce the stream's capacity to ingest and transport data. This API is only
448
- * supported for the data streams with the provisioned capacity mode. Two shards are
449
- * considered adjacent if the union of the hash key ranges for the two shards form a
450
- * contiguous set with no gaps. For example, if you have two shards, one with a hash key
451
- * range of 276...381 and the other with a hash key range of 382...454, then you could
452
- * merge these two shards into a single shard that would have a hash key range of
453
- * 276...454. After the merge, the single child shard receives data for all hash key values
454
- * covered by the two parent shards.</p>
455
- * <note>
456
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
457
- * parameter rather than the <code>StreamName</code> input parameter.</p>
458
- * </note>
459
- * <p>
460
- * <code>MergeShards</code> is called when there is a need to reduce the overall capacity
461
- * of a stream because of excess capacity that is not being used. You must specify the
462
- * shard to be merged and the adjacent shard for a stream. For more information about
463
- * merging shards, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html">Merge Two
464
- * Shards</a> in the <i>Amazon Kinesis Data Streams Developer
465
- * Guide</i>.</p>
466
- * <p>If the stream is in the <code>ACTIVE</code> state, you can call
467
- * <code>MergeShards</code>. If a stream is in the <code>CREATING</code>,
468
- * <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code>
469
- * returns a <code>ResourceInUseException</code>. If the specified stream does not exist,
470
- * <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </p>
471
- * <p>You can use <a>DescribeStreamSummary</a> to check the state of the stream,
472
- * which is returned in <code>StreamStatus</code>.</p>
473
- * <p>
474
- * <code>MergeShards</code> is an asynchronous operation. Upon receiving a
475
- * <code>MergeShards</code> request, Amazon Kinesis Data Streams immediately returns a
476
- * response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the
477
- * operation is completed, Kinesis Data Streams sets the <code>StreamStatus</code> to
478
- * <code>ACTIVE</code>. Read and write operations continue to work while the stream is
479
- * in the <code>UPDATING</code> state. </p>
480
- * <p>You use <a>DescribeStreamSummary</a> and the <a>ListShards</a>
481
- * APIs to determine the shard IDs that are specified in the <code>MergeShards</code>
482
- * request. </p>
483
- * <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code>,
484
- * or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p>
485
- * <p>
486
- * <code>MergeShards</code> has a limit of five transactions per second per account.</p>
142
+ * @see {@link MergeShardsCommand}
487
143
  */
488
144
  mergeShards(args: MergeShardsCommandInput, options?: __HttpHandlerOptions): Promise<MergeShardsCommandOutput>;
489
145
  mergeShards(args: MergeShardsCommandInput, cb: (err: any, data?: MergeShardsCommandOutput) => void): void;
490
146
  mergeShards(args: MergeShardsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: MergeShardsCommandOutput) => void): void;
491
147
  /**
492
- * @public
493
- * <p>Writes a single data record into an Amazon Kinesis data stream. Call
494
- * <code>PutRecord</code> to send data into the stream for real-time ingestion and
495
- * subsequent processing, one record at a time. Each shard can support writes up to 1,000
496
- * records per second, up to a maximum data write total of 1 MiB per second.</p>
497
- * <note>
498
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
499
- * parameter rather than the <code>StreamName</code> input parameter.</p>
500
- * </note>
501
- * <p>You must specify the name of the stream that captures, stores, and transports the
502
- * data; a partition key; and the data blob itself.</p>
503
- * <p>The data blob can be any type of data; for example, a segment from a log file,
504
- * geographic/location data, website clickstream data, and so on.</p>
505
- * <p>The partition key is used by Kinesis Data Streams to distribute data across shards.
506
- * Kinesis Data Streams segregates the data records that belong to a stream into multiple
507
- * shards, using the partition key associated with each data record to determine the shard
508
- * to which a given data record belongs.</p>
509
- * <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters for
510
- * each key. An MD5 hash function is used to map partition keys to 128-bit integer values
511
- * and to map associated data records to shards using the hash key ranges of the shards.
512
- * You can override hashing the partition key to determine the shard by explicitly
513
- * specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more
514
- * information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Data Streams
515
- * Developer Guide</i>.</p>
516
- * <p>
517
- * <code>PutRecord</code> returns the shard ID of where the data record was placed and the
518
- * sequence number that was assigned to the data record.</p>
519
- * <p>Sequence numbers increase over time and are specific to a shard within a stream, not
520
- * across all shards within a stream. To guarantee strictly increasing ordering, write
521
- * serially to a shard and use the <code>SequenceNumberForOrdering</code> parameter. For
522
- * more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Data Streams
523
- * Developer Guide</i>.</p>
524
- * <important>
525
- * <p>After you write a record to a stream, you cannot modify that record or its order
526
- * within the stream.</p>
527
- * </important>
528
- * <p>If a <code>PutRecord</code> request cannot be processed because of insufficient
529
- * provisioned throughput on the shard involved in the request, <code>PutRecord</code>
530
- * throws <code>ProvisionedThroughputExceededException</code>. </p>
531
- * <p>By default, data records are accessible for 24 hours from the time that they are added
532
- * to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>
148
+ * @see {@link PutRecordCommand}
533
149
  */
534
150
  putRecord(args: PutRecordCommandInput, options?: __HttpHandlerOptions): Promise<PutRecordCommandOutput>;
535
151
  putRecord(args: PutRecordCommandInput, cb: (err: any, data?: PutRecordCommandOutput) => void): void;
536
152
  putRecord(args: PutRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordCommandOutput) => void): void;
537
153
  /**
538
- * @public
539
- * <p>Writes multiple data records into a Kinesis data stream in a single call (also
540
- * referred to as a <code>PutRecords</code> request). Use this operation to send data into
541
- * the stream for data ingestion and processing. </p>
542
- * <note>
543
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
544
- * parameter rather than the <code>StreamName</code> input parameter.</p>
545
- * </note>
546
- * <p>Each <code>PutRecords</code> request can support up to 500 records. Each record in the
547
- * request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,
548
- * including partition keys. Each shard can support writes up to 1,000 records per second,
549
- * up to a maximum data write total of 1 MiB per second.</p>
550
- * <p>You must specify the name of the stream that captures, stores, and transports the
551
- * data; and an array of request <code>Records</code>, with each record in the array
552
- * requiring a partition key and data blob. The record size limit applies to the total size
553
- * of the partition key and data blob.</p>
554
- * <p>The data blob can be any type of data; for example, a segment from a log file,
555
- * geographic/location data, website clickstream data, and so on.</p>
556
- * <p>The partition key is used by Kinesis Data Streams as input to a hash function that
557
- * maps the partition key and associated data to a specific shard. An MD5 hash function is
558
- * used to map partition keys to 128-bit integer values and to map associated data records
559
- * to shards. As a result of this hashing mechanism, all data records with the same
560
- * partition key map to the same shard within the stream. For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream">Adding Data to a Stream</a> in the <i>Amazon Kinesis Data Streams
561
- * Developer Guide</i>.</p>
562
- * <p>Each record in the <code>Records</code> array may include an optional parameter,
563
- * <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping.
564
- * This parameter allows a data producer to determine explicitly the shard where the record
565
- * is stored. For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis
566
- * Data Streams Developer Guide</i>.</p>
567
- * <p>The <code>PutRecords</code> response includes an array of response
568
- * <code>Records</code>. Each record in the response array directly correlates with a
569
- * record in the request array using natural ordering, from the top to the bottom of the
570
- * request and response. The response <code>Records</code> array always includes the same
571
- * number of records as the request array.</p>
572
- * <p>The response <code>Records</code> array includes both successfully and unsuccessfully
573
- * processed records. Kinesis Data Streams attempts to process all records in each
574
- * <code>PutRecords</code> request. A single record failure does not stop the
575
- * processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering
576
- * of records. If you need to read records in the same order they are written to the
577
- * stream, use <a>PutRecord</a> instead of <code>PutRecords</code>, and write to
578
- * the same shard.</p>
579
- * <p>A successfully processed record includes <code>ShardId</code> and
580
- * <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies
581
- * the shard in the stream where the record is stored. The <code>SequenceNumber</code>
582
- * parameter is an identifier assigned to the put record, unique to all records in the
583
- * stream.</p>
584
- * <p>An unsuccessfully processed record includes <code>ErrorCode</code> and
585
- * <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error
586
- * and can be one of the following values:
587
- * <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>.
588
- * <code>ErrorMessage</code> provides more detailed information about the
589
- * <code>ProvisionedThroughputExceededException</code> exception including the account
590
- * ID, stream name, and shard ID of the record that was throttled. For more information
591
- * about partially successful responses, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis
592
- * Data Streams Developer Guide</i>.</p>
593
- * <important>
594
- * <p>After you write a record to a stream, you cannot modify that record or its order
595
- * within the stream.</p>
596
- * </important>
597
- * <p>By default, data records are accessible for 24 hours from the time that they are added
598
- * to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>
154
+ * @see {@link PutRecordsCommand}
599
155
  */
600
156
  putRecords(args: PutRecordsCommandInput, options?: __HttpHandlerOptions): Promise<PutRecordsCommandOutput>;
601
157
  putRecords(args: PutRecordsCommandInput, cb: (err: any, data?: PutRecordsCommandOutput) => void): void;
602
158
  putRecords(args: PutRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRecordsCommandOutput) => void): void;
603
159
  /**
604
- * @public
605
- * <p>Registers a consumer with a Kinesis data stream. When you use this operation, the
606
- * consumer you register can then call <a>SubscribeToShard</a> to receive data
607
- * from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every
608
- * shard you subscribe to. This rate is unaffected by the total number of consumers that
609
- * read from the same stream.</p>
610
- * <p>You can register up to 20 consumers per stream. A given consumer can only be
611
- * registered with one stream at a time.</p>
612
- * <p>For an example of how to use this operations, see <a href="/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
613
- * Using the Kinesis Data Streams API</a>.</p>
614
- * <p>The use of this operation has a limit of five transactions per second per account.
615
- * Also, only 5 consumers can be created simultaneously. In other words, you cannot have
616
- * more than 5 consumers in a <code>CREATING</code> status at the same time. Registering a
617
- * 6th consumer while there are 5 in a <code>CREATING</code> status results in a
618
- * <code>LimitExceededException</code>.</p>
160
+ * @see {@link RegisterStreamConsumerCommand}
619
161
  */
620
162
  registerStreamConsumer(args: RegisterStreamConsumerCommandInput, options?: __HttpHandlerOptions): Promise<RegisterStreamConsumerCommandOutput>;
621
163
  registerStreamConsumer(args: RegisterStreamConsumerCommandInput, cb: (err: any, data?: RegisterStreamConsumerCommandOutput) => void): void;
622
164
  registerStreamConsumer(args: RegisterStreamConsumerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterStreamConsumerCommandOutput) => void): void;
623
165
  /**
624
- * @public
625
- * <p>Removes tags from the specified Kinesis data stream. Removed tags are deleted and
626
- * cannot be recovered after this operation successfully completes.</p>
627
- * <note>
628
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
629
- * parameter rather than the <code>StreamName</code> input parameter.</p>
630
- * </note>
631
- * <p>If you specify a tag that does not exist, it is ignored.</p>
632
- * <p>
633
- * <a>RemoveTagsFromStream</a> has a limit of five transactions per second per
634
- * account.</p>
166
+ * @see {@link RemoveTagsFromStreamCommand}
635
167
  */
636
168
  removeTagsFromStream(args: RemoveTagsFromStreamCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsFromStreamCommandOutput>;
637
169
  removeTagsFromStream(args: RemoveTagsFromStreamCommandInput, cb: (err: any, data?: RemoveTagsFromStreamCommandOutput) => void): void;
638
170
  removeTagsFromStream(args: RemoveTagsFromStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromStreamCommandOutput) => void): void;
639
171
  /**
640
- * @public
641
- * <p>Splits a shard into two new shards in the Kinesis data stream, to increase the
642
- * stream's capacity to ingest and transport data. <code>SplitShard</code> is called when
643
- * there is a need to increase the overall capacity of a stream because of an expected
644
- * increase in the volume of data records being ingested. This API is only supported for
645
- * the data streams with the provisioned capacity mode.</p>
646
- * <note>
647
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
648
- * parameter rather than the <code>StreamName</code> input parameter.</p>
649
- * </note>
650
- * <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its
651
- * maximum utilization; for example, the producers sending data into the specific shard are
652
- * suddenly sending more than previously anticipated. You can also call
653
- * <code>SplitShard</code> to increase stream capacity, so that more Kinesis Data
654
- * Streams applications can simultaneously read data from the stream for real-time
655
- * processing. </p>
656
- * <p>You must specify the shard to be split and the new hash key, which is the position in
657
- * the shard where the shard gets split in two. In many cases, the new hash key might be
658
- * the average of the beginning and ending hash key, but it can be any hash key value in
659
- * the range being mapped into the shard. For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html">Split a
660
- * Shard</a> in the <i>Amazon Kinesis Data Streams Developer
661
- * Guide</i>.</p>
662
- * <p>You can use <a>DescribeStreamSummary</a> and the <a>ListShards</a> APIs to determine the shard ID and hash key values for the <code>ShardToSplit</code>
663
- * and <code>NewStartingHashKey</code> parameters that are specified in the
664
- * <code>SplitShard</code> request.</p>
665
- * <p>
666
- * <code>SplitShard</code> is an asynchronous operation. Upon receiving a
667
- * <code>SplitShard</code> request, Kinesis Data Streams immediately returns a response
668
- * and sets the stream status to <code>UPDATING</code>. After the operation is completed,
669
- * Kinesis Data Streams sets the stream status to <code>ACTIVE</code>. Read and write
670
- * operations continue to work while the stream is in the <code>UPDATING</code> state. </p>
671
- * <p>You can use <a>DescribeStreamSummary</a> to check the status of the stream,
672
- * which is returned in <code>StreamStatus</code>. If the stream is in the
673
- * <code>ACTIVE</code> state, you can call <code>SplitShard</code>.
674
- * </p>
675
- * <p>If the specified stream does not exist, <a>DescribeStreamSummary</a>
676
- * returns a <code>ResourceNotFoundException</code>. If you try to create more shards than
677
- * are authorized for your account, you receive a <code>LimitExceededException</code>. </p>
678
- * <p>For the default shard limit for an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Kinesis
679
- * Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer
680
- * Guide</i>. To increase this limit, <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact Amazon Web Services
681
- * Support</a>.</p>
682
- * <p>If you try to operate on too many streams simultaneously using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a>, and/or <a>SplitShard</a>, you receive a
683
- * <code>LimitExceededException</code>. </p>
684
- * <p>
685
- * <code>SplitShard</code> has a limit of five transactions per second per account.</p>
172
+ * @see {@link SplitShardCommand}
686
173
  */
687
174
  splitShard(args: SplitShardCommandInput, options?: __HttpHandlerOptions): Promise<SplitShardCommandOutput>;
688
175
  splitShard(args: SplitShardCommandInput, cb: (err: any, data?: SplitShardCommandOutput) => void): void;
689
176
  splitShard(args: SplitShardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SplitShardCommandOutput) => void): void;
690
177
  /**
691
- * @public
692
- * <p>Enables or updates server-side encryption using an Amazon Web Services KMS key for a
693
- * specified stream. </p>
694
- * <p>Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis
695
- * Data Streams returns immediately and sets the status of the stream to
696
- * <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the
697
- * status of the stream back to <code>ACTIVE</code>. Updating or applying encryption
698
- * normally takes a few seconds to complete, but it can take minutes. You can continue to
699
- * read and write data to your stream while its status is <code>UPDATING</code>. Once the
700
- * status of the stream is <code>ACTIVE</code>, encryption begins for records written to
701
- * the stream. </p>
702
- * <p>API Limits: You can successfully apply a new Amazon Web Services KMS key for
703
- * server-side encryption 25 times in a rolling 24-hour period.</p>
704
- * <p>Note: It can take up to 5 seconds after the stream is in an <code>ACTIVE</code> status
705
- * before all records written to the stream are encrypted. After you enable encryption, you
706
- * can verify that encryption is applied by inspecting the API response from
707
- * <code>PutRecord</code> or <code>PutRecords</code>.</p>
708
- * <note>
709
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
710
- * parameter rather than the <code>StreamName</code> input parameter.</p>
711
- * </note>
178
+ * @see {@link StartStreamEncryptionCommand}
712
179
  */
713
180
  startStreamEncryption(args: StartStreamEncryptionCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamEncryptionCommandOutput>;
714
181
  startStreamEncryption(args: StartStreamEncryptionCommandInput, cb: (err: any, data?: StartStreamEncryptionCommandOutput) => void): void;
715
182
  startStreamEncryption(args: StartStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamEncryptionCommandOutput) => void): void;
716
183
  /**
717
- * @public
718
- * <p>Disables server-side encryption for a specified stream. </p>
719
- * <note>
720
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
721
- * parameter rather than the <code>StreamName</code> input parameter.</p>
722
- * </note>
723
- * <p>Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis
724
- * Data Streams returns immediately and sets the status of the stream to
725
- * <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the
726
- * status of the stream back to <code>ACTIVE</code>. Stopping encryption normally takes a
727
- * few seconds to complete, but it can take minutes. You can continue to read and write
728
- * data to your stream while its status is <code>UPDATING</code>. Once the status of the
729
- * stream is <code>ACTIVE</code>, records written to the stream are no longer encrypted by
730
- * Kinesis Data Streams. </p>
731
- * <p>API Limits: You can successfully disable server-side encryption 25 times in a rolling
732
- * 24-hour period. </p>
733
- * <p>Note: It can take up to 5 seconds after the stream is in an <code>ACTIVE</code> status
734
- * before all records written to the stream are no longer subject to encryption. After you
735
- * disabled encryption, you can verify that encryption is not applied by inspecting the API
736
- * response from <code>PutRecord</code> or <code>PutRecords</code>.</p>
184
+ * @see {@link StopStreamEncryptionCommand}
737
185
  */
738
186
  stopStreamEncryption(args: StopStreamEncryptionCommandInput, options?: __HttpHandlerOptions): Promise<StopStreamEncryptionCommandOutput>;
739
187
  stopStreamEncryption(args: StopStreamEncryptionCommandInput, cb: (err: any, data?: StopStreamEncryptionCommandOutput) => void): void;
740
188
  stopStreamEncryption(args: StopStreamEncryptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamEncryptionCommandOutput) => void): void;
741
189
  /**
742
- * @public
743
- * <p>This operation establishes an HTTP/2 connection between the consumer you specify in
744
- * the <code>ConsumerARN</code> parameter and the shard you specify in the
745
- * <code>ShardId</code> parameter. After the connection is successfully established,
746
- * Kinesis Data Streams pushes records from the shard to the consumer over this connection.
747
- * Before you call this operation, call <a>RegisterStreamConsumer</a> to
748
- * register the consumer with Kinesis Data Streams.</p>
749
- * <p>When the <code>SubscribeToShard</code> call succeeds, your consumer starts receiving
750
- * events of type <a>SubscribeToShardEvent</a> over the HTTP/2 connection for up
751
- * to 5 minutes, after which time you need to call <code>SubscribeToShard</code> again to
752
- * renew the subscription if you want to continue to receive records.</p>
753
- * <p>You can make one call to <code>SubscribeToShard</code> per second per registered
754
- * consumer per shard. For example, if you have a 4000 shard stream and two registered
755
- * stream consumers, you can make one <code>SubscribeToShard</code> request per second for
756
- * each combination of shard and registered consumer, allowing you to subscribe both
757
- * consumers to all 4000 shards in one second. </p>
758
- * <p>If you call <code>SubscribeToShard</code> again with the same <code>ConsumerARN</code>
759
- * and <code>ShardId</code> within 5 seconds of a successful call, you'll get a
760
- * <code>ResourceInUseException</code>. If you call <code>SubscribeToShard</code> 5
761
- * seconds or more after a successful call, the second call takes over the subscription and
762
- * the previous connection expires or fails with a
763
- * <code>ResourceInUseException</code>.</p>
764
- * <p>For an example of how to use this operations, see <a href="/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
765
- * Using the Kinesis Data Streams API</a>.</p>
190
+ * @see {@link SubscribeToShardCommand}
766
191
  */
767
192
  subscribeToShard(args: SubscribeToShardCommandInput, options?: __HttpHandlerOptions): Promise<SubscribeToShardCommandOutput>;
768
193
  subscribeToShard(args: SubscribeToShardCommandInput, cb: (err: any, data?: SubscribeToShardCommandOutput) => void): void;
769
194
  subscribeToShard(args: SubscribeToShardCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubscribeToShardCommandOutput) => void): void;
770
195
  /**
771
- * @public
772
- * <p>Updates the shard count of the specified stream to the specified number of shards.
773
- * This API is only supported for the data streams with the provisioned capacity
774
- * mode.</p>
775
- * <note>
776
- * <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input
777
- * parameter rather than the <code>StreamName</code> input parameter.</p>
778
- * </note>
779
- * <p>Updating the shard count is an asynchronous operation. Upon receiving the request,
780
- * Kinesis Data Streams returns immediately and sets the status of the stream to
781
- * <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the
782
- * status of the stream back to <code>ACTIVE</code>. Depending on the size of the stream,
783
- * the scaling action could take a few minutes to complete. You can continue to read and
784
- * write data to your stream while its status is <code>UPDATING</code>.</p>
785
- * <p>To update the shard count, Kinesis Data Streams performs splits or merges on
786
- * individual shards. This can cause short-lived shards to be created, in addition to the
787
- * final shards. These short-lived shards count towards your total shard limit for your
788
- * account in the Region.</p>
789
- * <p>When using this operation, we recommend that you specify a target shard count that is
790
- * a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your
791
- * shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling
792
- * action might take longer to complete. </p>
793
- * <p>This operation has the following default limits. By default, you cannot do the
794
- * following:</p>
795
- * <ul>
796
- * <li>
797
- * <p>Scale more than ten times per rolling 24-hour period per stream</p>
798
- * </li>
799
- * <li>
800
- * <p>Scale up to more than double your current shard count for a stream</p>
801
- * </li>
802
- * <li>
803
- * <p>Scale down below half your current shard count for a stream</p>
804
- * </li>
805
- * <li>
806
- * <p>Scale up to more than 10000 shards in a stream</p>
807
- * </li>
808
- * <li>
809
- * <p>Scale a stream with more than 10000 shards down unless the result is less than
810
- * 10000 shards</p>
811
- * </li>
812
- * <li>
813
- * <p>Scale up to more than the shard limit for your account</p>
814
- * </li>
815
- * </ul>
816
- * <p>For the default limits for an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Streams
817
- * Limits</a> in the <i>Amazon Kinesis Data Streams Developer
818
- * Guide</i>. To request an increase in the call rate limit, the shard limit for
819
- * this API, or your overall shard limit, use the <a href="https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis">limits form</a>.</p>
196
+ * @see {@link UpdateShardCountCommand}
820
197
  */
821
198
  updateShardCount(args: UpdateShardCountCommandInput, options?: __HttpHandlerOptions): Promise<UpdateShardCountCommandOutput>;
822
199
  updateShardCount(args: UpdateShardCountCommandInput, cb: (err: any, data?: UpdateShardCountCommandOutput) => void): void;
823
200
  updateShardCount(args: UpdateShardCountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateShardCountCommandOutput) => void): void;
824
201
  /**
825
- * @public
826
- * <p> Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you
827
- * can choose between an <b>on-demand</b> capacity mode and a
828
- * <b>provisioned</b> capacity mode for your data stream.
829
- * </p>
202
+ * @see {@link UpdateStreamModeCommand}
830
203
  */
831
204
  updateStreamMode(args: UpdateStreamModeCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStreamModeCommandOutput>;
832
205
  updateStreamMode(args: UpdateStreamModeCommandInput, cb: (err: any, data?: UpdateStreamModeCommandOutput) => void): void;
833
206
  updateStreamMode(args: UpdateStreamModeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamModeCommandOutput) => void): void;
834
207
  }
208
+ /**
209
+ * @public
210
+ * <fullname>Amazon Kinesis Data Streams Service API Reference</fullname>
211
+ * <p>Amazon Kinesis Data Streams is a managed service that scales elastically for real-time
212
+ * processing of streaming big data.</p>
213
+ */
214
+ export declare class Kinesis extends KinesisClient implements Kinesis {
215
+ }