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