@aws-sdk/client-kinesis 3.40.0 → 3.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/README.md +2 -2
  3. package/dist-cjs/Kinesis.js +15 -0
  4. package/dist-cjs/commands/UpdateStreamModeCommand.js +36 -0
  5. package/dist-cjs/commands/index.js +1 -0
  6. package/dist-cjs/endpoints.js +8 -0
  7. package/dist-cjs/models/models_0.js +25 -2
  8. package/dist-cjs/protocols/Aws_json1_1.js +151 -2
  9. package/dist-es/Kinesis.js +15 -0
  10. package/dist-es/commands/UpdateStreamModeCommand.js +39 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/endpoints.js +8 -0
  13. package/dist-es/models/models_0.js +17 -0
  14. package/dist-es/protocols/Aws_json1_1.js +189 -35
  15. package/dist-types/Kinesis.d.ts +165 -143
  16. package/dist-types/KinesisClient.d.ts +5 -4
  17. package/dist-types/commands/AddTagsToStreamCommand.d.ts +3 -5
  18. package/dist-types/commands/CreateStreamCommand.d.ts +20 -20
  19. package/dist-types/commands/DecreaseStreamRetentionPeriodCommand.d.ts +6 -6
  20. package/dist-types/commands/DeleteStreamCommand.d.ts +6 -5
  21. package/dist-types/commands/DeregisterStreamConsumerCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeLimitsCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeStreamCommand.d.ts +6 -2
  24. package/dist-types/commands/DescribeStreamConsumerCommand.d.ts +1 -1
  25. package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +6 -6
  26. package/dist-types/commands/DisableEnhancedMonitoringCommand.d.ts +1 -1
  27. package/dist-types/commands/EnableEnhancedMonitoringCommand.d.ts +1 -1
  28. package/dist-types/commands/GetRecordsCommand.d.ts +30 -20
  29. package/dist-types/commands/GetShardIteratorCommand.d.ts +8 -8
  30. package/dist-types/commands/IncreaseStreamRetentionPeriodCommand.d.ts +4 -4
  31. package/dist-types/commands/ListShardsCommand.d.ts +5 -3
  32. package/dist-types/commands/ListStreamConsumersCommand.d.ts +1 -1
  33. package/dist-types/commands/ListStreamsCommand.d.ts +2 -2
  34. package/dist-types/commands/ListTagsForStreamCommand.d.ts +1 -1
  35. package/dist-types/commands/MergeShardsCommand.d.ts +6 -6
  36. package/dist-types/commands/PutRecordCommand.d.ts +9 -9
  37. package/dist-types/commands/PutRecordsCommand.d.ts +8 -8
  38. package/dist-types/commands/RegisterStreamConsumerCommand.d.ts +1 -1
  39. package/dist-types/commands/RemoveTagsFromStreamCommand.d.ts +1 -1
  40. package/dist-types/commands/SplitShardCommand.d.ts +18 -20
  41. package/dist-types/commands/StartStreamEncryptionCommand.d.ts +11 -11
  42. package/dist-types/commands/StopStreamEncryptionCommand.d.ts +9 -10
  43. package/dist-types/commands/SubscribeToShardCommand.d.ts +4 -3
  44. package/dist-types/commands/UpdateShardCountCommand.d.ts +11 -12
  45. package/dist-types/commands/UpdateStreamModeCommand.d.ts +38 -0
  46. package/dist-types/commands/index.d.ts +1 -0
  47. package/dist-types/models/models_0.d.ts +333 -152
  48. package/dist-types/protocols/Aws_json1_1.d.ts +3 -0
  49. package/dist-types/ts3.4/Kinesis.d.ts +5 -0
  50. package/dist-types/ts3.4/KinesisClient.d.ts +3 -2
  51. package/dist-types/ts3.4/commands/UpdateStreamModeCommand.d.ts +17 -0
  52. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  53. package/dist-types/ts3.4/models/models_0.d.ts +54 -1
  54. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +3 -0
  55. package/package.json +4 -4
@@ -7,10 +7,8 @@ export interface AddTagsToStreamCommandInput extends AddTagsToStreamInput {
7
7
  export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Adds or updates tags for the specified Kinesis data stream. Each time you invoke
11
- * this operation, you can specify up to 10 tags. If you want to add more than 10 tags to
12
- * your stream, you can invoke this operation multiple times. In total, each stream can
13
- * have up to 50 tags.</p>
10
+ * <p>Adds or updates tags for the specified Kinesis data stream. You can assign up to 50
11
+ * tags to a data stream.</p>
14
12
  * <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code>
15
13
  * overwrites any existing tags that correspond to the specified tag keys.</p>
16
14
  * <p>
@@ -28,7 +26,7 @@ export interface AddTagsToStreamCommandOutput extends __MetadataBearer {
28
26
  *
29
27
  * @see {@link AddTagsToStreamCommandInput} for command's `input` shape.
30
28
  * @see {@link AddTagsToStreamCommandOutput} for command's `response` shape.
31
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
29
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
32
30
  *
33
31
  */
34
32
  export declare class AddTagsToStreamCommand extends $Command<AddTagsToStreamCommandInput, AddTagsToStreamCommandOutput, KinesisClientResolvedConfig> {
@@ -7,19 +7,19 @@ export interface CreateStreamCommandInput extends CreateStreamInput {
7
7
  export interface CreateStreamCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a Kinesis data stream. A stream captures and transports data records that
11
- * are continuously emitted from different data sources or <i>producers</i>.
10
+ * <p>Creates a Kinesis data stream. A stream captures and transports data records that are
11
+ * continuously emitted from different data sources or <i>producers</i>.
12
12
  * Scale-out within a stream is explicitly supported by means of shards, which are uniquely
13
13
  * identified groups of data records in a stream.</p>
14
- * <p>You specify and control the number of shards that a stream is composed of. Each
15
- * shard can support reads up to five transactions per second, up to a maximum data read
16
- * total of 2 MiB per second. Each shard can support writes up to 1,000 records per second,
17
- * up to a maximum data write total of 1 MiB per second. If the amount of data input
18
- * increases or decreases, you can add or remove shards.</p>
19
- * <p>The stream name identifies the stream. The name is scoped to the AWS account used
20
- * by the application. It is also scoped by AWS Region. That is, two streams in two
21
- * different accounts can have the same name, and two streams in the same account, but in
22
- * two different Regions, can have the same name.</p>
14
+ * <p>You specify and control the number of shards that a stream is composed of. Each shard
15
+ * can support reads up to five transactions per second, up to a maximum data read total of
16
+ * 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a
17
+ * maximum data write total of 1 MiB per second. If the amount of data input increases or
18
+ * decreases, you can add or remove shards.</p>
19
+ * <p>The stream name identifies the stream. The name is scoped to the Amazon Web Services
20
+ * account used by the application. It is also scoped by Amazon Web Services Region. That
21
+ * is, two streams in two different accounts can have the same name, and two streams in the
22
+ * same account, but in two different Regions, can have the same name.</p>
23
23
  * <p>
24
24
  * <code>CreateStream</code> is an asynchronous operation. Upon receiving a
25
25
  * <code>CreateStream</code> request, Kinesis Data Streams immediately returns and sets
@@ -31,20 +31,20 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {
31
31
  * <ul>
32
32
  * <li>
33
33
  *
34
- * <p>Have more than five streams in the <code>CREATING</code> state at any point
35
- * in time.</p>
34
+ * <p>Have more than five streams in the <code>CREATING</code> state at any point in
35
+ * time.</p>
36
36
  * </li>
37
37
  * <li>
38
38
  *
39
39
  * <p>Create more shards than are authorized for your account.</p>
40
40
  * </li>
41
41
  * </ul>
42
- * <p>For the default shard limit for an AWS account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Data Streams
43
- * Limits</a> in the <i>Amazon Kinesis Data Streams Developer
44
- * Guide</i>. To increase this limit, <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact AWS
45
- * Support</a>.</p>
46
- * <p>You can use <code>DescribeStream</code> to check the stream status, which is
47
- * returned in <code>StreamStatus</code>.</p>
42
+ * <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
43
+ * Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams
44
+ * 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
45
+ * Support</a>.</p>
46
+ * <p>You can use <a>DescribeStreamSummary</a> to check the stream status, which
47
+ * is returned in <code>StreamStatus</code>.</p>
48
48
  * <p>
49
49
  * <a>CreateStream</a> has a limit of five transactions per second per
50
50
  * account.</p>
@@ -60,7 +60,7 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {
60
60
  *
61
61
  * @see {@link CreateStreamCommandInput} for command's `input` shape.
62
62
  * @see {@link CreateStreamCommandOutput} for command's `response` shape.
63
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
63
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
64
64
  *
65
65
  */
66
66
  export declare class CreateStreamCommand extends $Command<CreateStreamCommandInput, CreateStreamCommandOutput, KinesisClientResolvedConfig> {
@@ -7,12 +7,12 @@ export interface DecreaseStreamRetentionPeriodCommandInput extends DecreaseStrea
7
7
  export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Decreases the Kinesis data stream's retention period, which is the length of time
11
- * data records are accessible after they are added to the stream. The minimum value of a
10
+ * <p>Decreases the Kinesis data stream's retention period, which is the length of time data
11
+ * records are accessible after they are added to the stream. The minimum value of a
12
12
  * stream's retention period is 24 hours.</p>
13
- * <p>This operation may result in lost data. For example, if the stream's retention
14
- * period is 48 hours and is decreased to 24 hours, any data already in the stream that is
15
- * older than 24 hours is inaccessible.</p>
13
+ * <p>This operation may result in lost data. For example, if the stream's retention period
14
+ * is 48 hours and is decreased to 24 hours, any data already in the stream that is older
15
+ * than 24 hours is inaccessible.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -25,7 +25,7 @@ export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
25
25
  *
26
26
  * @see {@link DecreaseStreamRetentionPeriodCommandInput} for command's `input` shape.
27
27
  * @see {@link DecreaseStreamRetentionPeriodCommandOutput} for command's `response` shape.
28
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
28
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
29
29
  *
30
30
  */
31
31
  export declare class DecreaseStreamRetentionPeriodCommand extends $Command<DecreaseStreamRetentionPeriodCommandInput, DecreaseStreamRetentionPeriodCommandOutput, KinesisClientResolvedConfig> {
@@ -19,10 +19,11 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {
19
19
  * <b>Note:</b> Kinesis Data Streams might continue to accept
20
20
  * data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the
21
21
  * <code>DELETING</code> state until the stream deletion is complete.</p>
22
- * <p>When you delete a stream, any shards in that stream are also deleted, and any tags
23
- * are dissociated from the stream.</p>
24
- * <p>You can use the <a>DescribeStream</a> operation to check the state of
25
- * the stream, which is returned in <code>StreamStatus</code>.</p>
22
+ * <p>When you delete a stream, any shards in that stream are also deleted, and any tags are
23
+ * dissociated from the stream.</p>
24
+ * <p>You can use the <a>DescribeStreamSummary</a> operation to check the state
25
+ * of the stream, which is returned in <code>StreamStatus</code>.</p>
26
+ *
26
27
  * <p>
27
28
  * <a>DeleteStream</a> has a limit of five transactions per second per
28
29
  * account.</p>
@@ -38,7 +39,7 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {
38
39
  *
39
40
  * @see {@link DeleteStreamCommandInput} for command's `input` shape.
40
41
  * @see {@link DeleteStreamCommandOutput} for command's `response` shape.
41
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
42
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
42
43
  *
43
44
  */
44
45
  export declare class DeleteStreamCommand extends $Command<DeleteStreamCommandInput, DeleteStreamCommandOutput, KinesisClientResolvedConfig> {
@@ -27,7 +27,7 @@ export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer
27
27
  *
28
28
  * @see {@link DeregisterStreamConsumerCommandInput} for command's `input` shape.
29
29
  * @see {@link DeregisterStreamConsumerCommandOutput} for command's `response` shape.
30
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
30
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
31
31
  *
32
32
  */
33
33
  export declare class DeregisterStreamConsumerCommand extends $Command<DeregisterStreamConsumerCommandInput, DeregisterStreamConsumerCommandOutput, KinesisClientResolvedConfig> {
@@ -23,7 +23,7 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met
23
23
  *
24
24
  * @see {@link DescribeLimitsCommandInput} for command's `input` shape.
25
25
  * @see {@link DescribeLimitsCommandOutput} for command's `response` shape.
26
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
27
27
  *
28
28
  */
29
29
  export declare class DescribeLimitsCommand extends $Command<DescribeLimitsCommandInput, DescribeLimitsCommandOutput, KinesisClientResolvedConfig> {
@@ -8,7 +8,11 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
8
8
  }
9
9
  /**
10
10
  * <p>Describes the specified Kinesis data stream.</p>
11
- *
11
+ * <note>
12
+ * <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
13
+ * specified Kinesis data stream and the <a>ListShards</a> API to list the
14
+ * shards in a specified data stream and obtain information about each shard. </p>
15
+ * </note>
12
16
  * <p>The information returned includes the stream name, Amazon Resource Name (ARN),
13
17
  * creation time, enhanced metric configuration, and shard map. The shard map is an array
14
18
  * of shard objects. For each shard object, there is the hash key and sequence number
@@ -36,7 +40,7 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met
36
40
  *
37
41
  * @see {@link DescribeStreamCommandInput} for command's `input` shape.
38
42
  * @see {@link DescribeStreamCommandOutput} for command's `response` shape.
39
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
43
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
40
44
  *
41
45
  */
42
46
  export declare class DescribeStreamCommand extends $Command<DescribeStreamCommandInput, DescribeStreamCommandOutput, KinesisClientResolvedConfig> {
@@ -27,7 +27,7 @@ export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsu
27
27
  *
28
28
  * @see {@link DescribeStreamConsumerCommandInput} for command's `input` shape.
29
29
  * @see {@link DescribeStreamConsumerCommandOutput} for command's `response` shape.
30
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
30
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
31
31
  *
32
32
  */
33
33
  export declare class DescribeStreamConsumerCommand extends $Command<DescribeStreamConsumerCommandInput, DescribeStreamConsumerCommandOutput, KinesisClientResolvedConfig> {
@@ -9,12 +9,12 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar
9
9
  /**
10
10
  * <p>Provides a summarized description of the specified Kinesis data stream without the
11
11
  * shard list.</p>
12
- * <p>The information returned includes the stream name, Amazon Resource Name (ARN),
13
- * status, record retention period, approximate creation time, monitoring, encryption
14
- * details, and open shard count. </p>
12
+ * <p>The information returned includes the stream name, Amazon Resource Name (ARN), status,
13
+ * record retention period, approximate creation time, monitoring, encryption details, and
14
+ * open shard count. </p>
15
15
  * <p>
16
- * <a>DescribeStreamSummary</a> has a limit of 20 transactions per second
17
- * per account.</p>
16
+ * <a>DescribeStreamSummary</a> has a limit of 20 transactions per second per
17
+ * account.</p>
18
18
  * @example
19
19
  * Use a bare-bones client and the command you need to make an API call.
20
20
  * ```javascript
@@ -27,7 +27,7 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar
27
27
  *
28
28
  * @see {@link DescribeStreamSummaryCommandInput} for command's `input` shape.
29
29
  * @see {@link DescribeStreamSummaryCommandOutput} for command's `response` shape.
30
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
30
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
31
31
  *
32
32
  */
33
33
  export declare class DescribeStreamSummaryCommand extends $Command<DescribeStreamSummaryCommandInput, DescribeStreamSummaryCommandOutput, KinesisClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitori
20
20
  *
21
21
  * @see {@link DisableEnhancedMonitoringCommandInput} for command's `input` shape.
22
22
  * @see {@link DisableEnhancedMonitoringCommandOutput} for command's `response` shape.
23
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class DisableEnhancedMonitoringCommand extends $Command<DisableEnhancedMonitoringCommandInput, DisableEnhancedMonitoringCommandOutput, KinesisClientResolvedConfig> {
@@ -20,7 +20,7 @@ export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitorin
20
20
  *
21
21
  * @see {@link EnableEnhancedMonitoringCommandInput} for command's `input` shape.
22
22
  * @see {@link EnableEnhancedMonitoringCommandOutput} for command's `response` shape.
23
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
23
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
24
24
  *
25
25
  */
26
26
  export declare class EnableEnhancedMonitoringCommand extends $Command<EnableEnhancedMonitoringCommandInput, EnableEnhancedMonitoringCommandOutput, KinesisClientResolvedConfig> {
@@ -25,34 +25,44 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
25
25
  * You can terminate the loop when the shard is closed, or when the shard iterator reaches
26
26
  * the record with the sequence number or other attribute that marks it as the last record
27
27
  * to process.</p>
28
- * <p>Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB
29
- * per second. You can ensure that your calls don't exceed the maximum supported size or
28
+ * <p>Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per
29
+ * second. You can ensure that your calls don't exceed the maximum supported size or
30
30
  * throughput by using the <code>Limit</code> parameter to specify the maximum number of
31
31
  * records that <a>GetRecords</a> can return. Consider your average record size
32
32
  * when determining this limit. The maximum number of records that can be returned per call
33
33
  * is 10,000.</p>
34
34
  *
35
- * <p>The size of the data returned by <a>GetRecords</a> varies depending on
36
- * the utilization of the shard. The maximum size of data that <a>GetRecords</a>
37
- * can return is 10 MiB. If a call returns this amount of data, subsequent calls made
38
- * within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If
39
- * there is insufficient provisioned throughput on the stream, subsequent calls made within
40
- * the next 1 second throw <code>ProvisionedThroughputExceededException</code>. <a>GetRecords</a> doesn't return any data when it throws an exception. For this
41
- * reason, we recommend that you wait 1 second between calls to <a>GetRecords</a>. However, it's possible that the application will get exceptions for longer than 1
42
- * second.</p>
35
+ * <p>The size of the data returned by <a>GetRecords</a> varies depending on the
36
+ * utilization of the shard. It is recommended that consumer applications retrieve records
37
+ * via the <code>GetRecords</code> command using the 5 TPS limit to remain caught up.
38
+ * Retrieving records less frequently can lead to consumer applications falling behind. The
39
+ * maximum size of data that <a>GetRecords</a> can return is 10 MiB. If a call
40
+ * returns this amount of data, subsequent calls made within the next 5 seconds throw
41
+ * <code>ProvisionedThroughputExceededException</code>. If there is insufficient
42
+ * provisioned throughput on the stream, subsequent calls made within the next 1 second
43
+ * throw <code>ProvisionedThroughputExceededException</code>. <a>GetRecords</a>
44
+ * doesn't return any data when it throws an exception. For this reason, we recommend that
45
+ * you wait 1 second between calls to <a>GetRecords</a>. However, it's possible
46
+ * that the application will get exceptions for longer than 1 second.</p>
47
+ *
48
+ *
49
+ *
50
+ *
51
+ *
52
+ *
53
+ *
54
+ *
43
55
  * <p>To detect whether the application is falling behind in processing, you can use the
44
56
  * <code>MillisBehindLatest</code> response attribute. You can also monitor the stream
45
57
  * 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
46
58
  * Kinesis Data Streams Developer Guide</i>).</p>
47
- * <p>Each Amazon Kinesis record includes a value,
48
- * <code>ApproximateArrivalTimestamp</code>, that is set when a stream successfully
49
- * receives and stores a record. This is commonly referred to as a server-side time stamp,
50
- * whereas a client-side time stamp is set when a data producer creates or sends the record
51
- * to a stream (a data producer is any data source putting data records into a stream, for
52
- * example with <a>PutRecords</a>). The time stamp has millisecond precision.
53
- * There are no guarantees about the time stamp accuracy, or that the time stamp is always
54
- * increasing. For example, records in a shard or across a stream might have time stamps
55
- * that are out of order.</p>
59
+ * <p>Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>,
60
+ * that is set when a stream successfully receives and stores a record. This is commonly
61
+ * referred to as a server-side time stamp, whereas a client-side time stamp is set when a
62
+ * data producer creates or sends the record to a stream (a data producer is any data
63
+ * 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
64
+ * stamp accuracy, or that the time stamp is always increasing. For example, records in a
65
+ * shard or across a stream might have time stamps that are out of order.</p>
56
66
  * <p>This operation has a limit of five transactions per second per shard.</p>
57
67
  * @example
58
68
  * Use a bare-bones client and the command you need to make an API call.
@@ -66,7 +76,7 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea
66
76
  *
67
77
  * @see {@link GetRecordsCommandInput} for command's `input` shape.
68
78
  * @see {@link GetRecordsCommandOutput} for command's `response` shape.
69
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
79
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
70
80
  *
71
81
  */
72
82
  export declare class GetRecordsCommand extends $Command<GetRecordsCommandInput, GetRecordsCommandOutput, KinesisClientResolvedConfig> {
@@ -7,13 +7,13 @@ export interface GetShardIteratorCommandInput extends GetShardIteratorInput {
7
7
  export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it
11
- * is returned to the requester.</p>
12
- * <p>A shard iterator specifies the shard position from which to start reading data
13
- * records sequentially. The position is specified using the sequence number of a data
14
- * record in a shard. A sequence number is the identifier associated with every record
15
- * ingested in the stream, and is assigned when a record is put into the stream. Each
16
- * stream has one or more shards.</p>
10
+ * <p>Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is
11
+ * returned to the requester.</p>
12
+ * <p>A shard iterator specifies the shard position from which to start reading data records
13
+ * sequentially. The position is specified using the sequence number of a data record in a
14
+ * shard. A sequence number is the identifier associated with every record ingested in the
15
+ * stream, and is assigned when a record is put into the stream. Each stream has one or
16
+ * more shards.</p>
17
17
  * <p>You must specify the shard iterator type. For example, you can set the
18
18
  * <code>ShardIteratorType</code> parameter to read exactly from the position denoted
19
19
  * by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard
@@ -53,7 +53,7 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _
53
53
  *
54
54
  * @see {@link GetShardIteratorCommandInput} for command's `input` shape.
55
55
  * @see {@link GetShardIteratorCommandOutput} for command's `response` shape.
56
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
56
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
57
57
  *
58
58
  */
59
59
  export declare class GetShardIteratorCommand extends $Command<GetShardIteratorCommandInput, GetShardIteratorCommandOutput, KinesisClientResolvedConfig> {
@@ -7,9 +7,9 @@ export interface IncreaseStreamRetentionPeriodCommandInput extends IncreaseStrea
7
7
  export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Increases the Kinesis data stream's retention period, which is the length of time
11
- * data records are accessible after they are added to the stream. The maximum value of a
12
- * stream's retention period is 168 hours (7 days).</p>
10
+ * <p>Increases the Kinesis data stream's retention period, which is the length of time data
11
+ * records are accessible after they are added to the stream. The maximum value of a
12
+ * stream's retention period is 8760 hours (365 days).</p>
13
13
  * <p>If you choose a longer stream retention period, this operation increases the time
14
14
  * period during which records that have not yet expired are accessible. However, it does
15
15
  * not make previous, expired data (older than the stream's previous retention period)
@@ -28,7 +28,7 @@ export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBe
28
28
  *
29
29
  * @see {@link IncreaseStreamRetentionPeriodCommandInput} for command's `input` shape.
30
30
  * @see {@link IncreaseStreamRetentionPeriodCommandOutput} for command's `response` shape.
31
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
31
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
32
32
  *
33
33
  */
34
34
  export declare class IncreaseStreamRetentionPeriodCommand extends $Command<IncreaseStreamRetentionPeriodCommandInput, IncreaseStreamRetentionPeriodCommandOutput, KinesisClientResolvedConfig> {
@@ -7,8 +7,10 @@ export interface ListShardsCommandInput extends ListShardsInput {
7
7
  export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the shards in a stream and provides information about each shard. This
11
- * operation has a limit of 100 transactions per second per data stream.</p>
10
+ * <p>Lists the shards in a stream and provides information about each shard. This operation
11
+ * has a limit of 1000 transactions per second per data stream.</p>
12
+ * <p>This action does not list expired shards. For information about expired shards, see
13
+ * <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>
12
14
  * <important>
13
15
  * <p>This API is a new operation that is used by the Amazon Kinesis Client Library
14
16
  * (KCL). If you have a fine-grained IAM policy that only allows specific operations,
@@ -28,7 +30,7 @@ export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBea
28
30
  *
29
31
  * @see {@link ListShardsCommandInput} for command's `input` shape.
30
32
  * @see {@link ListShardsCommandOutput} for command's `response` shape.
31
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
33
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
32
34
  *
33
35
  */
34
36
  export declare class ListShardsCommand extends $Command<ListShardsCommandInput, ListShardsCommandOutput, KinesisClientResolvedConfig> {
@@ -22,7 +22,7 @@ export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOut
22
22
  *
23
23
  * @see {@link ListStreamConsumersCommandInput} for command's `input` shape.
24
24
  * @see {@link ListStreamConsumersCommandOutput} for command's `response` shape.
25
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
25
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
26
26
  *
27
27
  */
28
28
  export declare class ListStreamConsumersCommand extends $Command<ListStreamConsumersCommandInput, ListStreamConsumersCommandOutput, KinesisClientResolvedConfig> {
@@ -12,7 +12,7 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
12
12
  * <code>ListStreams</code>. You can limit the number of returned streams using the
13
13
  * <code>Limit</code> parameter. If you do not specify a value for the
14
14
  * <code>Limit</code> parameter, Kinesis Data Streams uses the default limit, which is
15
- * currently 10.</p>
15
+ * currently 100.</p>
16
16
  * <p>You can detect if there are more streams available to list by using the
17
17
  * <code>HasMoreStreams</code> flag from the returned output. If there are more streams
18
18
  * available, you can request more streams by using the name of the last stream returned by
@@ -35,7 +35,7 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB
35
35
  *
36
36
  * @see {@link ListStreamsCommandInput} for command's `input` shape.
37
37
  * @see {@link ListStreamsCommandOutput} for command's `response` shape.
38
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
38
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
39
39
  *
40
40
  */
41
41
  export declare class ListStreamsCommand extends $Command<ListStreamsCommandInput, ListStreamsCommandOutput, KinesisClientResolvedConfig> {
@@ -21,7 +21,7 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput,
21
21
  *
22
22
  * @see {@link ListTagsForStreamCommandInput} for command's `input` shape.
23
23
  * @see {@link ListTagsForStreamCommandOutput} for command's `response` shape.
24
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
24
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
25
25
  *
26
26
  */
27
27
  export declare class ListTagsForStreamCommand extends $Command<ListTagsForStreamCommandInput, ListTagsForStreamCommandOutput, KinesisClientResolvedConfig> {
@@ -27,7 +27,7 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
27
27
  * <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code>
28
28
  * returns a <code>ResourceInUseException</code>. If the specified stream does not exist,
29
29
  * <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </p>
30
- * <p>You can use <a>DescribeStream</a> to check the state of the stream,
30
+ * <p>You can use <a>DescribeStreamSummary</a> to check the state of the stream,
31
31
  * which is returned in <code>StreamStatus</code>.</p>
32
32
  * <p>
33
33
  * <code>MergeShards</code> is an asynchronous operation. Upon receiving a
@@ -36,13 +36,13 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
36
36
  * operation is completed, Kinesis Data Streams sets the <code>StreamStatus</code> to
37
37
  * <code>ACTIVE</code>. Read and write operations continue to work while the stream is
38
38
  * in the <code>UPDATING</code> state. </p>
39
- * <p>You use <a>DescribeStream</a> to determine the shard IDs that are
40
- * specified in the <code>MergeShards</code> request. </p>
39
+ * <p>You use <a>DescribeStreamSummary</a> and the <a>ListShards</a>
40
+ * APIs to determine the shard IDs that are specified in the <code>MergeShards</code>
41
+ * request. </p>
41
42
  * <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code>,
42
43
  * or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p>
43
44
  * <p>
44
- * <code>MergeShards</code> has a limit of five transactions per second per
45
- * account.</p>
45
+ * <code>MergeShards</code> has a limit of five transactions per second per account.</p>
46
46
  * @example
47
47
  * Use a bare-bones client and the command you need to make an API call.
48
48
  * ```javascript
@@ -55,7 +55,7 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {
55
55
  *
56
56
  * @see {@link MergeShardsCommandInput} for command's `input` shape.
57
57
  * @see {@link MergeShardsCommandOutput} for command's `response` shape.
58
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
58
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
59
59
  *
60
60
  */
61
61
  export declare class MergeShardsCommand extends $Command<MergeShardsCommandInput, MergeShardsCommandOutput, KinesisClientResolvedConfig> {
@@ -19,18 +19,18 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
19
19
  * Kinesis Data Streams segregates the data records that belong to a stream into multiple
20
20
  * shards, using the partition key associated with each data record to determine the shard
21
21
  * to which a given data record belongs.</p>
22
- * <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters
23
- * for each key. An MD5 hash function is used to map partition keys to 128-bit integer
24
- * values and to map associated data records to shards using the hash key ranges of the
25
- * shards. You can override hashing the partition key to determine the shard by explicitly
22
+ * <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters for
23
+ * each key. An MD5 hash function is used to map partition keys to 128-bit integer values
24
+ * and to map associated data records to shards using the hash key ranges of the shards.
25
+ * You can override hashing the partition key to determine the shard by explicitly
26
26
  * specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more
27
27
  * 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
28
28
  * Developer Guide</i>.</p>
29
29
  * <p>
30
30
  * <code>PutRecord</code> returns the shard ID of where the data record was placed and the
31
31
  * sequence number that was assigned to the data record.</p>
32
- * <p>Sequence numbers increase over time and are specific to a shard within a stream,
33
- * not across all shards within a stream. To guarantee strictly increasing ordering, write
32
+ * <p>Sequence numbers increase over time and are specific to a shard within a stream, not
33
+ * across all shards within a stream. To guarantee strictly increasing ordering, write
34
34
  * serially to a shard and use the <code>SequenceNumberForOrdering</code> parameter. For
35
35
  * 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
36
36
  * Developer Guide</i>.</p>
@@ -41,8 +41,8 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
41
41
  * <p>If a <code>PutRecord</code> request cannot be processed because of insufficient
42
42
  * provisioned throughput on the shard involved in the request, <code>PutRecord</code>
43
43
  * throws <code>ProvisionedThroughputExceededException</code>. </p>
44
- * <p>By default, data records are accessible for 24 hours from the time that they are
45
- * added to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>
44
+ * <p>By default, data records are accessible for 24 hours from the time that they are added
45
+ * to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>
46
46
  * @example
47
47
  * Use a bare-bones client and the command you need to make an API call.
48
48
  * ```javascript
@@ -55,7 +55,7 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare
55
55
  *
56
56
  * @see {@link PutRecordCommandInput} for command's `input` shape.
57
57
  * @see {@link PutRecordCommandOutput} for command's `response` shape.
58
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
58
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
59
59
  *
60
60
  */
61
61
  export declare class PutRecordCommand extends $Command<PutRecordCommandInput, PutRecordCommandOutput, KinesisClientResolvedConfig> {
@@ -10,8 +10,8 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
10
10
  * <p>Writes multiple data records into a Kinesis data stream in a single call (also
11
11
  * referred to as a <code>PutRecords</code> request). Use this operation to send data into
12
12
  * the stream for data ingestion and processing. </p>
13
- * <p>Each <code>PutRecords</code> request can support up to 500 records. Each record in
14
- * the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,
13
+ * <p>Each <code>PutRecords</code> request can support up to 500 records. Each record in the
14
+ * request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request,
15
15
  * including partition keys. Each shard can support writes up to 1,000 records per second,
16
16
  * up to a maximum data write total of 1 MiB per second.</p>
17
17
  * <p>You must specify the name of the stream that captures, stores, and transports the
@@ -36,9 +36,9 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
36
36
  * record in the request array using natural ordering, from the top to the bottom of the
37
37
  * request and response. The response <code>Records</code> array always includes the same
38
38
  * number of records as the request array.</p>
39
- * <p>The response <code>Records</code> array includes both successfully and
40
- * unsuccessfully processed records. Kinesis Data Streams attempts to process all records
41
- * in each <code>PutRecords</code> request. A single record failure does not stop the
39
+ * <p>The response <code>Records</code> array includes both successfully and unsuccessfully
40
+ * processed records. Kinesis Data Streams attempts to process all records in each
41
+ * <code>PutRecords</code> request. A single record failure does not stop the
42
42
  * processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering
43
43
  * of records. If you need to read records in the same order they are written to the
44
44
  * stream, use <a>PutRecord</a> instead of <code>PutRecords</code>, and write to
@@ -61,8 +61,8 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
61
61
  * <p>After you write a record to a stream, you cannot modify that record or its order
62
62
  * within the stream.</p>
63
63
  * </important>
64
- * <p>By default, data records are accessible for 24 hours from the time that they are
65
- * added to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>
64
+ * <p>By default, data records are accessible for 24 hours from the time that they are added
65
+ * to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>
66
66
  * @example
67
67
  * Use a bare-bones client and the command you need to make an API call.
68
68
  * ```javascript
@@ -75,7 +75,7 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea
75
75
  *
76
76
  * @see {@link PutRecordsCommandInput} for command's `input` shape.
77
77
  * @see {@link PutRecordsCommandOutput} for command's `response` shape.
78
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
78
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
79
79
  *
80
80
  */
81
81
  export declare class PutRecordsCommand extends $Command<PutRecordsCommandInput, PutRecordsCommandOutput, KinesisClientResolvedConfig> {
@@ -33,7 +33,7 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu
33
33
  *
34
34
  * @see {@link RegisterStreamConsumerCommandInput} for command's `input` shape.
35
35
  * @see {@link RegisterStreamConsumerCommandOutput} for command's `response` shape.
36
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
36
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
37
37
  *
38
38
  */
39
39
  export declare class RegisterStreamConsumerCommand extends $Command<RegisterStreamConsumerCommandInput, RegisterStreamConsumerCommandOutput, KinesisClientResolvedConfig> {
@@ -25,7 +25,7 @@ export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {
25
25
  *
26
26
  * @see {@link RemoveTagsFromStreamCommandInput} for command's `input` shape.
27
27
  * @see {@link RemoveTagsFromStreamCommandOutput} for command's `response` shape.
28
- * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape.
28
+ * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape.
29
29
  *
30
30
  */
31
31
  export declare class RemoveTagsFromStreamCommand extends $Command<RemoveTagsFromStreamCommandInput, RemoveTagsFromStreamCommandOutput, KinesisClientResolvedConfig> {