@aws-sdk/client-kinesis 3.533.0 → 3.540.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/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/Kinesis.d.ts +10 -1
- package/dist-types/KinesisClient.d.ts +1 -1
- package/dist-types/commands/AddTagsToStreamCommand.d.ts +2 -1
- package/dist-types/commands/CreateStreamCommand.d.ts +2 -1
- package/dist-types/commands/DecreaseStreamRetentionPeriodCommand.d.ts +2 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteStreamCommand.d.ts +2 -1
- package/dist-types/commands/DeregisterStreamConsumerCommand.d.ts +2 -1
- package/dist-types/commands/DescribeLimitsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStreamCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStreamConsumerCommand.d.ts +2 -1
- package/dist-types/commands/DescribeStreamSummaryCommand.d.ts +2 -1
- package/dist-types/commands/DisableEnhancedMonitoringCommand.d.ts +2 -1
- package/dist-types/commands/EnableEnhancedMonitoringCommand.d.ts +2 -1
- package/dist-types/commands/GetRecordsCommand.d.ts +2 -1
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetShardIteratorCommand.d.ts +2 -1
- package/dist-types/commands/IncreaseStreamRetentionPeriodCommand.d.ts +2 -1
- package/dist-types/commands/ListShardsCommand.d.ts +2 -1
- package/dist-types/commands/ListStreamConsumersCommand.d.ts +2 -1
- package/dist-types/commands/ListStreamsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForStreamCommand.d.ts +2 -1
- package/dist-types/commands/MergeShardsCommand.d.ts +2 -1
- package/dist-types/commands/PutRecordCommand.d.ts +2 -1
- package/dist-types/commands/PutRecordsCommand.d.ts +2 -1
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +2 -1
- package/dist-types/commands/RegisterStreamConsumerCommand.d.ts +2 -1
- package/dist-types/commands/RemoveTagsFromStreamCommand.d.ts +2 -1
- package/dist-types/commands/SplitShardCommand.d.ts +2 -1
- package/dist-types/commands/StartStreamEncryptionCommand.d.ts +2 -1
- package/dist-types/commands/StopStreamEncryptionCommand.d.ts +2 -1
- package/dist-types/commands/SubscribeToShardCommand.d.ts +2 -1
- package/dist-types/commands/UpdateShardCountCommand.d.ts +2 -1
- package/dist-types/commands/UpdateStreamModeCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +286 -286
- package/dist-types/ts3.4/Kinesis.d.ts +9 -0
- package/dist-types/ts3.4/commands/AddTagsToStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DecreaseStreamRetentionPeriodCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeregisterStreamConsumerCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeLimitsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStreamConsumerCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeStreamSummaryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisableEnhancedMonitoringCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EnableEnhancedMonitoringCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRecordsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetShardIteratorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/IncreaseStreamRetentionPeriodCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListShardsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStreamConsumersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListStreamsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/MergeShardsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutRecordCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutRecordsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutResourcePolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RegisterStreamConsumerCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveTagsFromStreamCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SplitShardCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartStreamEncryptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopStreamEncryptionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SubscribeToShardCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateShardCountCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateStreamModeCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +44 -44
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { KinesisServiceException as __BaseException } from "./KinesisServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Specifies that you do not have the permissions required to perform this
|
|
6
5
|
* operation.</p>
|
|
6
|
+
* @public
|
|
7
7
|
*/
|
|
8
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
9
9
|
readonly name: "AccessDeniedException";
|
|
@@ -14,30 +14,30 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* @public
|
|
18
17
|
* <p>Represents the input for <code>AddTagsToStream</code>.</p>
|
|
18
|
+
* @public
|
|
19
19
|
*/
|
|
20
20
|
export interface AddTagsToStreamInput {
|
|
21
21
|
/**
|
|
22
|
-
* @public
|
|
23
22
|
* <p>The name of the stream.</p>
|
|
23
|
+
* @public
|
|
24
24
|
*/
|
|
25
25
|
StreamName?: string;
|
|
26
26
|
/**
|
|
27
|
-
* @public
|
|
28
27
|
* <p>A set of up to 10 key-value pairs to use to create the tags.</p>
|
|
28
|
+
* @public
|
|
29
29
|
*/
|
|
30
30
|
Tags: Record<string, string> | undefined;
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>The ARN of the stream.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
StreamARN?: string;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* @public
|
|
39
38
|
* <p>A specified parameter exceeds its restrictions, is not supported, or can't be used.
|
|
40
39
|
* For more information, see the returned message.</p>
|
|
40
|
+
* @public
|
|
41
41
|
*/
|
|
42
42
|
export declare class InvalidArgumentException extends __BaseException {
|
|
43
43
|
readonly name: "InvalidArgumentException";
|
|
@@ -48,9 +48,9 @@ export declare class InvalidArgumentException extends __BaseException {
|
|
|
48
48
|
constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>The requested resource exceeds the maximum number allowed, or the number of concurrent
|
|
53
52
|
* stream requests exceeds the maximum number allowed. </p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
export declare class LimitExceededException extends __BaseException {
|
|
56
56
|
readonly name: "LimitExceededException";
|
|
@@ -61,9 +61,9 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
61
61
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>The resource is not available for this operation. For successful operation, the
|
|
66
65
|
* resource must be in the <code>ACTIVE</code> state.</p>
|
|
66
|
+
* @public
|
|
67
67
|
*/
|
|
68
68
|
export declare class ResourceInUseException extends __BaseException {
|
|
69
69
|
readonly name: "ResourceInUseException";
|
|
@@ -74,9 +74,9 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
74
74
|
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
75
75
|
}
|
|
76
76
|
/**
|
|
77
|
-
* @public
|
|
78
77
|
* <p>The requested resource could not be found. The stream might not be specified
|
|
79
78
|
* correctly.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
82
82
|
readonly name: "ResourceNotFoundException";
|
|
@@ -87,42 +87,42 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
87
87
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>The range of possible hash key values for the shard, which is a set of ordered
|
|
92
91
|
* contiguous positive integers.</p>
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
export interface HashKeyRange {
|
|
95
95
|
/**
|
|
96
|
-
* @public
|
|
97
96
|
* <p>The starting hash key of the hash key range.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
StartingHashKey: string | undefined;
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>The ending hash key of the hash key range.</p>
|
|
102
|
+
* @public
|
|
103
103
|
*/
|
|
104
104
|
EndingHashKey: string | undefined;
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* @public
|
|
108
107
|
* <p>Output parameter of the GetRecords API. The existing child shard of the current
|
|
109
108
|
* shard.</p>
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
export interface ChildShard {
|
|
112
112
|
/**
|
|
113
|
-
* @public
|
|
114
113
|
* <p>The shard ID of the existing child shard of the current shard.</p>
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
ShardId: string | undefined;
|
|
117
117
|
/**
|
|
118
|
-
* @public
|
|
119
118
|
* <p>The current shard that is the parent of the existing child shard.</p>
|
|
119
|
+
* @public
|
|
120
120
|
*/
|
|
121
121
|
ParentShards: string[] | undefined;
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <p>The range of possible hash key values for the shard, which is a set of ordered
|
|
125
124
|
* contiguous positive integers.</p>
|
|
125
|
+
* @public
|
|
126
126
|
*/
|
|
127
127
|
HashKeyRange: HashKeyRange | undefined;
|
|
128
128
|
}
|
|
@@ -140,73 +140,73 @@ export declare const ConsumerStatus: {
|
|
|
140
140
|
*/
|
|
141
141
|
export type ConsumerStatus = (typeof ConsumerStatus)[keyof typeof ConsumerStatus];
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>An object that represents the details of the consumer you registered. This type of
|
|
145
144
|
* object is returned by <a>RegisterStreamConsumer</a>.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
export interface Consumer {
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>The name of the consumer is something you choose when you register the
|
|
151
150
|
* consumer.</p>
|
|
151
|
+
* @public
|
|
152
152
|
*/
|
|
153
153
|
ConsumerName: string | undefined;
|
|
154
154
|
/**
|
|
155
|
-
* @public
|
|
156
155
|
* <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
|
|
157
156
|
* this ARN to be able to call <a>SubscribeToShard</a>.</p>
|
|
158
157
|
* <p>If you delete a consumer and then create a new one with the same name, it won't have
|
|
159
158
|
* the same ARN. That's because consumer ARNs contain the creation timestamp. This is
|
|
160
159
|
* important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
|
|
160
|
+
* @public
|
|
161
161
|
*/
|
|
162
162
|
ConsumerARN: string | undefined;
|
|
163
163
|
/**
|
|
164
|
-
* @public
|
|
165
164
|
* <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
|
|
166
165
|
* states.</p>
|
|
166
|
+
* @public
|
|
167
167
|
*/
|
|
168
168
|
ConsumerStatus: ConsumerStatus | undefined;
|
|
169
169
|
/**
|
|
170
|
-
* @public
|
|
171
170
|
* <p></p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
ConsumerCreationTimestamp: Date | undefined;
|
|
174
174
|
}
|
|
175
175
|
/**
|
|
176
|
-
* @public
|
|
177
176
|
* <p>An object that represents the details of a registered consumer. This type of object is
|
|
178
177
|
* returned by <a>DescribeStreamConsumer</a>.</p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
export interface ConsumerDescription {
|
|
181
181
|
/**
|
|
182
|
-
* @public
|
|
183
182
|
* <p>The name of the consumer is something you choose when you register the
|
|
184
183
|
* consumer.</p>
|
|
184
|
+
* @public
|
|
185
185
|
*/
|
|
186
186
|
ConsumerName: string | undefined;
|
|
187
187
|
/**
|
|
188
|
-
* @public
|
|
189
188
|
* <p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need
|
|
190
189
|
* this ARN to be able to call <a>SubscribeToShard</a>.</p>
|
|
191
190
|
* <p>If you delete a consumer and then create a new one with the same name, it won't have
|
|
192
191
|
* the same ARN. That's because consumer ARNs contain the creation timestamp. This is
|
|
193
192
|
* important to keep in mind if you have IAM policies that reference consumer ARNs.</p>
|
|
193
|
+
* @public
|
|
194
194
|
*/
|
|
195
195
|
ConsumerARN: string | undefined;
|
|
196
196
|
/**
|
|
197
|
-
* @public
|
|
198
197
|
* <p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code>
|
|
199
198
|
* states.</p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
ConsumerStatus: ConsumerStatus | undefined;
|
|
202
202
|
/**
|
|
203
|
-
* @public
|
|
204
203
|
* <p></p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
ConsumerCreationTimestamp: Date | undefined;
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>The ARN of the stream with which you registered the consumer.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
StreamARN: string | undefined;
|
|
212
212
|
}
|
|
@@ -223,66 +223,66 @@ export declare const StreamMode: {
|
|
|
223
223
|
*/
|
|
224
224
|
export type StreamMode = (typeof StreamMode)[keyof typeof StreamMode];
|
|
225
225
|
/**
|
|
226
|
-
* @public
|
|
227
226
|
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
228
227
|
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
|
|
228
|
+
* @public
|
|
229
229
|
*/
|
|
230
230
|
export interface StreamModeDetails {
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
234
233
|
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
|
|
234
|
+
* @public
|
|
235
235
|
*/
|
|
236
236
|
StreamMode: StreamMode | undefined;
|
|
237
237
|
}
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>Represents the input for <code>CreateStream</code>.</p>
|
|
240
|
+
* @public
|
|
241
241
|
*/
|
|
242
242
|
export interface CreateStreamInput {
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>A name to identify the stream. The stream name is scoped to the Amazon Web Services
|
|
246
245
|
* account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts
|
|
247
246
|
* can have the same name. Two streams in the same Amazon Web Services account but in two
|
|
248
247
|
* different Regions can also have the same name.</p>
|
|
248
|
+
* @public
|
|
249
249
|
*/
|
|
250
250
|
StreamName: string | undefined;
|
|
251
251
|
/**
|
|
252
|
-
* @public
|
|
253
252
|
* <p>The number of shards that the stream will use. The throughput of the stream is a
|
|
254
253
|
* function of the number of shards; more shards are required for greater provisioned
|
|
255
254
|
* throughput.</p>
|
|
255
|
+
* @public
|
|
256
256
|
*/
|
|
257
257
|
ShardCount?: number;
|
|
258
258
|
/**
|
|
259
|
-
* @public
|
|
260
259
|
* <p> Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,
|
|
261
260
|
* you can choose between an <b>on-demand</b> capacity mode and a
|
|
262
261
|
* <b>provisioned</b> capacity mode for your data
|
|
263
262
|
* streams.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
StreamModeDetails?: StreamModeDetails;
|
|
266
266
|
}
|
|
267
267
|
/**
|
|
268
|
-
* @public
|
|
269
268
|
* <p>Represents the input for <a>DecreaseStreamRetentionPeriod</a>.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
export interface DecreaseStreamRetentionPeriodInput {
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>The name of the stream to modify.</p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
StreamName?: string;
|
|
277
277
|
/**
|
|
278
|
-
* @public
|
|
279
278
|
* <p>The new retention period of the stream, in hours. Must be less than the current
|
|
280
279
|
* retention period.</p>
|
|
280
|
+
* @public
|
|
281
281
|
*/
|
|
282
282
|
RetentionPeriodHours: number | undefined;
|
|
283
283
|
/**
|
|
284
|
-
* @public
|
|
285
284
|
* <p>The ARN of the stream.</p>
|
|
285
|
+
* @public
|
|
286
286
|
*/
|
|
287
287
|
StreamARN?: string;
|
|
288
288
|
}
|
|
@@ -291,31 +291,31 @@ export interface DecreaseStreamRetentionPeriodInput {
|
|
|
291
291
|
*/
|
|
292
292
|
export interface DeleteResourcePolicyInput {
|
|
293
293
|
/**
|
|
294
|
-
* @public
|
|
295
294
|
* <p>The Amazon Resource Name (ARN) of the data stream or consumer.</p>
|
|
295
|
+
* @public
|
|
296
296
|
*/
|
|
297
297
|
ResourceARN: string | undefined;
|
|
298
298
|
}
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <p>Represents the input for <a>DeleteStream</a>.</p>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
export interface DeleteStreamInput {
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <p>The name of the stream to delete.</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
StreamName?: string;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>If this parameter is unset (<code>null</code>) or if you set it to <code>false</code>,
|
|
312
311
|
* and the stream has registered consumers, the call to <code>DeleteStream</code> fails
|
|
313
312
|
* with a <code>ResourceInUseException</code>. </p>
|
|
313
|
+
* @public
|
|
314
314
|
*/
|
|
315
315
|
EnforceConsumerDeletion?: boolean;
|
|
316
316
|
/**
|
|
317
|
-
* @public
|
|
318
317
|
* <p>The ARN of the stream.</p>
|
|
318
|
+
* @public
|
|
319
319
|
*/
|
|
320
320
|
StreamARN?: string;
|
|
321
321
|
}
|
|
@@ -324,24 +324,24 @@ export interface DeleteStreamInput {
|
|
|
324
324
|
*/
|
|
325
325
|
export interface DeregisterStreamConsumerInput {
|
|
326
326
|
/**
|
|
327
|
-
* @public
|
|
328
327
|
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
|
|
329
328
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service
|
|
330
329
|
* Namespaces</a>.</p>
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
StreamARN?: string;
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>The name that you gave to the consumer.</p>
|
|
335
|
+
* @public
|
|
336
336
|
*/
|
|
337
337
|
ConsumerName?: string;
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you
|
|
341
340
|
* don't know the ARN of the consumer that you want to deregister, you can use the
|
|
342
341
|
* ListStreamConsumers operation to get a list of the descriptions of all the consumers
|
|
343
342
|
* that are currently registered with a given data stream. The description of a consumer
|
|
344
343
|
* contains its ARN.</p>
|
|
344
|
+
* @public
|
|
345
345
|
*/
|
|
346
346
|
ConsumerARN?: string;
|
|
347
347
|
}
|
|
@@ -355,55 +355,55 @@ export interface DescribeLimitsInput {
|
|
|
355
355
|
*/
|
|
356
356
|
export interface DescribeLimitsOutput {
|
|
357
357
|
/**
|
|
358
|
-
* @public
|
|
359
358
|
* <p>The maximum number of shards.</p>
|
|
359
|
+
* @public
|
|
360
360
|
*/
|
|
361
361
|
ShardLimit: number | undefined;
|
|
362
362
|
/**
|
|
363
|
-
* @public
|
|
364
363
|
* <p>The number of open shards.</p>
|
|
364
|
+
* @public
|
|
365
365
|
*/
|
|
366
366
|
OpenShardCount: number | undefined;
|
|
367
367
|
/**
|
|
368
|
-
* @public
|
|
369
368
|
* <p> Indicates the number of data streams with the on-demand capacity mode.</p>
|
|
369
|
+
* @public
|
|
370
370
|
*/
|
|
371
371
|
OnDemandStreamCount: number | undefined;
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p> The maximum number of data streams with the on-demand capacity mode. </p>
|
|
374
|
+
* @public
|
|
375
375
|
*/
|
|
376
376
|
OnDemandStreamCountLimit: number | undefined;
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>Represents the input for <code>DescribeStream</code>.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
export interface DescribeStreamInput {
|
|
383
383
|
/**
|
|
384
|
-
* @public
|
|
385
384
|
* <p>The name of the stream to describe.</p>
|
|
385
|
+
* @public
|
|
386
386
|
*/
|
|
387
387
|
StreamName?: string;
|
|
388
388
|
/**
|
|
389
|
-
* @public
|
|
390
389
|
* <p>The maximum number of shards to return in a single call. The default value is 100. If
|
|
391
390
|
* you specify a value greater than 100, at most 100 results are returned.</p>
|
|
391
|
+
* @public
|
|
392
392
|
*/
|
|
393
393
|
Limit?: number;
|
|
394
394
|
/**
|
|
395
|
-
* @public
|
|
396
395
|
* <p>The shard ID of the shard to start with.</p>
|
|
397
396
|
* <p>Specify this parameter to indicate that you want to describe the stream starting with
|
|
398
397
|
* the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
|
|
399
398
|
* <p>If you don't specify this parameter, the default behavior for
|
|
400
399
|
* <code>DescribeStream</code> is to describe the stream starting with the first shard
|
|
401
400
|
* in the stream.</p>
|
|
401
|
+
* @public
|
|
402
402
|
*/
|
|
403
403
|
ExclusiveStartShardId?: string;
|
|
404
404
|
/**
|
|
405
|
-
* @public
|
|
406
405
|
* <p>The ARN of the stream.</p>
|
|
406
|
+
* @public
|
|
407
407
|
*/
|
|
408
408
|
StreamARN?: string;
|
|
409
409
|
}
|
|
@@ -438,12 +438,11 @@ export declare const MetricsName: {
|
|
|
438
438
|
*/
|
|
439
439
|
export type MetricsName = (typeof MetricsName)[keyof typeof MetricsName];
|
|
440
440
|
/**
|
|
441
|
-
* @public
|
|
442
441
|
* <p>Represents enhanced metrics types.</p>
|
|
442
|
+
* @public
|
|
443
443
|
*/
|
|
444
444
|
export interface EnhancedMetrics {
|
|
445
445
|
/**
|
|
446
|
-
* @public
|
|
447
446
|
* <p>List of shard-level metrics.</p>
|
|
448
447
|
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enhances
|
|
449
448
|
* every metric.</p>
|
|
@@ -492,55 +491,56 @@ export interface EnhancedMetrics {
|
|
|
492
491
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
|
|
493
492
|
* Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
|
|
494
493
|
* Kinesis Data Streams Developer Guide</i>.</p>
|
|
494
|
+
* @public
|
|
495
495
|
*/
|
|
496
496
|
ShardLevelMetrics?: MetricsName[];
|
|
497
497
|
}
|
|
498
498
|
/**
|
|
499
|
-
* @public
|
|
500
499
|
* <p>The range of possible sequence numbers for the shard.</p>
|
|
500
|
+
* @public
|
|
501
501
|
*/
|
|
502
502
|
export interface SequenceNumberRange {
|
|
503
503
|
/**
|
|
504
|
-
* @public
|
|
505
504
|
* <p>The starting sequence number for the range.</p>
|
|
505
|
+
* @public
|
|
506
506
|
*/
|
|
507
507
|
StartingSequenceNumber: string | undefined;
|
|
508
508
|
/**
|
|
509
|
-
* @public
|
|
510
509
|
* <p>The ending sequence number for the range. Shards that are in the OPEN state have an
|
|
511
510
|
* ending sequence number of <code>null</code>.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
EndingSequenceNumber?: string;
|
|
514
514
|
}
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>A uniquely identified group of data records in a Kinesis data stream.</p>
|
|
517
|
+
* @public
|
|
518
518
|
*/
|
|
519
519
|
export interface Shard {
|
|
520
520
|
/**
|
|
521
|
-
* @public
|
|
522
521
|
* <p>The unique identifier of the shard within the stream.</p>
|
|
522
|
+
* @public
|
|
523
523
|
*/
|
|
524
524
|
ShardId: string | undefined;
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <p>The shard ID of the shard's parent.</p>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
ParentShardId?: string;
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>The shard ID of the shard adjacent to the shard's parent.</p>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
AdjacentParentShardId?: string;
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <p>The range of possible hash key values for the shard, which is a set of ordered
|
|
538
537
|
* contiguous positive integers.</p>
|
|
538
|
+
* @public
|
|
539
539
|
*/
|
|
540
540
|
HashKeyRange: HashKeyRange | undefined;
|
|
541
541
|
/**
|
|
542
|
-
* @public
|
|
543
542
|
* <p>The range of possible sequence numbers for the shard.</p>
|
|
543
|
+
* @public
|
|
544
544
|
*/
|
|
545
545
|
SequenceNumberRange: SequenceNumberRange | undefined;
|
|
546
546
|
}
|
|
@@ -559,22 +559,21 @@ export declare const StreamStatus: {
|
|
|
559
559
|
*/
|
|
560
560
|
export type StreamStatus = (typeof StreamStatus)[keyof typeof StreamStatus];
|
|
561
561
|
/**
|
|
562
|
-
* @public
|
|
563
562
|
* <p>Represents the output for <a>DescribeStream</a>.</p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
export interface StreamDescription {
|
|
566
566
|
/**
|
|
567
|
-
* @public
|
|
568
567
|
* <p>The name of the stream being described.</p>
|
|
568
|
+
* @public
|
|
569
569
|
*/
|
|
570
570
|
StreamName: string | undefined;
|
|
571
571
|
/**
|
|
572
|
-
* @public
|
|
573
572
|
* <p>The Amazon Resource Name (ARN) for the stream being described.</p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
StreamARN: string | undefined;
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>The current status of the stream being described. The stream status is one of the
|
|
579
578
|
* following states:</p>
|
|
580
579
|
* <ul>
|
|
@@ -603,43 +602,43 @@ export interface StreamDescription {
|
|
|
603
602
|
* <code>UPDATING</code> state.</p>
|
|
604
603
|
* </li>
|
|
605
604
|
* </ul>
|
|
605
|
+
* @public
|
|
606
606
|
*/
|
|
607
607
|
StreamStatus: StreamStatus | undefined;
|
|
608
608
|
/**
|
|
609
|
-
* @public
|
|
610
609
|
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
611
610
|
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
|
|
611
|
+
* @public
|
|
612
612
|
*/
|
|
613
613
|
StreamModeDetails?: StreamModeDetails;
|
|
614
614
|
/**
|
|
615
|
-
* @public
|
|
616
615
|
* <p>The shards that comprise the stream.</p>
|
|
616
|
+
* @public
|
|
617
617
|
*/
|
|
618
618
|
Shards: Shard[] | undefined;
|
|
619
619
|
/**
|
|
620
|
-
* @public
|
|
621
620
|
* <p>If set to <code>true</code>, more shards in the stream are available to
|
|
622
621
|
* describe.</p>
|
|
622
|
+
* @public
|
|
623
623
|
*/
|
|
624
624
|
HasMoreShards: boolean | undefined;
|
|
625
625
|
/**
|
|
626
|
-
* @public
|
|
627
626
|
* <p>The current retention period, in hours. Minimum value of 24. Maximum value of
|
|
628
627
|
* 168.</p>
|
|
628
|
+
* @public
|
|
629
629
|
*/
|
|
630
630
|
RetentionPeriodHours: number | undefined;
|
|
631
631
|
/**
|
|
632
|
-
* @public
|
|
633
632
|
* <p>The approximate time that the stream was created.</p>
|
|
633
|
+
* @public
|
|
634
634
|
*/
|
|
635
635
|
StreamCreationTimestamp: Date | undefined;
|
|
636
636
|
/**
|
|
637
|
-
* @public
|
|
638
637
|
* <p>Represents the current enhanced monitoring settings of the stream.</p>
|
|
638
|
+
* @public
|
|
639
639
|
*/
|
|
640
640
|
EnhancedMonitoring: EnhancedMetrics[] | undefined;
|
|
641
641
|
/**
|
|
642
|
-
* @public
|
|
643
642
|
* <p>The server-side encryption type used on the stream. This parameter can be one of the
|
|
644
643
|
* following values:</p>
|
|
645
644
|
* <ul>
|
|
@@ -653,10 +652,10 @@ export interface StreamDescription {
|
|
|
653
652
|
* using a customer-managed Amazon Web Services KMS key.</p>
|
|
654
653
|
* </li>
|
|
655
654
|
* </ul>
|
|
655
|
+
* @public
|
|
656
656
|
*/
|
|
657
657
|
EncryptionType?: EncryptionType;
|
|
658
658
|
/**
|
|
659
|
-
* @public
|
|
660
659
|
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
661
660
|
* This value can be a globally unique identifier, a fully specified ARN to either an alias
|
|
662
661
|
* or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
|
|
@@ -687,19 +686,20 @@ export interface StreamDescription {
|
|
|
687
686
|
* </p>
|
|
688
687
|
* </li>
|
|
689
688
|
* </ul>
|
|
689
|
+
* @public
|
|
690
690
|
*/
|
|
691
691
|
KeyId?: string;
|
|
692
692
|
}
|
|
693
693
|
/**
|
|
694
|
-
* @public
|
|
695
694
|
* <p>Represents the output for <code>DescribeStream</code>.</p>
|
|
695
|
+
* @public
|
|
696
696
|
*/
|
|
697
697
|
export interface DescribeStreamOutput {
|
|
698
698
|
/**
|
|
699
|
-
* @public
|
|
700
699
|
* <p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of
|
|
701
700
|
* shard objects that comprise the stream, and whether there are more shards
|
|
702
701
|
* available.</p>
|
|
702
|
+
* @public
|
|
703
703
|
*/
|
|
704
704
|
StreamDescription: StreamDescription | undefined;
|
|
705
705
|
}
|
|
@@ -708,20 +708,20 @@ export interface DescribeStreamOutput {
|
|
|
708
708
|
*/
|
|
709
709
|
export interface DescribeStreamConsumerInput {
|
|
710
710
|
/**
|
|
711
|
-
* @public
|
|
712
711
|
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For more
|
|
713
712
|
* information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service
|
|
714
713
|
* Namespaces</a>.</p>
|
|
714
|
+
* @public
|
|
715
715
|
*/
|
|
716
716
|
StreamARN?: string;
|
|
717
717
|
/**
|
|
718
|
-
* @public
|
|
719
718
|
* <p>The name that you gave to the consumer.</p>
|
|
719
|
+
* @public
|
|
720
720
|
*/
|
|
721
721
|
ConsumerName?: string;
|
|
722
722
|
/**
|
|
723
|
-
* @public
|
|
724
723
|
* <p>The ARN returned by Kinesis Data Streams when you registered the consumer.</p>
|
|
724
|
+
* @public
|
|
725
725
|
*/
|
|
726
726
|
ConsumerARN?: string;
|
|
727
727
|
}
|
|
@@ -730,8 +730,8 @@ export interface DescribeStreamConsumerInput {
|
|
|
730
730
|
*/
|
|
731
731
|
export interface DescribeStreamConsumerOutput {
|
|
732
732
|
/**
|
|
733
|
-
* @public
|
|
734
733
|
* <p>An object that represents the details of the consumer.</p>
|
|
734
|
+
* @public
|
|
735
735
|
*/
|
|
736
736
|
ConsumerDescription: ConsumerDescription | undefined;
|
|
737
737
|
}
|
|
@@ -740,34 +740,33 @@ export interface DescribeStreamConsumerOutput {
|
|
|
740
740
|
*/
|
|
741
741
|
export interface DescribeStreamSummaryInput {
|
|
742
742
|
/**
|
|
743
|
-
* @public
|
|
744
743
|
* <p>The name of the stream to describe.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
StreamName?: string;
|
|
747
747
|
/**
|
|
748
|
-
* @public
|
|
749
748
|
* <p>The ARN of the stream.</p>
|
|
749
|
+
* @public
|
|
750
750
|
*/
|
|
751
751
|
StreamARN?: string;
|
|
752
752
|
}
|
|
753
753
|
/**
|
|
754
|
-
* @public
|
|
755
754
|
* <p>Represents the output for <a>DescribeStreamSummary</a>
|
|
756
755
|
* </p>
|
|
756
|
+
* @public
|
|
757
757
|
*/
|
|
758
758
|
export interface StreamDescriptionSummary {
|
|
759
759
|
/**
|
|
760
|
-
* @public
|
|
761
760
|
* <p>The name of the stream being described.</p>
|
|
761
|
+
* @public
|
|
762
762
|
*/
|
|
763
763
|
StreamName: string | undefined;
|
|
764
764
|
/**
|
|
765
|
-
* @public
|
|
766
765
|
* <p>The Amazon Resource Name (ARN) for the stream being described.</p>
|
|
766
|
+
* @public
|
|
767
767
|
*/
|
|
768
768
|
StreamARN: string | undefined;
|
|
769
769
|
/**
|
|
770
|
-
* @public
|
|
771
770
|
* <p>The current status of the stream being described. The stream status is one of the
|
|
772
771
|
* following states:</p>
|
|
773
772
|
* <ul>
|
|
@@ -796,31 +795,31 @@ export interface StreamDescriptionSummary {
|
|
|
796
795
|
* <code>UPDATING</code> state.</p>
|
|
797
796
|
* </li>
|
|
798
797
|
* </ul>
|
|
798
|
+
* @public
|
|
799
799
|
*/
|
|
800
800
|
StreamStatus: StreamStatus | undefined;
|
|
801
801
|
/**
|
|
802
|
-
* @public
|
|
803
802
|
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
804
803
|
* Kinesis Data Streams, you can choose between an <b>on-demand</b> ycapacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
|
|
804
|
+
* @public
|
|
805
805
|
*/
|
|
806
806
|
StreamModeDetails?: StreamModeDetails;
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>The current retention period, in hours.</p>
|
|
809
|
+
* @public
|
|
810
810
|
*/
|
|
811
811
|
RetentionPeriodHours: number | undefined;
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>The approximate time that the stream was created.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
StreamCreationTimestamp: Date | undefined;
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>Represents the current enhanced monitoring settings of the stream.</p>
|
|
819
|
+
* @public
|
|
820
820
|
*/
|
|
821
821
|
EnhancedMonitoring: EnhancedMetrics[] | undefined;
|
|
822
822
|
/**
|
|
823
|
-
* @public
|
|
824
823
|
* <p>The encryption type used. This value is one of the following:</p>
|
|
825
824
|
* <ul>
|
|
826
825
|
* <li>
|
|
@@ -834,10 +833,10 @@ export interface StreamDescriptionSummary {
|
|
|
834
833
|
* </p>
|
|
835
834
|
* </li>
|
|
836
835
|
* </ul>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
EncryptionType?: EncryptionType;
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
842
841
|
* This value can be a globally unique identifier, a fully specified ARN to either an alias
|
|
843
842
|
* or a key, or an alias name prefixed by "alias/".You can also use a master key owned by
|
|
@@ -868,16 +867,17 @@ export interface StreamDescriptionSummary {
|
|
|
868
867
|
* </p>
|
|
869
868
|
* </li>
|
|
870
869
|
* </ul>
|
|
870
|
+
* @public
|
|
871
871
|
*/
|
|
872
872
|
KeyId?: string;
|
|
873
873
|
/**
|
|
874
|
-
* @public
|
|
875
874
|
* <p>The number of open shards in the stream.</p>
|
|
875
|
+
* @public
|
|
876
876
|
*/
|
|
877
877
|
OpenShardCount: number | undefined;
|
|
878
878
|
/**
|
|
879
|
-
* @public
|
|
880
879
|
* <p>The number of enhanced fan-out consumers registered with the stream.</p>
|
|
880
|
+
* @public
|
|
881
881
|
*/
|
|
882
882
|
ConsumerCount?: number;
|
|
883
883
|
}
|
|
@@ -886,24 +886,23 @@ export interface StreamDescriptionSummary {
|
|
|
886
886
|
*/
|
|
887
887
|
export interface DescribeStreamSummaryOutput {
|
|
888
888
|
/**
|
|
889
|
-
* @public
|
|
890
889
|
* <p>A <a>StreamDescriptionSummary</a> containing information about the
|
|
891
890
|
* stream.</p>
|
|
891
|
+
* @public
|
|
892
892
|
*/
|
|
893
893
|
StreamDescriptionSummary: StreamDescriptionSummary | undefined;
|
|
894
894
|
}
|
|
895
895
|
/**
|
|
896
|
-
* @public
|
|
897
896
|
* <p>Represents the input for <a>DisableEnhancedMonitoring</a>.</p>
|
|
897
|
+
* @public
|
|
898
898
|
*/
|
|
899
899
|
export interface DisableEnhancedMonitoringInput {
|
|
900
900
|
/**
|
|
901
|
-
* @public
|
|
902
901
|
* <p>The name of the Kinesis data stream for which to disable enhanced monitoring.</p>
|
|
902
|
+
* @public
|
|
903
903
|
*/
|
|
904
904
|
StreamName?: string;
|
|
905
905
|
/**
|
|
906
|
-
* @public
|
|
907
906
|
* <p>List of shard-level metrics to disable.</p>
|
|
908
907
|
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" disables
|
|
909
908
|
* every metric.</p>
|
|
@@ -952,54 +951,54 @@ export interface DisableEnhancedMonitoringInput {
|
|
|
952
951
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
|
|
953
952
|
* Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
|
|
954
953
|
* Kinesis Data Streams Developer Guide</i>.</p>
|
|
954
|
+
* @public
|
|
955
955
|
*/
|
|
956
956
|
ShardLevelMetrics: MetricsName[] | undefined;
|
|
957
957
|
/**
|
|
958
|
-
* @public
|
|
959
958
|
* <p>The ARN of the stream.</p>
|
|
959
|
+
* @public
|
|
960
960
|
*/
|
|
961
961
|
StreamARN?: string;
|
|
962
962
|
}
|
|
963
963
|
/**
|
|
964
|
-
* @public
|
|
965
964
|
* <p>Represents the output for <a>EnableEnhancedMonitoring</a> and <a>DisableEnhancedMonitoring</a>.</p>
|
|
965
|
+
* @public
|
|
966
966
|
*/
|
|
967
967
|
export interface EnhancedMonitoringOutput {
|
|
968
968
|
/**
|
|
969
|
-
* @public
|
|
970
969
|
* <p>The name of the Kinesis data stream.</p>
|
|
970
|
+
* @public
|
|
971
971
|
*/
|
|
972
972
|
StreamName?: string;
|
|
973
973
|
/**
|
|
974
|
-
* @public
|
|
975
974
|
* <p>Represents the current state of the metrics that are in the enhanced state before the
|
|
976
975
|
* operation.</p>
|
|
976
|
+
* @public
|
|
977
977
|
*/
|
|
978
978
|
CurrentShardLevelMetrics?: MetricsName[];
|
|
979
979
|
/**
|
|
980
|
-
* @public
|
|
981
980
|
* <p>Represents the list of all the metrics that would be in the enhanced state after the
|
|
982
981
|
* operation.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
DesiredShardLevelMetrics?: MetricsName[];
|
|
985
985
|
/**
|
|
986
|
-
* @public
|
|
987
986
|
* <p>The ARN of the stream.</p>
|
|
987
|
+
* @public
|
|
988
988
|
*/
|
|
989
989
|
StreamARN?: string;
|
|
990
990
|
}
|
|
991
991
|
/**
|
|
992
|
-
* @public
|
|
993
992
|
* <p>Represents the input for <a>EnableEnhancedMonitoring</a>.</p>
|
|
993
|
+
* @public
|
|
994
994
|
*/
|
|
995
995
|
export interface EnableEnhancedMonitoringInput {
|
|
996
996
|
/**
|
|
997
|
-
* @public
|
|
998
997
|
* <p>The name of the stream for which to enable enhanced monitoring.</p>
|
|
998
|
+
* @public
|
|
999
999
|
*/
|
|
1000
1000
|
StreamName?: string;
|
|
1001
1001
|
/**
|
|
1002
|
-
* @public
|
|
1003
1002
|
* <p>List of shard-level metrics to enable.</p>
|
|
1004
1003
|
* <p>The following are the valid shard-level metrics. The value "<code>ALL</code>" enables
|
|
1005
1004
|
* every metric.</p>
|
|
@@ -1048,17 +1047,18 @@ export interface EnableEnhancedMonitoringInput {
|
|
|
1048
1047
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html">Monitoring the Amazon
|
|
1049
1048
|
* Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon
|
|
1050
1049
|
* Kinesis Data Streams Developer Guide</i>.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
ShardLevelMetrics: MetricsName[] | undefined;
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>The ARN of the stream.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
StreamARN?: string;
|
|
1058
1058
|
}
|
|
1059
1059
|
/**
|
|
1060
|
-
* @public
|
|
1061
1060
|
* <p>The provided iterator exceeds the maximum age allowed.</p>
|
|
1061
|
+
* @public
|
|
1062
1062
|
*/
|
|
1063
1063
|
export declare class ExpiredIteratorException extends __BaseException {
|
|
1064
1064
|
readonly name: "ExpiredIteratorException";
|
|
@@ -1069,8 +1069,8 @@ export declare class ExpiredIteratorException extends __BaseException {
|
|
|
1069
1069
|
constructor(opts: __ExceptionOptionType<ExpiredIteratorException, __BaseException>);
|
|
1070
1070
|
}
|
|
1071
1071
|
/**
|
|
1072
|
-
* @public
|
|
1073
1072
|
* <p>The pagination token passed to the operation is expired.</p>
|
|
1073
|
+
* @public
|
|
1074
1074
|
*/
|
|
1075
1075
|
export declare class ExpiredNextTokenException extends __BaseException {
|
|
1076
1076
|
readonly name: "ExpiredNextTokenException";
|
|
@@ -1081,61 +1081,60 @@ export declare class ExpiredNextTokenException extends __BaseException {
|
|
|
1081
1081
|
constructor(opts: __ExceptionOptionType<ExpiredNextTokenException, __BaseException>);
|
|
1082
1082
|
}
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>Represents the input for <a>GetRecords</a>.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
export interface GetRecordsInput {
|
|
1088
1088
|
/**
|
|
1089
|
-
* @public
|
|
1090
1089
|
* <p>The position in the shard from which you want to start sequentially reading data
|
|
1091
1090
|
* records. A shard iterator specifies this position using the sequence number of a data
|
|
1092
1091
|
* record in the shard.</p>
|
|
1092
|
+
* @public
|
|
1093
1093
|
*/
|
|
1094
1094
|
ShardIterator: string | undefined;
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>The maximum number of records to return. Specify a value of up to 10,000. If you
|
|
1098
1097
|
* specify a value that is greater than 10,000, <a>GetRecords</a> throws
|
|
1099
1098
|
* <code>InvalidArgumentException</code>. The default value is 10,000.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
Limit?: number;
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>The ARN of the stream.</p>
|
|
1104
|
+
* @public
|
|
1105
1105
|
*/
|
|
1106
1106
|
StreamARN?: string;
|
|
1107
1107
|
}
|
|
1108
1108
|
/**
|
|
1109
|
-
* @public
|
|
1110
1109
|
* <p>The unit of data of the Kinesis data stream, which is composed of a sequence number, a
|
|
1111
1110
|
* partition key, and a data blob.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
export interface _Record {
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>The unique identifier of the record within its shard.</p>
|
|
1116
|
+
* @public
|
|
1117
1117
|
*/
|
|
1118
1118
|
SequenceNumber: string | undefined;
|
|
1119
1119
|
/**
|
|
1120
|
-
* @public
|
|
1121
1120
|
* <p>The approximate time that the record was inserted into the stream.</p>
|
|
1121
|
+
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
ApproximateArrivalTimestamp?: Date;
|
|
1124
1124
|
/**
|
|
1125
|
-
* @public
|
|
1126
1125
|
* <p>The data blob. The data in the blob is both opaque and immutable to Kinesis Data
|
|
1127
1126
|
* Streams, which does not inspect, interpret, or change the data in the blob in any way.
|
|
1128
1127
|
* When the data blob (the payload before base64-encoding) is added to the partition key
|
|
1129
1128
|
* size, the total size must not exceed the maximum record size (1 MiB).</p>
|
|
1129
|
+
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
Data: Uint8Array | undefined;
|
|
1132
1132
|
/**
|
|
1133
|
-
* @public
|
|
1134
1133
|
* <p>Identifies which shard in the stream the data record is assigned to.</p>
|
|
1134
|
+
* @public
|
|
1135
1135
|
*/
|
|
1136
1136
|
PartitionKey: string | undefined;
|
|
1137
1137
|
/**
|
|
1138
|
-
* @public
|
|
1139
1138
|
* <p>The encryption type used on the record. This parameter can be one of the following
|
|
1140
1139
|
* values:</p>
|
|
1141
1140
|
* <ul>
|
|
@@ -1149,45 +1148,46 @@ export interface _Record {
|
|
|
1149
1148
|
* using a customer-managed Amazon Web Services KMS key.</p>
|
|
1150
1149
|
* </li>
|
|
1151
1150
|
* </ul>
|
|
1151
|
+
* @public
|
|
1152
1152
|
*/
|
|
1153
1153
|
EncryptionType?: EncryptionType;
|
|
1154
1154
|
}
|
|
1155
1155
|
/**
|
|
1156
|
-
* @public
|
|
1157
1156
|
* <p>Represents the output for <a>GetRecords</a>.</p>
|
|
1157
|
+
* @public
|
|
1158
1158
|
*/
|
|
1159
1159
|
export interface GetRecordsOutput {
|
|
1160
1160
|
/**
|
|
1161
|
-
* @public
|
|
1162
1161
|
* <p>The data records retrieved from the shard.</p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
Records: _Record[] | undefined;
|
|
1165
1165
|
/**
|
|
1166
|
-
* @public
|
|
1167
1166
|
* <p>The next position in the shard from which to start sequentially reading data records.
|
|
1168
1167
|
* If set to <code>null</code>, the shard has been closed and the requested iterator does
|
|
1169
1168
|
* not return any more data. </p>
|
|
1169
|
+
* @public
|
|
1170
1170
|
*/
|
|
1171
1171
|
NextShardIterator?: string;
|
|
1172
1172
|
/**
|
|
1173
|
-
* @public
|
|
1174
1173
|
* <p>The number of milliseconds the <a>GetRecords</a> response is from the tip
|
|
1175
1174
|
* of the stream, indicating how far behind current time the consumer is. A value of zero
|
|
1176
1175
|
* indicates that record processing is caught up, and there are no new records to process
|
|
1177
1176
|
* at this moment.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
MillisBehindLatest?: number;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The list of the current shard's child shards, returned in the <code>GetRecords</code>
|
|
1183
1182
|
* API's response only when the end of the current shard is reached.</p>
|
|
1183
|
+
* @public
|
|
1184
1184
|
*/
|
|
1185
1185
|
ChildShards?: ChildShard[];
|
|
1186
1186
|
}
|
|
1187
1187
|
/**
|
|
1188
|
-
* @public
|
|
1189
1188
|
* <p>The ciphertext references a key that doesn't exist or that you don't have access
|
|
1190
1189
|
* to.</p>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
export declare class KMSAccessDeniedException extends __BaseException {
|
|
1193
1193
|
readonly name: "KMSAccessDeniedException";
|
|
@@ -1198,9 +1198,9 @@ export declare class KMSAccessDeniedException extends __BaseException {
|
|
|
1198
1198
|
constructor(opts: __ExceptionOptionType<KMSAccessDeniedException, __BaseException>);
|
|
1199
1199
|
}
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>The request was rejected because the specified customer master key (CMK) isn't
|
|
1203
1202
|
* enabled.</p>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
export declare class KMSDisabledException extends __BaseException {
|
|
1206
1206
|
readonly name: "KMSDisabledException";
|
|
@@ -1211,11 +1211,11 @@ export declare class KMSDisabledException extends __BaseException {
|
|
|
1211
1211
|
constructor(opts: __ExceptionOptionType<KMSDisabledException, __BaseException>);
|
|
1212
1212
|
}
|
|
1213
1213
|
/**
|
|
1214
|
-
* @public
|
|
1215
1214
|
* <p>The request was rejected because the state of the specified resource isn't valid for
|
|
1216
1215
|
* this request. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a
|
|
1217
1216
|
* Customer Master Key</a> in the <i>Amazon Web Services Key Management
|
|
1218
1217
|
* Service Developer Guide</i>.</p>
|
|
1218
|
+
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
export declare class KMSInvalidStateException extends __BaseException {
|
|
1221
1221
|
readonly name: "KMSInvalidStateException";
|
|
@@ -1226,9 +1226,9 @@ export declare class KMSInvalidStateException extends __BaseException {
|
|
|
1226
1226
|
constructor(opts: __ExceptionOptionType<KMSInvalidStateException, __BaseException>);
|
|
1227
1227
|
}
|
|
1228
1228
|
/**
|
|
1229
|
-
* @public
|
|
1230
1229
|
* <p>The request was rejected because the specified entity or resource can't be
|
|
1231
1230
|
* found.</p>
|
|
1231
|
+
* @public
|
|
1232
1232
|
*/
|
|
1233
1233
|
export declare class KMSNotFoundException extends __BaseException {
|
|
1234
1234
|
readonly name: "KMSNotFoundException";
|
|
@@ -1239,8 +1239,8 @@ export declare class KMSNotFoundException extends __BaseException {
|
|
|
1239
1239
|
constructor(opts: __ExceptionOptionType<KMSNotFoundException, __BaseException>);
|
|
1240
1240
|
}
|
|
1241
1241
|
/**
|
|
1242
|
-
* @public
|
|
1243
1242
|
* <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
|
|
1243
|
+
* @public
|
|
1244
1244
|
*/
|
|
1245
1245
|
export declare class KMSOptInRequired extends __BaseException {
|
|
1246
1246
|
readonly name: "KMSOptInRequired";
|
|
@@ -1251,11 +1251,11 @@ export declare class KMSOptInRequired extends __BaseException {
|
|
|
1251
1251
|
constructor(opts: __ExceptionOptionType<KMSOptInRequired, __BaseException>);
|
|
1252
1252
|
}
|
|
1253
1253
|
/**
|
|
1254
|
-
* @public
|
|
1255
1254
|
* <p>The request was denied due to request throttling. For more information about
|
|
1256
1255
|
* throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
|
|
1257
1256
|
* the <i>Amazon Web Services Key Management Service Developer
|
|
1258
1257
|
* Guide</i>.</p>
|
|
1258
|
+
* @public
|
|
1259
1259
|
*/
|
|
1260
1260
|
export declare class KMSThrottlingException extends __BaseException {
|
|
1261
1261
|
readonly name: "KMSThrottlingException";
|
|
@@ -1266,12 +1266,12 @@ export declare class KMSThrottlingException extends __BaseException {
|
|
|
1266
1266
|
constructor(opts: __ExceptionOptionType<KMSThrottlingException, __BaseException>);
|
|
1267
1267
|
}
|
|
1268
1268
|
/**
|
|
1269
|
-
* @public
|
|
1270
1269
|
* <p>The request rate for the stream is too high, or the requested data is too large for
|
|
1271
1270
|
* the available throughput. Reduce the frequency or size of your requests. For more
|
|
1272
1271
|
* information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Streams Limits</a> in the
|
|
1273
1272
|
* <i>Amazon Kinesis Data Streams Developer Guide</i>, and <a href="https://docs.aws.amazon.com/general/latest/gr/api-retries.html">Error Retries and
|
|
1274
1273
|
* Exponential Backoff in Amazon Web Services</a> in the <i>Amazon Web Services General Reference</i>.</p>
|
|
1274
|
+
* @public
|
|
1275
1275
|
*/
|
|
1276
1276
|
export declare class ProvisionedThroughputExceededException extends __BaseException {
|
|
1277
1277
|
readonly name: "ProvisionedThroughputExceededException";
|
|
@@ -1286,8 +1286,8 @@ export declare class ProvisionedThroughputExceededException extends __BaseExcept
|
|
|
1286
1286
|
*/
|
|
1287
1287
|
export interface GetResourcePolicyInput {
|
|
1288
1288
|
/**
|
|
1289
|
-
* @public
|
|
1290
1289
|
* <p>The Amazon Resource Name (ARN) of the data stream or consumer.</p>
|
|
1290
|
+
* @public
|
|
1291
1291
|
*/
|
|
1292
1292
|
ResourceARN: string | undefined;
|
|
1293
1293
|
}
|
|
@@ -1296,8 +1296,8 @@ export interface GetResourcePolicyInput {
|
|
|
1296
1296
|
*/
|
|
1297
1297
|
export interface GetResourcePolicyOutput {
|
|
1298
1298
|
/**
|
|
1299
|
-
* @public
|
|
1300
1299
|
* <p>Details of the resource policy. This is formatted as a JSON string.</p>
|
|
1300
|
+
* @public
|
|
1301
1301
|
*/
|
|
1302
1302
|
Policy: string | undefined;
|
|
1303
1303
|
}
|
|
@@ -1317,22 +1317,21 @@ export declare const ShardIteratorType: {
|
|
|
1317
1317
|
*/
|
|
1318
1318
|
export type ShardIteratorType = (typeof ShardIteratorType)[keyof typeof ShardIteratorType];
|
|
1319
1319
|
/**
|
|
1320
|
-
* @public
|
|
1321
1320
|
* <p>Represents the input for <code>GetShardIterator</code>.</p>
|
|
1321
|
+
* @public
|
|
1322
1322
|
*/
|
|
1323
1323
|
export interface GetShardIteratorInput {
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>The name of the Amazon Kinesis data stream.</p>
|
|
1326
|
+
* @public
|
|
1327
1327
|
*/
|
|
1328
1328
|
StreamName?: string;
|
|
1329
1329
|
/**
|
|
1330
|
-
* @public
|
|
1331
1330
|
* <p>The shard ID of the Kinesis Data Streams shard to get the iterator for.</p>
|
|
1331
|
+
* @public
|
|
1332
1332
|
*/
|
|
1333
1333
|
ShardId: string | undefined;
|
|
1334
1334
|
/**
|
|
1335
|
-
* @public
|
|
1336
1335
|
* <p>Determines how the shard iterator is used to start reading data records from the
|
|
1337
1336
|
* shard.</p>
|
|
1338
1337
|
* <p>The following are the valid Amazon Kinesis shard iterator types:</p>
|
|
@@ -1360,16 +1359,16 @@ export interface GetShardIteratorInput {
|
|
|
1360
1359
|
* you always read the most recent data in the shard.</p>
|
|
1361
1360
|
* </li>
|
|
1362
1361
|
* </ul>
|
|
1362
|
+
* @public
|
|
1363
1363
|
*/
|
|
1364
1364
|
ShardIteratorType: ShardIteratorType | undefined;
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>The sequence number of the data record in the shard from which to start reading. Used
|
|
1368
1367
|
* with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.</p>
|
|
1368
|
+
* @public
|
|
1369
1369
|
*/
|
|
1370
1370
|
StartingSequenceNumber?: string;
|
|
1371
1371
|
/**
|
|
1372
|
-
* @public
|
|
1373
1372
|
* <p>The time stamp of the data record from which to start reading. Used with shard
|
|
1374
1373
|
* iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in
|
|
1375
1374
|
* milliseconds. For example, <code>2016-04-04T19:58:46.480-00:00</code> or
|
|
@@ -1377,53 +1376,54 @@ export interface GetShardIteratorInput {
|
|
|
1377
1376
|
* the iterator returned is for the next (later) record. If the time stamp is older than
|
|
1378
1377
|
* the current trim horizon, the iterator returned is for the oldest untrimmed data record
|
|
1379
1378
|
* (TRIM_HORIZON).</p>
|
|
1379
|
+
* @public
|
|
1380
1380
|
*/
|
|
1381
1381
|
Timestamp?: Date;
|
|
1382
1382
|
/**
|
|
1383
|
-
* @public
|
|
1384
1383
|
* <p>The ARN of the stream.</p>
|
|
1384
|
+
* @public
|
|
1385
1385
|
*/
|
|
1386
1386
|
StreamARN?: string;
|
|
1387
1387
|
}
|
|
1388
1388
|
/**
|
|
1389
|
-
* @public
|
|
1390
1389
|
* <p>Represents the output for <code>GetShardIterator</code>.</p>
|
|
1390
|
+
* @public
|
|
1391
1391
|
*/
|
|
1392
1392
|
export interface GetShardIteratorOutput {
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>The position in the shard from which to start reading data records sequentially. A
|
|
1396
1395
|
* shard iterator specifies this position using the sequence number of a data record in a
|
|
1397
1396
|
* shard.</p>
|
|
1397
|
+
* @public
|
|
1398
1398
|
*/
|
|
1399
1399
|
ShardIterator?: string;
|
|
1400
1400
|
}
|
|
1401
1401
|
/**
|
|
1402
|
-
* @public
|
|
1403
1402
|
* <p>Represents the input for <a>IncreaseStreamRetentionPeriod</a>.</p>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
export interface IncreaseStreamRetentionPeriodInput {
|
|
1406
1406
|
/**
|
|
1407
|
-
* @public
|
|
1408
1407
|
* <p>The name of the stream to modify.</p>
|
|
1408
|
+
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
StreamName?: string;
|
|
1411
1411
|
/**
|
|
1412
|
-
* @public
|
|
1413
1412
|
* <p>The new retention period of the stream, in hours. Must be more than the current
|
|
1414
1413
|
* retention period.</p>
|
|
1414
|
+
* @public
|
|
1415
1415
|
*/
|
|
1416
1416
|
RetentionPeriodHours: number | undefined;
|
|
1417
1417
|
/**
|
|
1418
|
-
* @public
|
|
1419
1418
|
* <p>The ARN of the stream.</p>
|
|
1419
|
+
* @public
|
|
1420
1420
|
*/
|
|
1421
1421
|
StreamARN?: string;
|
|
1422
1422
|
}
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>The processing of the request failed because of an unknown error, exception, or
|
|
1426
1425
|
* failure.</p>
|
|
1426
|
+
* @public
|
|
1427
1427
|
*/
|
|
1428
1428
|
export declare class InternalFailureException extends __BaseException {
|
|
1429
1429
|
readonly name: "InternalFailureException";
|
|
@@ -1450,13 +1450,12 @@ export declare const ShardFilterType: {
|
|
|
1450
1450
|
*/
|
|
1451
1451
|
export type ShardFilterType = (typeof ShardFilterType)[keyof typeof ShardFilterType];
|
|
1452
1452
|
/**
|
|
1453
|
-
* @public
|
|
1454
1453
|
* <p>The request parameter used to filter out the response of the <code>ListShards</code>
|
|
1455
1454
|
* API.</p>
|
|
1455
|
+
* @public
|
|
1456
1456
|
*/
|
|
1457
1457
|
export interface ShardFilter {
|
|
1458
1458
|
/**
|
|
1459
|
-
* @public
|
|
1460
1459
|
* <p>The shard type specified in the <code>ShardFilter</code> parameter. This is a required
|
|
1461
1460
|
* property of the <code>ShardFilter</code> parameter.</p>
|
|
1462
1461
|
* <p>You can specify the following valid values: </p>
|
|
@@ -1497,22 +1496,23 @@ export interface ShardFilter {
|
|
|
1497
1496
|
* value.</p>
|
|
1498
1497
|
* </li>
|
|
1499
1498
|
* </ul>
|
|
1499
|
+
* @public
|
|
1500
1500
|
*/
|
|
1501
1501
|
Type: ShardFilterType | undefined;
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <p>The exclusive start <code>shardID</code> speified in the <code>ShardFilter</code>
|
|
1505
1504
|
* parameter. This property can only be used if the <code>AFTER_SHARD_ID</code> shard type
|
|
1506
1505
|
* is specified.</p>
|
|
1506
|
+
* @public
|
|
1507
1507
|
*/
|
|
1508
1508
|
ShardId?: string;
|
|
1509
1509
|
/**
|
|
1510
|
-
* @public
|
|
1511
1510
|
* <p>The timestamps specified in the <code>ShardFilter</code> parameter. A timestamp is a
|
|
1512
1511
|
* Unix epoch date with precision in milliseconds. For example,
|
|
1513
1512
|
* 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if
|
|
1514
1513
|
* <code>FROM_TIMESTAMP</code> or <code>AT_TIMESTAMP</code> shard types are
|
|
1515
1514
|
* specified.</p>
|
|
1515
|
+
* @public
|
|
1516
1516
|
*/
|
|
1517
1517
|
Timestamp?: Date;
|
|
1518
1518
|
}
|
|
@@ -1521,14 +1521,13 @@ export interface ShardFilter {
|
|
|
1521
1521
|
*/
|
|
1522
1522
|
export interface ListShardsInput {
|
|
1523
1523
|
/**
|
|
1524
|
-
* @public
|
|
1525
1524
|
* <p>The name of the data stream whose shards you want to list. </p>
|
|
1526
1525
|
* <p>You cannot specify this parameter if you specify the <code>NextToken</code>
|
|
1527
1526
|
* parameter.</p>
|
|
1527
|
+
* @public
|
|
1528
1528
|
*/
|
|
1529
1529
|
StreamName?: string;
|
|
1530
1530
|
/**
|
|
1531
|
-
* @public
|
|
1532
1531
|
* <p>When the number of shards in the data stream is greater than the default value for the
|
|
1533
1532
|
* <code>MaxResults</code> parameter, or if you explicitly specify a value for
|
|
1534
1533
|
* <code>MaxResults</code> that is less than the number of shards in the data stream,
|
|
@@ -1550,20 +1549,20 @@ export interface ListShardsInput {
|
|
|
1550
1549
|
* have 300 seconds to use that value. If you specify an expired token in a call to
|
|
1551
1550
|
* <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
|
|
1552
1551
|
* </important>
|
|
1552
|
+
* @public
|
|
1553
1553
|
*/
|
|
1554
1554
|
NextToken?: string;
|
|
1555
1555
|
/**
|
|
1556
|
-
* @public
|
|
1557
1556
|
* <p>Specify this parameter to indicate that you want to list the shards starting with the
|
|
1558
1557
|
* shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p>
|
|
1559
1558
|
* <p>If you don't specify this parameter, the default behavior is for
|
|
1560
1559
|
* <code>ListShards</code> to list the shards starting with the first one in the
|
|
1561
1560
|
* stream.</p>
|
|
1562
1561
|
* <p>You cannot specify this parameter if you specify <code>NextToken</code>.</p>
|
|
1562
|
+
* @public
|
|
1563
1563
|
*/
|
|
1564
1564
|
ExclusiveStartShardId?: string;
|
|
1565
1565
|
/**
|
|
1566
|
-
* @public
|
|
1567
1566
|
* <p>The maximum number of shards to return in a single call to <code>ListShards</code>.
|
|
1568
1567
|
* The maximum number of shards to return in a single call. The default value is 1000. If
|
|
1569
1568
|
* you specify a value greater than 1000, at most 1000 results are returned. </p>
|
|
@@ -1571,20 +1570,20 @@ export interface ListShardsInput {
|
|
|
1571
1570
|
* <code>MaxResults</code>, the response contains a <code>NextToken</code> value that
|
|
1572
1571
|
* you can use in a subsequent call to <code>ListShards</code> to list the next set of
|
|
1573
1572
|
* shards.</p>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
MaxResults?: number;
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>Specify this input parameter to distinguish data streams that have the same name. For
|
|
1579
1578
|
* example, if you create a data stream and then delete it, and you later create another
|
|
1580
1579
|
* data stream with the same name, you can use this input parameter to specify which of the
|
|
1581
1580
|
* two streams you want to list the shards for.</p>
|
|
1582
1581
|
* <p>You cannot specify this parameter if you specify the <code>NextToken</code>
|
|
1583
1582
|
* parameter.</p>
|
|
1583
|
+
* @public
|
|
1584
1584
|
*/
|
|
1585
1585
|
StreamCreationTimestamp?: Date;
|
|
1586
1586
|
/**
|
|
1587
|
-
* @public
|
|
1588
1587
|
* <p>Enables you to filter out the response of the <code>ListShards</code> API. You can
|
|
1589
1588
|
* only specify one filter at a time. </p>
|
|
1590
1589
|
* <p>If you use the <code>ShardFilter</code> parameter when invoking the ListShards API,
|
|
@@ -1603,11 +1602,12 @@ export interface ListShardsInput {
|
|
|
1603
1602
|
* specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp
|
|
1604
1603
|
* are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the
|
|
1605
1604
|
* provided timestamp to TIP are returned. </p>
|
|
1605
|
+
* @public
|
|
1606
1606
|
*/
|
|
1607
1607
|
ShardFilter?: ShardFilter;
|
|
1608
1608
|
/**
|
|
1609
|
-
* @public
|
|
1610
1609
|
* <p>The ARN of the stream.</p>
|
|
1610
|
+
* @public
|
|
1611
1611
|
*/
|
|
1612
1612
|
StreamARN?: string;
|
|
1613
1613
|
}
|
|
@@ -1616,15 +1616,14 @@ export interface ListShardsInput {
|
|
|
1616
1616
|
*/
|
|
1617
1617
|
export interface ListShardsOutput {
|
|
1618
1618
|
/**
|
|
1619
|
-
* @public
|
|
1620
1619
|
* <p>An array of JSON objects. Each object represents one shard and specifies the IDs of
|
|
1621
1620
|
* the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each
|
|
1622
1621
|
* object also contains the starting and ending hash keys and the starting and ending
|
|
1623
1622
|
* sequence numbers for the shard.</p>
|
|
1623
|
+
* @public
|
|
1624
1624
|
*/
|
|
1625
1625
|
Shards?: Shard[];
|
|
1626
1626
|
/**
|
|
1627
|
-
* @public
|
|
1628
1627
|
* <p>When the number of shards in the data stream is greater than the default value for the
|
|
1629
1628
|
* <code>MaxResults</code> parameter, or if you explicitly specify a value for
|
|
1630
1629
|
* <code>MaxResults</code> that is less than the number of shards in the data stream,
|
|
@@ -1638,6 +1637,7 @@ export interface ListShardsOutput {
|
|
|
1638
1637
|
* have 300 seconds to use that value. If you specify an expired token in a call to
|
|
1639
1638
|
* <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p>
|
|
1640
1639
|
* </important>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
NextToken?: string;
|
|
1643
1643
|
}
|
|
@@ -1646,14 +1646,13 @@ export interface ListShardsOutput {
|
|
|
1646
1646
|
*/
|
|
1647
1647
|
export interface ListStreamConsumersInput {
|
|
1648
1648
|
/**
|
|
1649
|
-
* @public
|
|
1650
1649
|
* <p>The ARN of the Kinesis data stream for which you want to list the registered
|
|
1651
1650
|
* consumers. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service
|
|
1652
1651
|
* Namespaces</a>.</p>
|
|
1652
|
+
* @public
|
|
1653
1653
|
*/
|
|
1654
1654
|
StreamARN: string | undefined;
|
|
1655
1655
|
/**
|
|
1656
|
-
* @public
|
|
1657
1656
|
* <p>When the number of consumers that are registered with the data stream is greater than
|
|
1658
1657
|
* the default value for the <code>MaxResults</code> parameter, or if you explicitly
|
|
1659
1658
|
* specify a value for <code>MaxResults</code> that is less than the number of consumers
|
|
@@ -1677,22 +1676,23 @@ export interface ListStreamConsumersInput {
|
|
|
1677
1676
|
* specify an expired token in a call to <code>ListStreamConsumers</code>, you get
|
|
1678
1677
|
* <code>ExpiredNextTokenException</code>.</p>
|
|
1679
1678
|
* </important>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
NextToken?: string;
|
|
1682
1682
|
/**
|
|
1683
|
-
* @public
|
|
1684
1683
|
* <p>The maximum number of consumers that you want a single call of
|
|
1685
1684
|
* <code>ListStreamConsumers</code> to return. The default value is 100. If you specify
|
|
1686
1685
|
* a value greater than 100, at most 100 results are returned. </p>
|
|
1686
|
+
* @public
|
|
1687
1687
|
*/
|
|
1688
1688
|
MaxResults?: number;
|
|
1689
1689
|
/**
|
|
1690
|
-
* @public
|
|
1691
1690
|
* <p>Specify this input parameter to distinguish data streams that have the same name. For
|
|
1692
1691
|
* example, if you create a data stream and then delete it, and you later create another
|
|
1693
1692
|
* data stream with the same name, you can use this input parameter to specify which of the
|
|
1694
1693
|
* two streams you want to list the consumers for. </p>
|
|
1695
1694
|
* <p>You can't specify this parameter if you specify the NextToken parameter. </p>
|
|
1695
|
+
* @public
|
|
1696
1696
|
*/
|
|
1697
1697
|
StreamCreationTimestamp?: Date;
|
|
1698
1698
|
}
|
|
@@ -1701,12 +1701,11 @@ export interface ListStreamConsumersInput {
|
|
|
1701
1701
|
*/
|
|
1702
1702
|
export interface ListStreamConsumersOutput {
|
|
1703
1703
|
/**
|
|
1704
|
-
* @public
|
|
1705
1704
|
* <p>An array of JSON objects. Each object represents one registered consumer.</p>
|
|
1705
|
+
* @public
|
|
1706
1706
|
*/
|
|
1707
1707
|
Consumers?: Consumer[];
|
|
1708
1708
|
/**
|
|
1709
|
-
* @public
|
|
1710
1709
|
* <p>When the number of consumers that are registered with the data stream is greater than
|
|
1711
1710
|
* the default value for the <code>MaxResults</code> parameter, or if you explicitly
|
|
1712
1711
|
* specify a value for <code>MaxResults</code> that is less than the number of registered
|
|
@@ -1722,190 +1721,191 @@ export interface ListStreamConsumersOutput {
|
|
|
1722
1721
|
* specify an expired token in a call to <code>ListStreamConsumers</code>, you get
|
|
1723
1722
|
* <code>ExpiredNextTokenException</code>.</p>
|
|
1724
1723
|
* </important>
|
|
1724
|
+
* @public
|
|
1725
1725
|
*/
|
|
1726
1726
|
NextToken?: string;
|
|
1727
1727
|
}
|
|
1728
1728
|
/**
|
|
1729
|
-
* @public
|
|
1730
1729
|
* <p>Represents the input for <code>ListStreams</code>.</p>
|
|
1730
|
+
* @public
|
|
1731
1731
|
*/
|
|
1732
1732
|
export interface ListStreamsInput {
|
|
1733
1733
|
/**
|
|
1734
|
-
* @public
|
|
1735
1734
|
* <p>The maximum number of streams to list. The default value is 100. If you specify a
|
|
1736
1735
|
* value greater than 100, at most 100 results are returned.</p>
|
|
1736
|
+
* @public
|
|
1737
1737
|
*/
|
|
1738
1738
|
Limit?: number;
|
|
1739
1739
|
/**
|
|
1740
|
-
* @public
|
|
1741
1740
|
* <p>The name of the stream to start the list with.</p>
|
|
1741
|
+
* @public
|
|
1742
1742
|
*/
|
|
1743
1743
|
ExclusiveStartStreamName?: string;
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p></p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
NextToken?: string;
|
|
1749
1749
|
}
|
|
1750
1750
|
/**
|
|
1751
|
-
* @public
|
|
1752
1751
|
* <p>The summary of a stream.</p>
|
|
1752
|
+
* @public
|
|
1753
1753
|
*/
|
|
1754
1754
|
export interface StreamSummary {
|
|
1755
1755
|
/**
|
|
1756
|
-
* @public
|
|
1757
1756
|
* <p>The name of a stream.</p>
|
|
1757
|
+
* @public
|
|
1758
1758
|
*/
|
|
1759
1759
|
StreamName: string | undefined;
|
|
1760
1760
|
/**
|
|
1761
|
-
* @public
|
|
1762
1761
|
* <p>The ARN of the stream.</p>
|
|
1762
|
+
* @public
|
|
1763
1763
|
*/
|
|
1764
1764
|
StreamARN: string | undefined;
|
|
1765
1765
|
/**
|
|
1766
|
-
* @public
|
|
1767
1766
|
* <p>The status of the stream.</p>
|
|
1767
|
+
* @public
|
|
1768
1768
|
*/
|
|
1769
1769
|
StreamStatus: StreamStatus | undefined;
|
|
1770
1770
|
/**
|
|
1771
|
-
* @public
|
|
1772
1771
|
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
1773
1772
|
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
|
|
1773
|
+
* @public
|
|
1774
1774
|
*/
|
|
1775
1775
|
StreamModeDetails?: StreamModeDetails;
|
|
1776
1776
|
/**
|
|
1777
|
-
* @public
|
|
1778
1777
|
* <p>The timestamp at which the stream was created.</p>
|
|
1778
|
+
* @public
|
|
1779
1779
|
*/
|
|
1780
1780
|
StreamCreationTimestamp?: Date;
|
|
1781
1781
|
}
|
|
1782
1782
|
/**
|
|
1783
|
-
* @public
|
|
1784
1783
|
* <p>Represents the output for <code>ListStreams</code>.</p>
|
|
1784
|
+
* @public
|
|
1785
1785
|
*/
|
|
1786
1786
|
export interface ListStreamsOutput {
|
|
1787
1787
|
/**
|
|
1788
|
-
* @public
|
|
1789
1788
|
* <p>The names of the streams that are associated with the Amazon Web Services account
|
|
1790
1789
|
* making the <code>ListStreams</code> request.</p>
|
|
1790
|
+
* @public
|
|
1791
1791
|
*/
|
|
1792
1792
|
StreamNames: string[] | undefined;
|
|
1793
1793
|
/**
|
|
1794
|
-
* @public
|
|
1795
1794
|
* <p>If set to <code>true</code>, there are more streams available to list.</p>
|
|
1795
|
+
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
HasMoreStreams: boolean | undefined;
|
|
1798
1798
|
/**
|
|
1799
|
-
* @public
|
|
1800
1799
|
* <p></p>
|
|
1800
|
+
* @public
|
|
1801
1801
|
*/
|
|
1802
1802
|
NextToken?: string;
|
|
1803
1803
|
/**
|
|
1804
|
-
* @public
|
|
1805
1804
|
* <p></p>
|
|
1805
|
+
* @public
|
|
1806
1806
|
*/
|
|
1807
1807
|
StreamSummaries?: StreamSummary[];
|
|
1808
1808
|
}
|
|
1809
1809
|
/**
|
|
1810
|
-
* @public
|
|
1811
1810
|
* <p>Represents the input for <code>ListTagsForStream</code>.</p>
|
|
1811
|
+
* @public
|
|
1812
1812
|
*/
|
|
1813
1813
|
export interface ListTagsForStreamInput {
|
|
1814
1814
|
/**
|
|
1815
|
-
* @public
|
|
1816
1815
|
* <p>The name of the stream.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
StreamName?: string;
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>The key to use as the starting point for the list of tags. If this parameter is set,
|
|
1822
1821
|
* <code>ListTagsForStream</code> gets all tags that occur after
|
|
1823
1822
|
* <code>ExclusiveStartTagKey</code>. </p>
|
|
1823
|
+
* @public
|
|
1824
1824
|
*/
|
|
1825
1825
|
ExclusiveStartTagKey?: string;
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>The number of tags to return. If this number is less than the total number of tags
|
|
1829
1828
|
* associated with the stream, <code>HasMoreTags</code> is set to <code>true</code>. To
|
|
1830
1829
|
* list additional tags, set <code>ExclusiveStartTagKey</code> to the last key in the
|
|
1831
1830
|
* response.</p>
|
|
1831
|
+
* @public
|
|
1832
1832
|
*/
|
|
1833
1833
|
Limit?: number;
|
|
1834
1834
|
/**
|
|
1835
|
-
* @public
|
|
1836
1835
|
* <p>The ARN of the stream.</p>
|
|
1836
|
+
* @public
|
|
1837
1837
|
*/
|
|
1838
1838
|
StreamARN?: string;
|
|
1839
1839
|
}
|
|
1840
1840
|
/**
|
|
1841
|
-
* @public
|
|
1842
1841
|
* <p>Metadata assigned to the stream, consisting of a key-value pair.</p>
|
|
1842
|
+
* @public
|
|
1843
1843
|
*/
|
|
1844
1844
|
export interface Tag {
|
|
1845
1845
|
/**
|
|
1846
|
-
* @public
|
|
1847
1846
|
* <p>A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
|
|
1848
1847
|
* Unicode letters, digits, white space, _ . / = + - % @</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
Key: string | undefined;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>An optional string, typically used to describe or define the tag. Maximum length: 256
|
|
1854
1853
|
* characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %
|
|
1855
1854
|
* @</p>
|
|
1855
|
+
* @public
|
|
1856
1856
|
*/
|
|
1857
1857
|
Value?: string;
|
|
1858
1858
|
}
|
|
1859
1859
|
/**
|
|
1860
|
-
* @public
|
|
1861
1860
|
* <p>Represents the output for <code>ListTagsForStream</code>.</p>
|
|
1861
|
+
* @public
|
|
1862
1862
|
*/
|
|
1863
1863
|
export interface ListTagsForStreamOutput {
|
|
1864
1864
|
/**
|
|
1865
|
-
* @public
|
|
1866
1865
|
* <p>A list of tags associated with <code>StreamName</code>, starting with the first tag
|
|
1867
1866
|
* after <code>ExclusiveStartTagKey</code> and up to the specified <code>Limit</code>.
|
|
1868
1867
|
* </p>
|
|
1868
|
+
* @public
|
|
1869
1869
|
*/
|
|
1870
1870
|
Tags: Tag[] | undefined;
|
|
1871
1871
|
/**
|
|
1872
|
-
* @public
|
|
1873
1872
|
* <p>If set to <code>true</code>, more tags are available. To request additional tags, set
|
|
1874
1873
|
* <code>ExclusiveStartTagKey</code> to the key of the last tag returned.</p>
|
|
1874
|
+
* @public
|
|
1875
1875
|
*/
|
|
1876
1876
|
HasMoreTags: boolean | undefined;
|
|
1877
1877
|
}
|
|
1878
1878
|
/**
|
|
1879
|
-
* @public
|
|
1880
1879
|
* <p>Represents the input for <code>MergeShards</code>.</p>
|
|
1880
|
+
* @public
|
|
1881
1881
|
*/
|
|
1882
1882
|
export interface MergeShardsInput {
|
|
1883
1883
|
/**
|
|
1884
|
-
* @public
|
|
1885
1884
|
* <p>The name of the stream for the merge.</p>
|
|
1885
|
+
* @public
|
|
1886
1886
|
*/
|
|
1887
1887
|
StreamName?: string;
|
|
1888
1888
|
/**
|
|
1889
|
-
* @public
|
|
1890
1889
|
* <p>The shard ID of the shard to combine with the adjacent shard for the merge.</p>
|
|
1890
|
+
* @public
|
|
1891
1891
|
*/
|
|
1892
1892
|
ShardToMerge: string | undefined;
|
|
1893
1893
|
/**
|
|
1894
|
-
* @public
|
|
1895
1894
|
* <p>The shard ID of the adjacent shard for the merge.</p>
|
|
1895
|
+
* @public
|
|
1896
1896
|
*/
|
|
1897
1897
|
AdjacentShardToMerge: string | undefined;
|
|
1898
1898
|
/**
|
|
1899
|
-
* @public
|
|
1900
1899
|
* <p>The ARN of the stream.</p>
|
|
1900
|
+
* @public
|
|
1901
1901
|
*/
|
|
1902
1902
|
StreamARN?: string;
|
|
1903
1903
|
}
|
|
1904
1904
|
/**
|
|
1905
|
-
* @public
|
|
1906
1905
|
* <p>Specifies that you tried to invoke this API for a data stream with the on-demand
|
|
1907
1906
|
* capacity mode. This API is only supported for data streams with the provisioned capacity
|
|
1908
1907
|
* mode. </p>
|
|
1908
|
+
* @public
|
|
1909
1909
|
*/
|
|
1910
1910
|
export declare class ValidationException extends __BaseException {
|
|
1911
1911
|
readonly name: "ValidationException";
|
|
@@ -1916,25 +1916,24 @@ export declare class ValidationException extends __BaseException {
|
|
|
1916
1916
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
1917
1917
|
}
|
|
1918
1918
|
/**
|
|
1919
|
-
* @public
|
|
1920
1919
|
* <p>Represents the input for <code>PutRecord</code>.</p>
|
|
1920
|
+
* @public
|
|
1921
1921
|
*/
|
|
1922
1922
|
export interface PutRecordInput {
|
|
1923
1923
|
/**
|
|
1924
|
-
* @public
|
|
1925
1924
|
* <p>The name of the stream to put the data record into.</p>
|
|
1925
|
+
* @public
|
|
1926
1926
|
*/
|
|
1927
1927
|
StreamName?: string;
|
|
1928
1928
|
/**
|
|
1929
|
-
* @public
|
|
1930
1929
|
* <p>The data blob to put into the record, which is base64-encoded when the blob is
|
|
1931
1930
|
* serialized. When the data blob (the payload before base64-encoding) is added to the
|
|
1932
1931
|
* partition key size, the total size must not exceed the maximum record size (1
|
|
1933
1932
|
* MiB).</p>
|
|
1933
|
+
* @public
|
|
1934
1934
|
*/
|
|
1935
1935
|
Data: Uint8Array | undefined;
|
|
1936
1936
|
/**
|
|
1937
|
-
* @public
|
|
1938
1937
|
* <p>Determines which shard in the stream the data record is assigned to. Partition keys
|
|
1939
1938
|
* are Unicode strings with a maximum length limit of 256 characters for each key. Amazon
|
|
1940
1939
|
* Kinesis Data Streams uses the partition key as input to a hash function that maps the
|
|
@@ -1942,48 +1941,48 @@ export interface PutRecordInput {
|
|
|
1942
1941
|
* function is used to map partition keys to 128-bit integer values and to map associated
|
|
1943
1942
|
* data records to shards. As a result of this hashing mechanism, all data records with the
|
|
1944
1943
|
* same partition key map to the same shard within the stream.</p>
|
|
1944
|
+
* @public
|
|
1945
1945
|
*/
|
|
1946
1946
|
PartitionKey: string | undefined;
|
|
1947
1947
|
/**
|
|
1948
|
-
* @public
|
|
1949
1948
|
* <p>The hash value used to explicitly determine the shard the data record is assigned to
|
|
1950
1949
|
* by overriding the partition key hash.</p>
|
|
1950
|
+
* @public
|
|
1951
1951
|
*/
|
|
1952
1952
|
ExplicitHashKey?: string;
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>Guarantees strictly increasing sequence numbers, for puts from the same client and to
|
|
1956
1955
|
* the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of record
|
|
1957
1956
|
* <i>n</i> to the sequence number of record <i>n-1</i> (as
|
|
1958
1957
|
* returned in the result when putting record <i>n-1</i>). If this parameter
|
|
1959
1958
|
* is not set, records are coarsely ordered based on arrival time.</p>
|
|
1959
|
+
* @public
|
|
1960
1960
|
*/
|
|
1961
1961
|
SequenceNumberForOrdering?: string;
|
|
1962
1962
|
/**
|
|
1963
|
-
* @public
|
|
1964
1963
|
* <p>The ARN of the stream.</p>
|
|
1964
|
+
* @public
|
|
1965
1965
|
*/
|
|
1966
1966
|
StreamARN?: string;
|
|
1967
1967
|
}
|
|
1968
1968
|
/**
|
|
1969
|
-
* @public
|
|
1970
1969
|
* <p>Represents the output for <code>PutRecord</code>.</p>
|
|
1970
|
+
* @public
|
|
1971
1971
|
*/
|
|
1972
1972
|
export interface PutRecordOutput {
|
|
1973
1973
|
/**
|
|
1974
|
-
* @public
|
|
1975
1974
|
* <p>The shard ID of the shard where the data record was placed.</p>
|
|
1975
|
+
* @public
|
|
1976
1976
|
*/
|
|
1977
1977
|
ShardId: string | undefined;
|
|
1978
1978
|
/**
|
|
1979
|
-
* @public
|
|
1980
1979
|
* <p>The sequence number identifier that was assigned to the put data record. The sequence
|
|
1981
1980
|
* number for the record is unique across all records in the stream. A sequence number is
|
|
1982
1981
|
* the identifier associated with every record put into the stream.</p>
|
|
1982
|
+
* @public
|
|
1983
1983
|
*/
|
|
1984
1984
|
SequenceNumber: string | undefined;
|
|
1985
1985
|
/**
|
|
1986
|
-
* @public
|
|
1987
1986
|
* <p>The encryption type to use on the record. This parameter can be one of the following
|
|
1988
1987
|
* values:</p>
|
|
1989
1988
|
* <ul>
|
|
@@ -1997,30 +1996,30 @@ export interface PutRecordOutput {
|
|
|
1997
1996
|
* using a customer-managed Amazon Web Services KMS key.</p>
|
|
1998
1997
|
* </li>
|
|
1999
1998
|
* </ul>
|
|
1999
|
+
* @public
|
|
2000
2000
|
*/
|
|
2001
2001
|
EncryptionType?: EncryptionType;
|
|
2002
2002
|
}
|
|
2003
2003
|
/**
|
|
2004
|
-
* @public
|
|
2005
2004
|
* <p>Represents the output for <code>PutRecords</code>.</p>
|
|
2005
|
+
* @public
|
|
2006
2006
|
*/
|
|
2007
2007
|
export interface PutRecordsRequestEntry {
|
|
2008
2008
|
/**
|
|
2009
|
-
* @public
|
|
2010
2009
|
* <p>The data blob to put into the record, which is base64-encoded when the blob is
|
|
2011
2010
|
* serialized. When the data blob (the payload before base64-encoding) is added to the
|
|
2012
2011
|
* partition key size, the total size must not exceed the maximum record size (1
|
|
2013
2012
|
* MiB).</p>
|
|
2013
|
+
* @public
|
|
2014
2014
|
*/
|
|
2015
2015
|
Data: Uint8Array | undefined;
|
|
2016
2016
|
/**
|
|
2017
|
-
* @public
|
|
2018
2017
|
* <p>The hash value used to determine explicitly the shard that the data record is assigned
|
|
2019
2018
|
* to by overriding the partition key hash.</p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
ExplicitHashKey?: string;
|
|
2022
2022
|
/**
|
|
2023
|
-
* @public
|
|
2024
2023
|
* <p>Determines which shard in the stream the data record is assigned to. Partition keys
|
|
2025
2024
|
* are Unicode strings with a maximum length limit of 256 characters for each key. Amazon
|
|
2026
2025
|
* Kinesis Data Streams uses the partition key as input to a hash function that maps the
|
|
@@ -2028,87 +2027,87 @@ export interface PutRecordsRequestEntry {
|
|
|
2028
2027
|
* function is used to map partition keys to 128-bit integer values and to map associated
|
|
2029
2028
|
* data records to shards. As a result of this hashing mechanism, all data records with the
|
|
2030
2029
|
* same partition key map to the same shard within the stream.</p>
|
|
2030
|
+
* @public
|
|
2031
2031
|
*/
|
|
2032
2032
|
PartitionKey: string | undefined;
|
|
2033
2033
|
}
|
|
2034
2034
|
/**
|
|
2035
|
-
* @public
|
|
2036
2035
|
* <p>A <code>PutRecords</code> request.</p>
|
|
2036
|
+
* @public
|
|
2037
2037
|
*/
|
|
2038
2038
|
export interface PutRecordsInput {
|
|
2039
2039
|
/**
|
|
2040
|
-
* @public
|
|
2041
2040
|
* <p>The records associated with the request.</p>
|
|
2041
|
+
* @public
|
|
2042
2042
|
*/
|
|
2043
2043
|
Records: PutRecordsRequestEntry[] | undefined;
|
|
2044
2044
|
/**
|
|
2045
|
-
* @public
|
|
2046
2045
|
* <p>The stream name associated with the request.</p>
|
|
2046
|
+
* @public
|
|
2047
2047
|
*/
|
|
2048
2048
|
StreamName?: string;
|
|
2049
2049
|
/**
|
|
2050
|
-
* @public
|
|
2051
2050
|
* <p>The ARN of the stream.</p>
|
|
2051
|
+
* @public
|
|
2052
2052
|
*/
|
|
2053
2053
|
StreamARN?: string;
|
|
2054
2054
|
}
|
|
2055
2055
|
/**
|
|
2056
|
-
* @public
|
|
2057
2056
|
* <p>Represents the result of an individual record from a <code>PutRecords</code> request.
|
|
2058
2057
|
* A record that is successfully added to a stream includes <code>SequenceNumber</code> and
|
|
2059
2058
|
* <code>ShardId</code> in the result. A record that fails to be added to the stream
|
|
2060
2059
|
* includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result.</p>
|
|
2060
|
+
* @public
|
|
2061
2061
|
*/
|
|
2062
2062
|
export interface PutRecordsResultEntry {
|
|
2063
2063
|
/**
|
|
2064
|
-
* @public
|
|
2065
2064
|
* <p>The sequence number for an individual record result.</p>
|
|
2065
|
+
* @public
|
|
2066
2066
|
*/
|
|
2067
2067
|
SequenceNumber?: string;
|
|
2068
2068
|
/**
|
|
2069
|
-
* @public
|
|
2070
2069
|
* <p>The shard ID for an individual record result.</p>
|
|
2070
|
+
* @public
|
|
2071
2071
|
*/
|
|
2072
2072
|
ShardId?: string;
|
|
2073
2073
|
/**
|
|
2074
|
-
* @public
|
|
2075
2074
|
* <p>The error code for an individual record result. <code>ErrorCodes</code> can be either
|
|
2076
2075
|
* <code>ProvisionedThroughputExceededException</code> or
|
|
2077
2076
|
* <code>InternalFailure</code>.</p>
|
|
2077
|
+
* @public
|
|
2078
2078
|
*/
|
|
2079
2079
|
ErrorCode?: string;
|
|
2080
2080
|
/**
|
|
2081
|
-
* @public
|
|
2082
2081
|
* <p>The error message for an individual record result. An <code>ErrorCode</code> value of
|
|
2083
2082
|
* <code>ProvisionedThroughputExceededException</code> has an error message that
|
|
2084
2083
|
* includes the account ID, stream name, and shard ID. An <code>ErrorCode</code> value of
|
|
2085
2084
|
* <code>InternalFailure</code> has the error message <code>"Internal Service
|
|
2086
2085
|
* Failure"</code>.</p>
|
|
2086
|
+
* @public
|
|
2087
2087
|
*/
|
|
2088
2088
|
ErrorMessage?: string;
|
|
2089
2089
|
}
|
|
2090
2090
|
/**
|
|
2091
|
-
* @public
|
|
2092
2091
|
* <p>
|
|
2093
2092
|
* <code>PutRecords</code> results.</p>
|
|
2093
|
+
* @public
|
|
2094
2094
|
*/
|
|
2095
2095
|
export interface PutRecordsOutput {
|
|
2096
2096
|
/**
|
|
2097
|
-
* @public
|
|
2098
2097
|
* <p>The number of unsuccessfully processed records in a <code>PutRecords</code>
|
|
2099
2098
|
* request.</p>
|
|
2099
|
+
* @public
|
|
2100
2100
|
*/
|
|
2101
2101
|
FailedRecordCount?: number;
|
|
2102
2102
|
/**
|
|
2103
|
-
* @public
|
|
2104
2103
|
* <p>An array of successfully and unsuccessfully processed record results. A record that is
|
|
2105
2104
|
* successfully added to a stream includes <code>SequenceNumber</code> and
|
|
2106
2105
|
* <code>ShardId</code> in the result. A record that fails to be added to a stream
|
|
2107
2106
|
* includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result.</p>
|
|
2107
|
+
* @public
|
|
2108
2108
|
*/
|
|
2109
2109
|
Records: PutRecordsResultEntry[] | undefined;
|
|
2110
2110
|
/**
|
|
2111
|
-
* @public
|
|
2112
2111
|
* <p>The encryption type used on the records. This parameter can be one of the following
|
|
2113
2112
|
* values:</p>
|
|
2114
2113
|
* <ul>
|
|
@@ -2122,6 +2121,7 @@ export interface PutRecordsOutput {
|
|
|
2122
2121
|
* customer-managed Amazon Web Services KMS key.</p>
|
|
2123
2122
|
* </li>
|
|
2124
2123
|
* </ul>
|
|
2124
|
+
* @public
|
|
2125
2125
|
*/
|
|
2126
2126
|
EncryptionType?: EncryptionType;
|
|
2127
2127
|
}
|
|
@@ -2130,13 +2130,13 @@ export interface PutRecordsOutput {
|
|
|
2130
2130
|
*/
|
|
2131
2131
|
export interface PutResourcePolicyInput {
|
|
2132
2132
|
/**
|
|
2133
|
-
* @public
|
|
2134
2133
|
* <p>The Amazon Resource Name (ARN) of the data stream or consumer.</p>
|
|
2134
|
+
* @public
|
|
2135
2135
|
*/
|
|
2136
2136
|
ResourceARN: string | undefined;
|
|
2137
2137
|
/**
|
|
2138
|
-
* @public
|
|
2139
2138
|
* <p>Details of the resource policy. It must include the identity of the principal and the actions allowed on this resource. This is formatted as a JSON string.</p>
|
|
2139
|
+
* @public
|
|
2140
2140
|
*/
|
|
2141
2141
|
Policy: string | undefined;
|
|
2142
2142
|
}
|
|
@@ -2145,16 +2145,16 @@ export interface PutResourcePolicyInput {
|
|
|
2145
2145
|
*/
|
|
2146
2146
|
export interface RegisterStreamConsumerInput {
|
|
2147
2147
|
/**
|
|
2148
|
-
* @public
|
|
2149
2148
|
* <p>The ARN of the Kinesis data stream that you want to register the consumer with. For
|
|
2150
2149
|
* more info, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service
|
|
2151
2150
|
* Namespaces</a>.</p>
|
|
2151
|
+
* @public
|
|
2152
2152
|
*/
|
|
2153
2153
|
StreamARN: string | undefined;
|
|
2154
2154
|
/**
|
|
2155
|
-
* @public
|
|
2156
2155
|
* <p>For a given Kinesis data stream, each consumer must have a unique name. However,
|
|
2157
2156
|
* consumer names don't have to be unique across data streams.</p>
|
|
2157
|
+
* @public
|
|
2158
2158
|
*/
|
|
2159
2159
|
ConsumerName: string | undefined;
|
|
2160
2160
|
}
|
|
@@ -2163,50 +2163,49 @@ export interface RegisterStreamConsumerInput {
|
|
|
2163
2163
|
*/
|
|
2164
2164
|
export interface RegisterStreamConsumerOutput {
|
|
2165
2165
|
/**
|
|
2166
|
-
* @public
|
|
2167
2166
|
* <p>An object that represents the details of the consumer you registered. When you
|
|
2168
2167
|
* register a consumer, it gets an ARN that is generated by Kinesis Data Streams.</p>
|
|
2168
|
+
* @public
|
|
2169
2169
|
*/
|
|
2170
2170
|
Consumer: Consumer | undefined;
|
|
2171
2171
|
}
|
|
2172
2172
|
/**
|
|
2173
|
-
* @public
|
|
2174
2173
|
* <p>Represents the input for <code>RemoveTagsFromStream</code>.</p>
|
|
2174
|
+
* @public
|
|
2175
2175
|
*/
|
|
2176
2176
|
export interface RemoveTagsFromStreamInput {
|
|
2177
2177
|
/**
|
|
2178
|
-
* @public
|
|
2179
2178
|
* <p>The name of the stream.</p>
|
|
2179
|
+
* @public
|
|
2180
2180
|
*/
|
|
2181
2181
|
StreamName?: string;
|
|
2182
2182
|
/**
|
|
2183
|
-
* @public
|
|
2184
2183
|
* <p>A list of tag keys. Each corresponding tag is removed from the stream.</p>
|
|
2184
|
+
* @public
|
|
2185
2185
|
*/
|
|
2186
2186
|
TagKeys: string[] | undefined;
|
|
2187
2187
|
/**
|
|
2188
|
-
* @public
|
|
2189
2188
|
* <p>The ARN of the stream.</p>
|
|
2189
|
+
* @public
|
|
2190
2190
|
*/
|
|
2191
2191
|
StreamARN?: string;
|
|
2192
2192
|
}
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>Represents the input for <code>SplitShard</code>.</p>
|
|
2195
|
+
* @public
|
|
2196
2196
|
*/
|
|
2197
2197
|
export interface SplitShardInput {
|
|
2198
2198
|
/**
|
|
2199
|
-
* @public
|
|
2200
2199
|
* <p>The name of the stream for the shard split.</p>
|
|
2200
|
+
* @public
|
|
2201
2201
|
*/
|
|
2202
2202
|
StreamName?: string;
|
|
2203
2203
|
/**
|
|
2204
|
-
* @public
|
|
2205
2204
|
* <p>The shard ID of the shard to split.</p>
|
|
2205
|
+
* @public
|
|
2206
2206
|
*/
|
|
2207
2207
|
ShardToSplit: string | undefined;
|
|
2208
2208
|
/**
|
|
2209
|
-
* @public
|
|
2210
2209
|
* <p>A hash key value for the starting hash key of one of the child shards created by the
|
|
2211
2210
|
* split. The hash key range for a given shard constitutes a set of ordered contiguous
|
|
2212
2211
|
* positive integers. The value for <code>NewStartingHashKey</code> must be in the range of
|
|
@@ -2214,11 +2213,12 @@ export interface SplitShardInput {
|
|
|
2214
2213
|
* value and all higher hash key values in hash key range are distributed to one of the
|
|
2215
2214
|
* child shards. All the lower hash key values in the range are distributed to the other
|
|
2216
2215
|
* child shard.</p>
|
|
2216
|
+
* @public
|
|
2217
2217
|
*/
|
|
2218
2218
|
NewStartingHashKey: string | undefined;
|
|
2219
2219
|
/**
|
|
2220
|
-
* @public
|
|
2221
2220
|
* <p>The ARN of the stream.</p>
|
|
2221
|
+
* @public
|
|
2222
2222
|
*/
|
|
2223
2223
|
StreamARN?: string;
|
|
2224
2224
|
}
|
|
@@ -2227,17 +2227,16 @@ export interface SplitShardInput {
|
|
|
2227
2227
|
*/
|
|
2228
2228
|
export interface StartStreamEncryptionInput {
|
|
2229
2229
|
/**
|
|
2230
|
-
* @public
|
|
2231
2230
|
* <p>The name of the stream for which to start encrypting records.</p>
|
|
2231
|
+
* @public
|
|
2232
2232
|
*/
|
|
2233
2233
|
StreamName?: string;
|
|
2234
2234
|
/**
|
|
2235
|
-
* @public
|
|
2236
2235
|
* <p>The encryption type to use. The only valid value is <code>KMS</code>.</p>
|
|
2236
|
+
* @public
|
|
2237
2237
|
*/
|
|
2238
2238
|
EncryptionType: EncryptionType | undefined;
|
|
2239
2239
|
/**
|
|
2240
|
-
* @public
|
|
2241
2240
|
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
2242
2241
|
* This value can be a globally unique identifier, a fully specified Amazon Resource Name
|
|
2243
2242
|
* (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
|
|
@@ -2269,11 +2268,12 @@ export interface StartStreamEncryptionInput {
|
|
|
2269
2268
|
* </p>
|
|
2270
2269
|
* </li>
|
|
2271
2270
|
* </ul>
|
|
2271
|
+
* @public
|
|
2272
2272
|
*/
|
|
2273
2273
|
KeyId: string | undefined;
|
|
2274
2274
|
/**
|
|
2275
|
-
* @public
|
|
2276
2275
|
* <p>The ARN of the stream.</p>
|
|
2276
|
+
* @public
|
|
2277
2277
|
*/
|
|
2278
2278
|
StreamARN?: string;
|
|
2279
2279
|
}
|
|
@@ -2282,17 +2282,16 @@ export interface StartStreamEncryptionInput {
|
|
|
2282
2282
|
*/
|
|
2283
2283
|
export interface StopStreamEncryptionInput {
|
|
2284
2284
|
/**
|
|
2285
|
-
* @public
|
|
2286
2285
|
* <p>The name of the stream on which to stop encrypting records.</p>
|
|
2286
|
+
* @public
|
|
2287
2287
|
*/
|
|
2288
2288
|
StreamName?: string;
|
|
2289
2289
|
/**
|
|
2290
|
-
* @public
|
|
2291
2290
|
* <p>The encryption type. The only valid value is <code>KMS</code>.</p>
|
|
2291
|
+
* @public
|
|
2292
2292
|
*/
|
|
2293
2293
|
EncryptionType: EncryptionType | undefined;
|
|
2294
2294
|
/**
|
|
2295
|
-
* @public
|
|
2296
2295
|
* <p>The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
|
2297
2296
|
* This value can be a globally unique identifier, a fully specified Amazon Resource Name
|
|
2298
2297
|
* (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also
|
|
@@ -2324,21 +2323,21 @@ export interface StopStreamEncryptionInput {
|
|
|
2324
2323
|
* </p>
|
|
2325
2324
|
* </li>
|
|
2326
2325
|
* </ul>
|
|
2326
|
+
* @public
|
|
2327
2327
|
*/
|
|
2328
2328
|
KeyId: string | undefined;
|
|
2329
2329
|
/**
|
|
2330
|
-
* @public
|
|
2331
2330
|
* <p>The ARN of the stream.</p>
|
|
2331
|
+
* @public
|
|
2332
2332
|
*/
|
|
2333
2333
|
StreamARN?: string;
|
|
2334
2334
|
}
|
|
2335
2335
|
/**
|
|
2336
|
-
* @public
|
|
2337
2336
|
* <p>The starting position in the data stream from which to start streaming.</p>
|
|
2337
|
+
* @public
|
|
2338
2338
|
*/
|
|
2339
2339
|
export interface StartingPosition {
|
|
2340
2340
|
/**
|
|
2341
|
-
* @public
|
|
2342
2341
|
* <p>You can set the starting position to one of the following values:</p>
|
|
2343
2342
|
* <p>
|
|
2344
2343
|
* <code>AT_SEQUENCE_NUMBER</code>: Start streaming from the position denoted by the
|
|
@@ -2355,17 +2354,17 @@ export interface StartingPosition {
|
|
|
2355
2354
|
* <p>
|
|
2356
2355
|
* <code>LATEST</code>: Start streaming just after the most recent record in the shard,
|
|
2357
2356
|
* so that you always read the most recent data in the shard.</p>
|
|
2357
|
+
* @public
|
|
2358
2358
|
*/
|
|
2359
2359
|
Type: ShardIteratorType | undefined;
|
|
2360
2360
|
/**
|
|
2361
|
-
* @public
|
|
2362
2361
|
* <p>The sequence number of the data record in the shard from which to start streaming. To
|
|
2363
2362
|
* specify a sequence number, set <code>StartingPosition</code> to
|
|
2364
2363
|
* <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>.</p>
|
|
2364
|
+
* @public
|
|
2365
2365
|
*/
|
|
2366
2366
|
SequenceNumber?: string;
|
|
2367
2367
|
/**
|
|
2368
|
-
* @public
|
|
2369
2368
|
* <p>The time stamp of the data record from which to start reading. To specify a time
|
|
2370
2369
|
* stamp, set <code>StartingPosition</code> to <code>Type AT_TIMESTAMP</code>. A time stamp
|
|
2371
2370
|
* is the Unix epoch date with precision in milliseconds. For example,
|
|
@@ -2373,6 +2372,7 @@ export interface StartingPosition {
|
|
|
2373
2372
|
* record with this exact time stamp does not exist, records will be streamed from the next
|
|
2374
2373
|
* (later) record. If the time stamp is older than the current trim horizon, records will
|
|
2375
2374
|
* be streamed from the oldest untrimmed data record (<code>TRIM_HORIZON</code>).</p>
|
|
2375
|
+
* @public
|
|
2376
2376
|
*/
|
|
2377
2377
|
Timestamp?: Date;
|
|
2378
2378
|
}
|
|
@@ -2381,59 +2381,59 @@ export interface StartingPosition {
|
|
|
2381
2381
|
*/
|
|
2382
2382
|
export interface SubscribeToShardInput {
|
|
2383
2383
|
/**
|
|
2384
|
-
* @public
|
|
2385
2384
|
* <p>For this parameter, use the value you obtained when you called <a>RegisterStreamConsumer</a>.</p>
|
|
2385
|
+
* @public
|
|
2386
2386
|
*/
|
|
2387
2387
|
ConsumerARN: string | undefined;
|
|
2388
2388
|
/**
|
|
2389
|
-
* @public
|
|
2390
2389
|
* <p>The ID of the shard you want to subscribe to. To see a list of all the shards for a
|
|
2391
2390
|
* given stream, use <a>ListShards</a>.</p>
|
|
2391
|
+
* @public
|
|
2392
2392
|
*/
|
|
2393
2393
|
ShardId: string | undefined;
|
|
2394
2394
|
/**
|
|
2395
|
-
* @public
|
|
2396
2395
|
* <p>The starting position in the data stream from which to start streaming.</p>
|
|
2396
|
+
* @public
|
|
2397
2397
|
*/
|
|
2398
2398
|
StartingPosition: StartingPosition | undefined;
|
|
2399
2399
|
}
|
|
2400
2400
|
/**
|
|
2401
|
-
* @public
|
|
2402
2401
|
* <p>After you call <a>SubscribeToShard</a>, Kinesis Data Streams sends events
|
|
2403
2402
|
* of this type over an HTTP/2 connection to your consumer.</p>
|
|
2403
|
+
* @public
|
|
2404
2404
|
*/
|
|
2405
2405
|
export interface SubscribeToShardEvent {
|
|
2406
2406
|
/**
|
|
2407
|
-
* @public
|
|
2408
2407
|
* <p></p>
|
|
2408
|
+
* @public
|
|
2409
2409
|
*/
|
|
2410
2410
|
Records: _Record[] | undefined;
|
|
2411
2411
|
/**
|
|
2412
|
-
* @public
|
|
2413
2412
|
* <p>Use this as <code>SequenceNumber</code> in the next call to <a>SubscribeToShard</a>, with <code>StartingPosition</code> set to
|
|
2414
2413
|
* <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>. Use
|
|
2415
2414
|
* <code>ContinuationSequenceNumber</code> for checkpointing because it captures your
|
|
2416
2415
|
* shard progress even when no data is written to the shard.</p>
|
|
2416
|
+
* @public
|
|
2417
2417
|
*/
|
|
2418
2418
|
ContinuationSequenceNumber: string | undefined;
|
|
2419
2419
|
/**
|
|
2420
|
-
* @public
|
|
2421
2420
|
* <p>The number of milliseconds the read records are from the tip of the stream, indicating
|
|
2422
2421
|
* how far behind current time the consumer is. A value of zero indicates that record
|
|
2423
2422
|
* processing is caught up, and there are no new records to process at this moment.</p>
|
|
2423
|
+
* @public
|
|
2424
2424
|
*/
|
|
2425
2425
|
MillisBehindLatest: number | undefined;
|
|
2426
2426
|
/**
|
|
2427
|
-
* @public
|
|
2428
2427
|
* <p>The list of the child shards of the current shard, returned only at the end of the
|
|
2429
2428
|
* current shard.</p>
|
|
2429
|
+
* @public
|
|
2430
2430
|
*/
|
|
2431
2431
|
ChildShards?: ChildShard[];
|
|
2432
2432
|
}
|
|
2433
2433
|
/**
|
|
2434
|
-
* @public
|
|
2435
2434
|
* <p>This is a tagged union for all of the types of events an enhanced fan-out consumer can
|
|
2436
2435
|
* receive over HTTP/2 after a call to <a>SubscribeToShard</a>.</p>
|
|
2436
|
+
* @public
|
|
2437
2437
|
*/
|
|
2438
2438
|
export type SubscribeToShardEventStream = SubscribeToShardEventStream.InternalFailureExceptionMember | SubscribeToShardEventStream.KMSAccessDeniedExceptionMember | SubscribeToShardEventStream.KMSDisabledExceptionMember | SubscribeToShardEventStream.KMSInvalidStateExceptionMember | SubscribeToShardEventStream.KMSNotFoundExceptionMember | SubscribeToShardEventStream.KMSOptInRequiredMember | SubscribeToShardEventStream.KMSThrottlingExceptionMember | SubscribeToShardEventStream.ResourceInUseExceptionMember | SubscribeToShardEventStream.ResourceNotFoundExceptionMember | SubscribeToShardEventStream.SubscribeToShardEventMember | SubscribeToShardEventStream.$UnknownMember;
|
|
2439
2439
|
/**
|
|
@@ -2441,10 +2441,10 @@ export type SubscribeToShardEventStream = SubscribeToShardEventStream.InternalFa
|
|
|
2441
2441
|
*/
|
|
2442
2442
|
export declare namespace SubscribeToShardEventStream {
|
|
2443
2443
|
/**
|
|
2444
|
-
* @public
|
|
2445
2444
|
* <p>After you call <a>SubscribeToShard</a>, Kinesis Data Streams sends events
|
|
2446
2445
|
* of this type to your consumer. For an example of how to handle these events, see <a href="/streams/latest/dev/building-enhanced-consumers-api.html">Enhanced Fan-Out
|
|
2447
2446
|
* Using the Kinesis Data Streams API</a>.</p>
|
|
2447
|
+
* @public
|
|
2448
2448
|
*/
|
|
2449
2449
|
interface SubscribeToShardEventMember {
|
|
2450
2450
|
SubscribeToShardEvent: SubscribeToShardEvent;
|
|
@@ -2460,9 +2460,9 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2460
2460
|
$unknown?: never;
|
|
2461
2461
|
}
|
|
2462
2462
|
/**
|
|
2463
|
-
* @public
|
|
2464
2463
|
* <p>The requested resource could not be found. The stream might not be specified
|
|
2465
2464
|
* correctly.</p>
|
|
2465
|
+
* @public
|
|
2466
2466
|
*/
|
|
2467
2467
|
interface ResourceNotFoundExceptionMember {
|
|
2468
2468
|
SubscribeToShardEvent?: never;
|
|
@@ -2478,9 +2478,9 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2478
2478
|
$unknown?: never;
|
|
2479
2479
|
}
|
|
2480
2480
|
/**
|
|
2481
|
-
* @public
|
|
2482
2481
|
* <p>The resource is not available for this operation. For successful operation, the
|
|
2483
2482
|
* resource must be in the <code>ACTIVE</code> state.</p>
|
|
2483
|
+
* @public
|
|
2484
2484
|
*/
|
|
2485
2485
|
interface ResourceInUseExceptionMember {
|
|
2486
2486
|
SubscribeToShardEvent?: never;
|
|
@@ -2496,9 +2496,9 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2496
2496
|
$unknown?: never;
|
|
2497
2497
|
}
|
|
2498
2498
|
/**
|
|
2499
|
-
* @public
|
|
2500
2499
|
* <p>The request was rejected because the specified customer master key (CMK) isn't
|
|
2501
2500
|
* enabled.</p>
|
|
2501
|
+
* @public
|
|
2502
2502
|
*/
|
|
2503
2503
|
interface KMSDisabledExceptionMember {
|
|
2504
2504
|
SubscribeToShardEvent?: never;
|
|
@@ -2514,11 +2514,11 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2514
2514
|
$unknown?: never;
|
|
2515
2515
|
}
|
|
2516
2516
|
/**
|
|
2517
|
-
* @public
|
|
2518
2517
|
* <p>The request was rejected because the state of the specified resource isn't valid for
|
|
2519
2518
|
* this request. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">How Key State Affects Use of a
|
|
2520
2519
|
* Customer Master Key</a> in the <i>Amazon Web Services Key Management
|
|
2521
2520
|
* Service Developer Guide</i>.</p>
|
|
2521
|
+
* @public
|
|
2522
2522
|
*/
|
|
2523
2523
|
interface KMSInvalidStateExceptionMember {
|
|
2524
2524
|
SubscribeToShardEvent?: never;
|
|
@@ -2534,9 +2534,9 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2534
2534
|
$unknown?: never;
|
|
2535
2535
|
}
|
|
2536
2536
|
/**
|
|
2537
|
-
* @public
|
|
2538
2537
|
* <p>The ciphertext references a key that doesn't exist or that you don't have access
|
|
2539
2538
|
* to.</p>
|
|
2539
|
+
* @public
|
|
2540
2540
|
*/
|
|
2541
2541
|
interface KMSAccessDeniedExceptionMember {
|
|
2542
2542
|
SubscribeToShardEvent?: never;
|
|
@@ -2552,9 +2552,9 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2552
2552
|
$unknown?: never;
|
|
2553
2553
|
}
|
|
2554
2554
|
/**
|
|
2555
|
-
* @public
|
|
2556
2555
|
* <p>The request was rejected because the specified entity or resource can't be
|
|
2557
2556
|
* found.</p>
|
|
2557
|
+
* @public
|
|
2558
2558
|
*/
|
|
2559
2559
|
interface KMSNotFoundExceptionMember {
|
|
2560
2560
|
SubscribeToShardEvent?: never;
|
|
@@ -2570,8 +2570,8 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2570
2570
|
$unknown?: never;
|
|
2571
2571
|
}
|
|
2572
2572
|
/**
|
|
2573
|
-
* @public
|
|
2574
2573
|
* <p>The Amazon Web Services access key ID needs a subscription for the service.</p>
|
|
2574
|
+
* @public
|
|
2575
2575
|
*/
|
|
2576
2576
|
interface KMSOptInRequiredMember {
|
|
2577
2577
|
SubscribeToShardEvent?: never;
|
|
@@ -2587,11 +2587,11 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2587
2587
|
$unknown?: never;
|
|
2588
2588
|
}
|
|
2589
2589
|
/**
|
|
2590
|
-
* @public
|
|
2591
2590
|
* <p>The request was denied due to request throttling. For more information about
|
|
2592
2591
|
* throttling, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second">Limits</a> in
|
|
2593
2592
|
* the <i>Amazon Web Services Key Management Service Developer
|
|
2594
2593
|
* Guide</i>.</p>
|
|
2594
|
+
* @public
|
|
2595
2595
|
*/
|
|
2596
2596
|
interface KMSThrottlingExceptionMember {
|
|
2597
2597
|
SubscribeToShardEvent?: never;
|
|
@@ -2607,9 +2607,9 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2607
2607
|
$unknown?: never;
|
|
2608
2608
|
}
|
|
2609
2609
|
/**
|
|
2610
|
-
* @public
|
|
2611
2610
|
* <p>The processing of the request failed because of an unknown error, exception, or
|
|
2612
2611
|
* failure.</p>
|
|
2612
|
+
* @public
|
|
2613
2613
|
*/
|
|
2614
2614
|
interface InternalFailureExceptionMember {
|
|
2615
2615
|
SubscribeToShardEvent?: never;
|
|
@@ -2660,8 +2660,8 @@ export declare namespace SubscribeToShardEventStream {
|
|
|
2660
2660
|
*/
|
|
2661
2661
|
export interface SubscribeToShardOutput {
|
|
2662
2662
|
/**
|
|
2663
|
-
* @public
|
|
2664
2663
|
* <p>The event stream that your consumer can use to read records from the shard.</p>
|
|
2664
|
+
* @public
|
|
2665
2665
|
*/
|
|
2666
2666
|
EventStream: AsyncIterable<SubscribeToShardEventStream> | undefined;
|
|
2667
2667
|
}
|
|
@@ -2681,12 +2681,11 @@ export type ScalingType = (typeof ScalingType)[keyof typeof ScalingType];
|
|
|
2681
2681
|
*/
|
|
2682
2682
|
export interface UpdateShardCountInput {
|
|
2683
2683
|
/**
|
|
2684
|
-
* @public
|
|
2685
2684
|
* <p>The name of the stream.</p>
|
|
2685
|
+
* @public
|
|
2686
2686
|
*/
|
|
2687
2687
|
StreamName?: string;
|
|
2688
2688
|
/**
|
|
2689
|
-
* @public
|
|
2690
2689
|
* <p>The new number of shards. This value has the following default limits. By default, you
|
|
2691
2690
|
* cannot do the following: </p>
|
|
2692
2691
|
* <ul>
|
|
@@ -2707,16 +2706,17 @@ export interface UpdateShardCountInput {
|
|
|
2707
2706
|
* less than 10000 shards.</p>
|
|
2708
2707
|
* </li>
|
|
2709
2708
|
* </ul>
|
|
2709
|
+
* @public
|
|
2710
2710
|
*/
|
|
2711
2711
|
TargetShardCount: number | undefined;
|
|
2712
2712
|
/**
|
|
2713
|
-
* @public
|
|
2714
2713
|
* <p>The scaling type. Uniform scaling creates shards of equal size.</p>
|
|
2714
|
+
* @public
|
|
2715
2715
|
*/
|
|
2716
2716
|
ScalingType: ScalingType | undefined;
|
|
2717
2717
|
/**
|
|
2718
|
-
* @public
|
|
2719
2718
|
* <p>The ARN of the stream.</p>
|
|
2719
|
+
* @public
|
|
2720
2720
|
*/
|
|
2721
2721
|
StreamARN?: string;
|
|
2722
2722
|
}
|
|
@@ -2725,23 +2725,23 @@ export interface UpdateShardCountInput {
|
|
|
2725
2725
|
*/
|
|
2726
2726
|
export interface UpdateShardCountOutput {
|
|
2727
2727
|
/**
|
|
2728
|
-
* @public
|
|
2729
2728
|
* <p>The name of the stream.</p>
|
|
2729
|
+
* @public
|
|
2730
2730
|
*/
|
|
2731
2731
|
StreamName?: string;
|
|
2732
2732
|
/**
|
|
2733
|
-
* @public
|
|
2734
2733
|
* <p>The current number of shards.</p>
|
|
2734
|
+
* @public
|
|
2735
2735
|
*/
|
|
2736
2736
|
CurrentShardCount?: number;
|
|
2737
2737
|
/**
|
|
2738
|
-
* @public
|
|
2739
2738
|
* <p>The updated number of shards.</p>
|
|
2739
|
+
* @public
|
|
2740
2740
|
*/
|
|
2741
2741
|
TargetShardCount?: number;
|
|
2742
2742
|
/**
|
|
2743
|
-
* @public
|
|
2744
2743
|
* <p>The ARN of the stream.</p>
|
|
2744
|
+
* @public
|
|
2745
2745
|
*/
|
|
2746
2746
|
StreamARN?: string;
|
|
2747
2747
|
}
|
|
@@ -2750,14 +2750,14 @@ export interface UpdateShardCountOutput {
|
|
|
2750
2750
|
*/
|
|
2751
2751
|
export interface UpdateStreamModeInput {
|
|
2752
2752
|
/**
|
|
2753
|
-
* @public
|
|
2754
2753
|
* <p> Specifies the ARN of the data stream whose capacity mode you want to update. </p>
|
|
2754
|
+
* @public
|
|
2755
2755
|
*/
|
|
2756
2756
|
StreamARN: string | undefined;
|
|
2757
2757
|
/**
|
|
2758
|
-
* @public
|
|
2759
2758
|
* <p> Specifies the capacity mode to which you want to set your data stream. Currently, in
|
|
2760
2759
|
* Kinesis Data Streams, you can choose between an <b>on-demand</b> capacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>
|
|
2760
|
+
* @public
|
|
2761
2761
|
*/
|
|
2762
2762
|
StreamModeDetails: StreamModeDetails | undefined;
|
|
2763
2763
|
}
|