types-boto3-kinesis 1.36.0__py3-none-any.whl
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.
- types_boto3_kinesis/__init__.py +55 -0
- types_boto3_kinesis/__init__.pyi +54 -0
- types_boto3_kinesis/__main__.py +43 -0
- types_boto3_kinesis/client.py +548 -0
- types_boto3_kinesis/client.pyi +545 -0
- types_boto3_kinesis/literals.py +534 -0
- types_boto3_kinesis/literals.pyi +532 -0
- types_boto3_kinesis/paginator.py +144 -0
- types_boto3_kinesis/paginator.pyi +131 -0
- types_boto3_kinesis/py.typed +0 -0
- types_boto3_kinesis/type_defs.py +686 -0
- types_boto3_kinesis/type_defs.pyi +599 -0
- types_boto3_kinesis/version.py +7 -0
- types_boto3_kinesis/waiter.py +71 -0
- types_boto3_kinesis/waiter.pyi +66 -0
- types_boto3_kinesis-1.36.0.dist-info/LICENSE +21 -0
- types_boto3_kinesis-1.36.0.dist-info/METADATA +510 -0
- types_boto3_kinesis-1.36.0.dist-info/RECORD +20 -0
- types_boto3_kinesis-1.36.0.dist-info/WHEEL +5 -0
- types_boto3_kinesis-1.36.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,599 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Type annotations for kinesis service type definitions.
|
|
3
|
+
|
|
4
|
+
[Documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/type_defs/)
|
|
5
|
+
|
|
6
|
+
Usage::
|
|
7
|
+
|
|
8
|
+
```python
|
|
9
|
+
from types_boto3_kinesis.type_defs import AddTagsToStreamInputRequestTypeDef
|
|
10
|
+
|
|
11
|
+
data: AddTagsToStreamInputRequestTypeDef = ...
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Copyright 2025 Vlad Emelianov
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
import sys
|
|
20
|
+
from datetime import datetime
|
|
21
|
+
from typing import IO, Any, Union
|
|
22
|
+
|
|
23
|
+
from botocore.eventstream import EventStream
|
|
24
|
+
from botocore.response import StreamingBody
|
|
25
|
+
|
|
26
|
+
from .literals import (
|
|
27
|
+
ConsumerStatusType,
|
|
28
|
+
EncryptionTypeType,
|
|
29
|
+
MetricsNameType,
|
|
30
|
+
ShardFilterTypeType,
|
|
31
|
+
ShardIteratorTypeType,
|
|
32
|
+
StreamModeType,
|
|
33
|
+
StreamStatusType,
|
|
34
|
+
)
|
|
35
|
+
|
|
36
|
+
if sys.version_info >= (3, 9):
|
|
37
|
+
from builtins import dict as Dict
|
|
38
|
+
from builtins import list as List
|
|
39
|
+
from collections.abc import Mapping, Sequence
|
|
40
|
+
else:
|
|
41
|
+
from typing import Dict, List, Mapping, Sequence
|
|
42
|
+
if sys.version_info >= (3, 12):
|
|
43
|
+
from typing import Literal, NotRequired, TypedDict
|
|
44
|
+
else:
|
|
45
|
+
from typing_extensions import Literal, NotRequired, TypedDict
|
|
46
|
+
|
|
47
|
+
__all__ = (
|
|
48
|
+
"AddTagsToStreamInputRequestTypeDef",
|
|
49
|
+
"BlobTypeDef",
|
|
50
|
+
"ChildShardTypeDef",
|
|
51
|
+
"ConsumerDescriptionTypeDef",
|
|
52
|
+
"ConsumerTypeDef",
|
|
53
|
+
"CreateStreamInputRequestTypeDef",
|
|
54
|
+
"DecreaseStreamRetentionPeriodInputRequestTypeDef",
|
|
55
|
+
"DeleteResourcePolicyInputRequestTypeDef",
|
|
56
|
+
"DeleteStreamInputRequestTypeDef",
|
|
57
|
+
"DeregisterStreamConsumerInputRequestTypeDef",
|
|
58
|
+
"DescribeLimitsOutputTypeDef",
|
|
59
|
+
"DescribeStreamConsumerInputRequestTypeDef",
|
|
60
|
+
"DescribeStreamConsumerOutputTypeDef",
|
|
61
|
+
"DescribeStreamInputPaginateTypeDef",
|
|
62
|
+
"DescribeStreamInputRequestTypeDef",
|
|
63
|
+
"DescribeStreamInputWaitTypeDef",
|
|
64
|
+
"DescribeStreamOutputTypeDef",
|
|
65
|
+
"DescribeStreamSummaryInputRequestTypeDef",
|
|
66
|
+
"DescribeStreamSummaryOutputTypeDef",
|
|
67
|
+
"DisableEnhancedMonitoringInputRequestTypeDef",
|
|
68
|
+
"EmptyResponseMetadataTypeDef",
|
|
69
|
+
"EnableEnhancedMonitoringInputRequestTypeDef",
|
|
70
|
+
"EnhancedMetricsTypeDef",
|
|
71
|
+
"EnhancedMonitoringOutputTypeDef",
|
|
72
|
+
"GetRecordsInputRequestTypeDef",
|
|
73
|
+
"GetRecordsOutputTypeDef",
|
|
74
|
+
"GetResourcePolicyInputRequestTypeDef",
|
|
75
|
+
"GetResourcePolicyOutputTypeDef",
|
|
76
|
+
"GetShardIteratorInputRequestTypeDef",
|
|
77
|
+
"GetShardIteratorOutputTypeDef",
|
|
78
|
+
"HashKeyRangeTypeDef",
|
|
79
|
+
"IncreaseStreamRetentionPeriodInputRequestTypeDef",
|
|
80
|
+
"InternalFailureExceptionTypeDef",
|
|
81
|
+
"KMSAccessDeniedExceptionTypeDef",
|
|
82
|
+
"KMSDisabledExceptionTypeDef",
|
|
83
|
+
"KMSInvalidStateExceptionTypeDef",
|
|
84
|
+
"KMSNotFoundExceptionTypeDef",
|
|
85
|
+
"KMSOptInRequiredTypeDef",
|
|
86
|
+
"KMSThrottlingExceptionTypeDef",
|
|
87
|
+
"ListShardsInputPaginateTypeDef",
|
|
88
|
+
"ListShardsInputRequestTypeDef",
|
|
89
|
+
"ListShardsOutputTypeDef",
|
|
90
|
+
"ListStreamConsumersInputPaginateTypeDef",
|
|
91
|
+
"ListStreamConsumersInputRequestTypeDef",
|
|
92
|
+
"ListStreamConsumersOutputTypeDef",
|
|
93
|
+
"ListStreamsInputPaginateTypeDef",
|
|
94
|
+
"ListStreamsInputRequestTypeDef",
|
|
95
|
+
"ListStreamsOutputTypeDef",
|
|
96
|
+
"ListTagsForStreamInputRequestTypeDef",
|
|
97
|
+
"ListTagsForStreamOutputTypeDef",
|
|
98
|
+
"MergeShardsInputRequestTypeDef",
|
|
99
|
+
"PaginatorConfigTypeDef",
|
|
100
|
+
"PutRecordInputRequestTypeDef",
|
|
101
|
+
"PutRecordOutputTypeDef",
|
|
102
|
+
"PutRecordsInputRequestTypeDef",
|
|
103
|
+
"PutRecordsOutputTypeDef",
|
|
104
|
+
"PutRecordsRequestEntryTypeDef",
|
|
105
|
+
"PutRecordsResultEntryTypeDef",
|
|
106
|
+
"PutResourcePolicyInputRequestTypeDef",
|
|
107
|
+
"RecordTypeDef",
|
|
108
|
+
"RegisterStreamConsumerInputRequestTypeDef",
|
|
109
|
+
"RegisterStreamConsumerOutputTypeDef",
|
|
110
|
+
"RemoveTagsFromStreamInputRequestTypeDef",
|
|
111
|
+
"ResourceInUseExceptionTypeDef",
|
|
112
|
+
"ResourceNotFoundExceptionTypeDef",
|
|
113
|
+
"ResponseMetadataTypeDef",
|
|
114
|
+
"SequenceNumberRangeTypeDef",
|
|
115
|
+
"ShardFilterTypeDef",
|
|
116
|
+
"ShardTypeDef",
|
|
117
|
+
"SplitShardInputRequestTypeDef",
|
|
118
|
+
"StartStreamEncryptionInputRequestTypeDef",
|
|
119
|
+
"StartingPositionTypeDef",
|
|
120
|
+
"StopStreamEncryptionInputRequestTypeDef",
|
|
121
|
+
"StreamDescriptionSummaryTypeDef",
|
|
122
|
+
"StreamDescriptionTypeDef",
|
|
123
|
+
"StreamModeDetailsTypeDef",
|
|
124
|
+
"StreamSummaryTypeDef",
|
|
125
|
+
"SubscribeToShardEventStreamTypeDef",
|
|
126
|
+
"SubscribeToShardEventTypeDef",
|
|
127
|
+
"SubscribeToShardInputRequestTypeDef",
|
|
128
|
+
"SubscribeToShardOutputTypeDef",
|
|
129
|
+
"TagTypeDef",
|
|
130
|
+
"TimestampTypeDef",
|
|
131
|
+
"UpdateShardCountInputRequestTypeDef",
|
|
132
|
+
"UpdateShardCountOutputTypeDef",
|
|
133
|
+
"UpdateStreamModeInputRequestTypeDef",
|
|
134
|
+
"WaiterConfigTypeDef",
|
|
135
|
+
)
|
|
136
|
+
|
|
137
|
+
class AddTagsToStreamInputRequestTypeDef(TypedDict):
|
|
138
|
+
Tags: Mapping[str, str]
|
|
139
|
+
StreamName: NotRequired[str]
|
|
140
|
+
StreamARN: NotRequired[str]
|
|
141
|
+
|
|
142
|
+
BlobTypeDef = Union[str, bytes, IO[Any], StreamingBody]
|
|
143
|
+
|
|
144
|
+
class HashKeyRangeTypeDef(TypedDict):
|
|
145
|
+
StartingHashKey: str
|
|
146
|
+
EndingHashKey: str
|
|
147
|
+
|
|
148
|
+
class ConsumerDescriptionTypeDef(TypedDict):
|
|
149
|
+
ConsumerName: str
|
|
150
|
+
ConsumerARN: str
|
|
151
|
+
ConsumerStatus: ConsumerStatusType
|
|
152
|
+
ConsumerCreationTimestamp: datetime
|
|
153
|
+
StreamARN: str
|
|
154
|
+
|
|
155
|
+
class ConsumerTypeDef(TypedDict):
|
|
156
|
+
ConsumerName: str
|
|
157
|
+
ConsumerARN: str
|
|
158
|
+
ConsumerStatus: ConsumerStatusType
|
|
159
|
+
ConsumerCreationTimestamp: datetime
|
|
160
|
+
|
|
161
|
+
class StreamModeDetailsTypeDef(TypedDict):
|
|
162
|
+
StreamMode: StreamModeType
|
|
163
|
+
|
|
164
|
+
class DecreaseStreamRetentionPeriodInputRequestTypeDef(TypedDict):
|
|
165
|
+
RetentionPeriodHours: int
|
|
166
|
+
StreamName: NotRequired[str]
|
|
167
|
+
StreamARN: NotRequired[str]
|
|
168
|
+
|
|
169
|
+
class DeleteResourcePolicyInputRequestTypeDef(TypedDict):
|
|
170
|
+
ResourceARN: str
|
|
171
|
+
|
|
172
|
+
class DeleteStreamInputRequestTypeDef(TypedDict):
|
|
173
|
+
StreamName: NotRequired[str]
|
|
174
|
+
EnforceConsumerDeletion: NotRequired[bool]
|
|
175
|
+
StreamARN: NotRequired[str]
|
|
176
|
+
|
|
177
|
+
class DeregisterStreamConsumerInputRequestTypeDef(TypedDict):
|
|
178
|
+
StreamARN: NotRequired[str]
|
|
179
|
+
ConsumerName: NotRequired[str]
|
|
180
|
+
ConsumerARN: NotRequired[str]
|
|
181
|
+
|
|
182
|
+
class ResponseMetadataTypeDef(TypedDict):
|
|
183
|
+
RequestId: str
|
|
184
|
+
HTTPStatusCode: int
|
|
185
|
+
HTTPHeaders: Dict[str, str]
|
|
186
|
+
RetryAttempts: int
|
|
187
|
+
HostId: NotRequired[str]
|
|
188
|
+
|
|
189
|
+
class DescribeStreamConsumerInputRequestTypeDef(TypedDict):
|
|
190
|
+
StreamARN: NotRequired[str]
|
|
191
|
+
ConsumerName: NotRequired[str]
|
|
192
|
+
ConsumerARN: NotRequired[str]
|
|
193
|
+
|
|
194
|
+
class PaginatorConfigTypeDef(TypedDict):
|
|
195
|
+
MaxItems: NotRequired[int]
|
|
196
|
+
PageSize: NotRequired[int]
|
|
197
|
+
StartingToken: NotRequired[str]
|
|
198
|
+
|
|
199
|
+
class DescribeStreamInputRequestTypeDef(TypedDict):
|
|
200
|
+
StreamName: NotRequired[str]
|
|
201
|
+
Limit: NotRequired[int]
|
|
202
|
+
ExclusiveStartShardId: NotRequired[str]
|
|
203
|
+
StreamARN: NotRequired[str]
|
|
204
|
+
|
|
205
|
+
class WaiterConfigTypeDef(TypedDict):
|
|
206
|
+
Delay: NotRequired[int]
|
|
207
|
+
MaxAttempts: NotRequired[int]
|
|
208
|
+
|
|
209
|
+
class DescribeStreamSummaryInputRequestTypeDef(TypedDict):
|
|
210
|
+
StreamName: NotRequired[str]
|
|
211
|
+
StreamARN: NotRequired[str]
|
|
212
|
+
|
|
213
|
+
class DisableEnhancedMonitoringInputRequestTypeDef(TypedDict):
|
|
214
|
+
ShardLevelMetrics: Sequence[MetricsNameType]
|
|
215
|
+
StreamName: NotRequired[str]
|
|
216
|
+
StreamARN: NotRequired[str]
|
|
217
|
+
|
|
218
|
+
class EnableEnhancedMonitoringInputRequestTypeDef(TypedDict):
|
|
219
|
+
ShardLevelMetrics: Sequence[MetricsNameType]
|
|
220
|
+
StreamName: NotRequired[str]
|
|
221
|
+
StreamARN: NotRequired[str]
|
|
222
|
+
|
|
223
|
+
class EnhancedMetricsTypeDef(TypedDict):
|
|
224
|
+
ShardLevelMetrics: NotRequired[List[MetricsNameType]]
|
|
225
|
+
|
|
226
|
+
class GetRecordsInputRequestTypeDef(TypedDict):
|
|
227
|
+
ShardIterator: str
|
|
228
|
+
Limit: NotRequired[int]
|
|
229
|
+
StreamARN: NotRequired[str]
|
|
230
|
+
|
|
231
|
+
class RecordTypeDef(TypedDict):
|
|
232
|
+
SequenceNumber: str
|
|
233
|
+
Data: bytes
|
|
234
|
+
PartitionKey: str
|
|
235
|
+
ApproximateArrivalTimestamp: NotRequired[datetime]
|
|
236
|
+
EncryptionType: NotRequired[EncryptionTypeType]
|
|
237
|
+
|
|
238
|
+
class GetResourcePolicyInputRequestTypeDef(TypedDict):
|
|
239
|
+
ResourceARN: str
|
|
240
|
+
|
|
241
|
+
TimestampTypeDef = Union[datetime, str]
|
|
242
|
+
|
|
243
|
+
class IncreaseStreamRetentionPeriodInputRequestTypeDef(TypedDict):
|
|
244
|
+
RetentionPeriodHours: int
|
|
245
|
+
StreamName: NotRequired[str]
|
|
246
|
+
StreamARN: NotRequired[str]
|
|
247
|
+
|
|
248
|
+
class InternalFailureExceptionTypeDef(TypedDict):
|
|
249
|
+
message: NotRequired[str]
|
|
250
|
+
|
|
251
|
+
class KMSAccessDeniedExceptionTypeDef(TypedDict):
|
|
252
|
+
message: NotRequired[str]
|
|
253
|
+
|
|
254
|
+
class KMSDisabledExceptionTypeDef(TypedDict):
|
|
255
|
+
message: NotRequired[str]
|
|
256
|
+
|
|
257
|
+
class KMSInvalidStateExceptionTypeDef(TypedDict):
|
|
258
|
+
message: NotRequired[str]
|
|
259
|
+
|
|
260
|
+
class KMSNotFoundExceptionTypeDef(TypedDict):
|
|
261
|
+
message: NotRequired[str]
|
|
262
|
+
|
|
263
|
+
class KMSOptInRequiredTypeDef(TypedDict):
|
|
264
|
+
message: NotRequired[str]
|
|
265
|
+
|
|
266
|
+
class KMSThrottlingExceptionTypeDef(TypedDict):
|
|
267
|
+
message: NotRequired[str]
|
|
268
|
+
|
|
269
|
+
class ListStreamsInputRequestTypeDef(TypedDict):
|
|
270
|
+
Limit: NotRequired[int]
|
|
271
|
+
ExclusiveStartStreamName: NotRequired[str]
|
|
272
|
+
NextToken: NotRequired[str]
|
|
273
|
+
|
|
274
|
+
class ListTagsForStreamInputRequestTypeDef(TypedDict):
|
|
275
|
+
StreamName: NotRequired[str]
|
|
276
|
+
ExclusiveStartTagKey: NotRequired[str]
|
|
277
|
+
Limit: NotRequired[int]
|
|
278
|
+
StreamARN: NotRequired[str]
|
|
279
|
+
|
|
280
|
+
class TagTypeDef(TypedDict):
|
|
281
|
+
Key: str
|
|
282
|
+
Value: NotRequired[str]
|
|
283
|
+
|
|
284
|
+
class MergeShardsInputRequestTypeDef(TypedDict):
|
|
285
|
+
ShardToMerge: str
|
|
286
|
+
AdjacentShardToMerge: str
|
|
287
|
+
StreamName: NotRequired[str]
|
|
288
|
+
StreamARN: NotRequired[str]
|
|
289
|
+
|
|
290
|
+
class PutRecordsResultEntryTypeDef(TypedDict):
|
|
291
|
+
SequenceNumber: NotRequired[str]
|
|
292
|
+
ShardId: NotRequired[str]
|
|
293
|
+
ErrorCode: NotRequired[str]
|
|
294
|
+
ErrorMessage: NotRequired[str]
|
|
295
|
+
|
|
296
|
+
class PutResourcePolicyInputRequestTypeDef(TypedDict):
|
|
297
|
+
ResourceARN: str
|
|
298
|
+
Policy: str
|
|
299
|
+
|
|
300
|
+
class RegisterStreamConsumerInputRequestTypeDef(TypedDict):
|
|
301
|
+
StreamARN: str
|
|
302
|
+
ConsumerName: str
|
|
303
|
+
|
|
304
|
+
class RemoveTagsFromStreamInputRequestTypeDef(TypedDict):
|
|
305
|
+
TagKeys: Sequence[str]
|
|
306
|
+
StreamName: NotRequired[str]
|
|
307
|
+
StreamARN: NotRequired[str]
|
|
308
|
+
|
|
309
|
+
class ResourceInUseExceptionTypeDef(TypedDict):
|
|
310
|
+
message: NotRequired[str]
|
|
311
|
+
|
|
312
|
+
class ResourceNotFoundExceptionTypeDef(TypedDict):
|
|
313
|
+
message: NotRequired[str]
|
|
314
|
+
|
|
315
|
+
class SequenceNumberRangeTypeDef(TypedDict):
|
|
316
|
+
StartingSequenceNumber: str
|
|
317
|
+
EndingSequenceNumber: NotRequired[str]
|
|
318
|
+
|
|
319
|
+
class SplitShardInputRequestTypeDef(TypedDict):
|
|
320
|
+
ShardToSplit: str
|
|
321
|
+
NewStartingHashKey: str
|
|
322
|
+
StreamName: NotRequired[str]
|
|
323
|
+
StreamARN: NotRequired[str]
|
|
324
|
+
|
|
325
|
+
class StartStreamEncryptionInputRequestTypeDef(TypedDict):
|
|
326
|
+
EncryptionType: EncryptionTypeType
|
|
327
|
+
KeyId: str
|
|
328
|
+
StreamName: NotRequired[str]
|
|
329
|
+
StreamARN: NotRequired[str]
|
|
330
|
+
|
|
331
|
+
class StopStreamEncryptionInputRequestTypeDef(TypedDict):
|
|
332
|
+
EncryptionType: EncryptionTypeType
|
|
333
|
+
KeyId: str
|
|
334
|
+
StreamName: NotRequired[str]
|
|
335
|
+
StreamARN: NotRequired[str]
|
|
336
|
+
|
|
337
|
+
class UpdateShardCountInputRequestTypeDef(TypedDict):
|
|
338
|
+
TargetShardCount: int
|
|
339
|
+
ScalingType: Literal["UNIFORM_SCALING"]
|
|
340
|
+
StreamName: NotRequired[str]
|
|
341
|
+
StreamARN: NotRequired[str]
|
|
342
|
+
|
|
343
|
+
class PutRecordInputRequestTypeDef(TypedDict):
|
|
344
|
+
Data: BlobTypeDef
|
|
345
|
+
PartitionKey: str
|
|
346
|
+
StreamName: NotRequired[str]
|
|
347
|
+
ExplicitHashKey: NotRequired[str]
|
|
348
|
+
SequenceNumberForOrdering: NotRequired[str]
|
|
349
|
+
StreamARN: NotRequired[str]
|
|
350
|
+
|
|
351
|
+
class PutRecordsRequestEntryTypeDef(TypedDict):
|
|
352
|
+
Data: BlobTypeDef
|
|
353
|
+
PartitionKey: str
|
|
354
|
+
ExplicitHashKey: NotRequired[str]
|
|
355
|
+
|
|
356
|
+
class ChildShardTypeDef(TypedDict):
|
|
357
|
+
ShardId: str
|
|
358
|
+
ParentShards: List[str]
|
|
359
|
+
HashKeyRange: HashKeyRangeTypeDef
|
|
360
|
+
|
|
361
|
+
class CreateStreamInputRequestTypeDef(TypedDict):
|
|
362
|
+
StreamName: str
|
|
363
|
+
ShardCount: NotRequired[int]
|
|
364
|
+
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef]
|
|
365
|
+
Tags: NotRequired[Mapping[str, str]]
|
|
366
|
+
|
|
367
|
+
class StreamSummaryTypeDef(TypedDict):
|
|
368
|
+
StreamName: str
|
|
369
|
+
StreamARN: str
|
|
370
|
+
StreamStatus: StreamStatusType
|
|
371
|
+
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef]
|
|
372
|
+
StreamCreationTimestamp: NotRequired[datetime]
|
|
373
|
+
|
|
374
|
+
class UpdateStreamModeInputRequestTypeDef(TypedDict):
|
|
375
|
+
StreamARN: str
|
|
376
|
+
StreamModeDetails: StreamModeDetailsTypeDef
|
|
377
|
+
|
|
378
|
+
class DescribeLimitsOutputTypeDef(TypedDict):
|
|
379
|
+
ShardLimit: int
|
|
380
|
+
OpenShardCount: int
|
|
381
|
+
OnDemandStreamCount: int
|
|
382
|
+
OnDemandStreamCountLimit: int
|
|
383
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
384
|
+
|
|
385
|
+
class DescribeStreamConsumerOutputTypeDef(TypedDict):
|
|
386
|
+
ConsumerDescription: ConsumerDescriptionTypeDef
|
|
387
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
388
|
+
|
|
389
|
+
class EmptyResponseMetadataTypeDef(TypedDict):
|
|
390
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
391
|
+
|
|
392
|
+
class EnhancedMonitoringOutputTypeDef(TypedDict):
|
|
393
|
+
StreamName: str
|
|
394
|
+
CurrentShardLevelMetrics: List[MetricsNameType]
|
|
395
|
+
DesiredShardLevelMetrics: List[MetricsNameType]
|
|
396
|
+
StreamARN: str
|
|
397
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
398
|
+
|
|
399
|
+
class GetResourcePolicyOutputTypeDef(TypedDict):
|
|
400
|
+
Policy: str
|
|
401
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
402
|
+
|
|
403
|
+
class GetShardIteratorOutputTypeDef(TypedDict):
|
|
404
|
+
ShardIterator: str
|
|
405
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
406
|
+
|
|
407
|
+
class ListStreamConsumersOutputTypeDef(TypedDict):
|
|
408
|
+
Consumers: List[ConsumerTypeDef]
|
|
409
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
410
|
+
NextToken: NotRequired[str]
|
|
411
|
+
|
|
412
|
+
class PutRecordOutputTypeDef(TypedDict):
|
|
413
|
+
ShardId: str
|
|
414
|
+
SequenceNumber: str
|
|
415
|
+
EncryptionType: EncryptionTypeType
|
|
416
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
417
|
+
|
|
418
|
+
class RegisterStreamConsumerOutputTypeDef(TypedDict):
|
|
419
|
+
Consumer: ConsumerTypeDef
|
|
420
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
421
|
+
|
|
422
|
+
class UpdateShardCountOutputTypeDef(TypedDict):
|
|
423
|
+
StreamName: str
|
|
424
|
+
CurrentShardCount: int
|
|
425
|
+
TargetShardCount: int
|
|
426
|
+
StreamARN: str
|
|
427
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
428
|
+
|
|
429
|
+
class DescribeStreamInputPaginateTypeDef(TypedDict):
|
|
430
|
+
StreamName: NotRequired[str]
|
|
431
|
+
StreamARN: NotRequired[str]
|
|
432
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
433
|
+
|
|
434
|
+
class ListStreamsInputPaginateTypeDef(TypedDict):
|
|
435
|
+
ExclusiveStartStreamName: NotRequired[str]
|
|
436
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
437
|
+
|
|
438
|
+
class DescribeStreamInputWaitTypeDef(TypedDict):
|
|
439
|
+
StreamName: NotRequired[str]
|
|
440
|
+
Limit: NotRequired[int]
|
|
441
|
+
ExclusiveStartShardId: NotRequired[str]
|
|
442
|
+
StreamARN: NotRequired[str]
|
|
443
|
+
WaiterConfig: NotRequired[WaiterConfigTypeDef]
|
|
444
|
+
|
|
445
|
+
class StreamDescriptionSummaryTypeDef(TypedDict):
|
|
446
|
+
StreamName: str
|
|
447
|
+
StreamARN: str
|
|
448
|
+
StreamStatus: StreamStatusType
|
|
449
|
+
RetentionPeriodHours: int
|
|
450
|
+
StreamCreationTimestamp: datetime
|
|
451
|
+
EnhancedMonitoring: List[EnhancedMetricsTypeDef]
|
|
452
|
+
OpenShardCount: int
|
|
453
|
+
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef]
|
|
454
|
+
EncryptionType: NotRequired[EncryptionTypeType]
|
|
455
|
+
KeyId: NotRequired[str]
|
|
456
|
+
ConsumerCount: NotRequired[int]
|
|
457
|
+
|
|
458
|
+
class GetShardIteratorInputRequestTypeDef(TypedDict):
|
|
459
|
+
ShardId: str
|
|
460
|
+
ShardIteratorType: ShardIteratorTypeType
|
|
461
|
+
StreamName: NotRequired[str]
|
|
462
|
+
StartingSequenceNumber: NotRequired[str]
|
|
463
|
+
Timestamp: NotRequired[TimestampTypeDef]
|
|
464
|
+
StreamARN: NotRequired[str]
|
|
465
|
+
|
|
466
|
+
class ListStreamConsumersInputPaginateTypeDef(TypedDict):
|
|
467
|
+
StreamARN: str
|
|
468
|
+
StreamCreationTimestamp: NotRequired[TimestampTypeDef]
|
|
469
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
470
|
+
|
|
471
|
+
class ListStreamConsumersInputRequestTypeDef(TypedDict):
|
|
472
|
+
StreamARN: str
|
|
473
|
+
NextToken: NotRequired[str]
|
|
474
|
+
MaxResults: NotRequired[int]
|
|
475
|
+
StreamCreationTimestamp: NotRequired[TimestampTypeDef]
|
|
476
|
+
|
|
477
|
+
ShardFilterTypeDef = TypedDict(
|
|
478
|
+
"ShardFilterTypeDef",
|
|
479
|
+
{
|
|
480
|
+
"Type": ShardFilterTypeType,
|
|
481
|
+
"ShardId": NotRequired[str],
|
|
482
|
+
"Timestamp": NotRequired[TimestampTypeDef],
|
|
483
|
+
},
|
|
484
|
+
)
|
|
485
|
+
StartingPositionTypeDef = TypedDict(
|
|
486
|
+
"StartingPositionTypeDef",
|
|
487
|
+
{
|
|
488
|
+
"Type": ShardIteratorTypeType,
|
|
489
|
+
"SequenceNumber": NotRequired[str],
|
|
490
|
+
"Timestamp": NotRequired[TimestampTypeDef],
|
|
491
|
+
},
|
|
492
|
+
)
|
|
493
|
+
|
|
494
|
+
class ListTagsForStreamOutputTypeDef(TypedDict):
|
|
495
|
+
Tags: List[TagTypeDef]
|
|
496
|
+
HasMoreTags: bool
|
|
497
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
498
|
+
|
|
499
|
+
class PutRecordsOutputTypeDef(TypedDict):
|
|
500
|
+
FailedRecordCount: int
|
|
501
|
+
Records: List[PutRecordsResultEntryTypeDef]
|
|
502
|
+
EncryptionType: EncryptionTypeType
|
|
503
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
504
|
+
|
|
505
|
+
class ShardTypeDef(TypedDict):
|
|
506
|
+
ShardId: str
|
|
507
|
+
HashKeyRange: HashKeyRangeTypeDef
|
|
508
|
+
SequenceNumberRange: SequenceNumberRangeTypeDef
|
|
509
|
+
ParentShardId: NotRequired[str]
|
|
510
|
+
AdjacentParentShardId: NotRequired[str]
|
|
511
|
+
|
|
512
|
+
class PutRecordsInputRequestTypeDef(TypedDict):
|
|
513
|
+
Records: Sequence[PutRecordsRequestEntryTypeDef]
|
|
514
|
+
StreamName: NotRequired[str]
|
|
515
|
+
StreamARN: NotRequired[str]
|
|
516
|
+
|
|
517
|
+
class GetRecordsOutputTypeDef(TypedDict):
|
|
518
|
+
Records: List[RecordTypeDef]
|
|
519
|
+
NextShardIterator: str
|
|
520
|
+
MillisBehindLatest: int
|
|
521
|
+
ChildShards: List[ChildShardTypeDef]
|
|
522
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
523
|
+
|
|
524
|
+
class SubscribeToShardEventTypeDef(TypedDict):
|
|
525
|
+
Records: List[RecordTypeDef]
|
|
526
|
+
ContinuationSequenceNumber: str
|
|
527
|
+
MillisBehindLatest: int
|
|
528
|
+
ChildShards: NotRequired[List[ChildShardTypeDef]]
|
|
529
|
+
|
|
530
|
+
class ListStreamsOutputTypeDef(TypedDict):
|
|
531
|
+
StreamNames: List[str]
|
|
532
|
+
HasMoreStreams: bool
|
|
533
|
+
StreamSummaries: List[StreamSummaryTypeDef]
|
|
534
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
535
|
+
NextToken: NotRequired[str]
|
|
536
|
+
|
|
537
|
+
class DescribeStreamSummaryOutputTypeDef(TypedDict):
|
|
538
|
+
StreamDescriptionSummary: StreamDescriptionSummaryTypeDef
|
|
539
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
540
|
+
|
|
541
|
+
class ListShardsInputPaginateTypeDef(TypedDict):
|
|
542
|
+
StreamName: NotRequired[str]
|
|
543
|
+
ExclusiveStartShardId: NotRequired[str]
|
|
544
|
+
StreamCreationTimestamp: NotRequired[TimestampTypeDef]
|
|
545
|
+
ShardFilter: NotRequired[ShardFilterTypeDef]
|
|
546
|
+
StreamARN: NotRequired[str]
|
|
547
|
+
PaginationConfig: NotRequired[PaginatorConfigTypeDef]
|
|
548
|
+
|
|
549
|
+
class ListShardsInputRequestTypeDef(TypedDict):
|
|
550
|
+
StreamName: NotRequired[str]
|
|
551
|
+
NextToken: NotRequired[str]
|
|
552
|
+
ExclusiveStartShardId: NotRequired[str]
|
|
553
|
+
MaxResults: NotRequired[int]
|
|
554
|
+
StreamCreationTimestamp: NotRequired[TimestampTypeDef]
|
|
555
|
+
ShardFilter: NotRequired[ShardFilterTypeDef]
|
|
556
|
+
StreamARN: NotRequired[str]
|
|
557
|
+
|
|
558
|
+
class SubscribeToShardInputRequestTypeDef(TypedDict):
|
|
559
|
+
ConsumerARN: str
|
|
560
|
+
ShardId: str
|
|
561
|
+
StartingPosition: StartingPositionTypeDef
|
|
562
|
+
|
|
563
|
+
class ListShardsOutputTypeDef(TypedDict):
|
|
564
|
+
Shards: List[ShardTypeDef]
|
|
565
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
566
|
+
NextToken: NotRequired[str]
|
|
567
|
+
|
|
568
|
+
class StreamDescriptionTypeDef(TypedDict):
|
|
569
|
+
StreamName: str
|
|
570
|
+
StreamARN: str
|
|
571
|
+
StreamStatus: StreamStatusType
|
|
572
|
+
Shards: List[ShardTypeDef]
|
|
573
|
+
HasMoreShards: bool
|
|
574
|
+
RetentionPeriodHours: int
|
|
575
|
+
StreamCreationTimestamp: datetime
|
|
576
|
+
EnhancedMonitoring: List[EnhancedMetricsTypeDef]
|
|
577
|
+
StreamModeDetails: NotRequired[StreamModeDetailsTypeDef]
|
|
578
|
+
EncryptionType: NotRequired[EncryptionTypeType]
|
|
579
|
+
KeyId: NotRequired[str]
|
|
580
|
+
|
|
581
|
+
class SubscribeToShardEventStreamTypeDef(TypedDict):
|
|
582
|
+
SubscribeToShardEvent: SubscribeToShardEventTypeDef
|
|
583
|
+
ResourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef]
|
|
584
|
+
ResourceInUseException: NotRequired[ResourceInUseExceptionTypeDef]
|
|
585
|
+
KMSDisabledException: NotRequired[KMSDisabledExceptionTypeDef]
|
|
586
|
+
KMSInvalidStateException: NotRequired[KMSInvalidStateExceptionTypeDef]
|
|
587
|
+
KMSAccessDeniedException: NotRequired[KMSAccessDeniedExceptionTypeDef]
|
|
588
|
+
KMSNotFoundException: NotRequired[KMSNotFoundExceptionTypeDef]
|
|
589
|
+
KMSOptInRequired: NotRequired[KMSOptInRequiredTypeDef]
|
|
590
|
+
KMSThrottlingException: NotRequired[KMSThrottlingExceptionTypeDef]
|
|
591
|
+
InternalFailureException: NotRequired[InternalFailureExceptionTypeDef]
|
|
592
|
+
|
|
593
|
+
class DescribeStreamOutputTypeDef(TypedDict):
|
|
594
|
+
StreamDescription: StreamDescriptionTypeDef
|
|
595
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
596
|
+
|
|
597
|
+
class SubscribeToShardOutputTypeDef(TypedDict):
|
|
598
|
+
EventStream: EventStream[SubscribeToShardEventStreamTypeDef]
|
|
599
|
+
ResponseMetadata: ResponseMetadataTypeDef
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Type annotations for kinesis service client waiters.
|
|
3
|
+
|
|
4
|
+
[Documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/waiters/)
|
|
5
|
+
|
|
6
|
+
Usage::
|
|
7
|
+
|
|
8
|
+
```python
|
|
9
|
+
from boto3.session import Session
|
|
10
|
+
|
|
11
|
+
from types_boto3_kinesis.client import KinesisClient
|
|
12
|
+
from types_boto3_kinesis.waiter import (
|
|
13
|
+
StreamExistsWaiter,
|
|
14
|
+
StreamNotExistsWaiter,
|
|
15
|
+
)
|
|
16
|
+
|
|
17
|
+
session = Session()
|
|
18
|
+
client: KinesisClient = session.client("kinesis")
|
|
19
|
+
|
|
20
|
+
stream_exists_waiter: StreamExistsWaiter = client.get_waiter("stream_exists")
|
|
21
|
+
stream_not_exists_waiter: StreamNotExistsWaiter = client.get_waiter("stream_not_exists")
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Copyright 2025 Vlad Emelianov
|
|
25
|
+
"""
|
|
26
|
+
|
|
27
|
+
from __future__ import annotations
|
|
28
|
+
|
|
29
|
+
import sys
|
|
30
|
+
|
|
31
|
+
from botocore.waiter import Waiter
|
|
32
|
+
|
|
33
|
+
from .type_defs import DescribeStreamInputWaitTypeDef
|
|
34
|
+
|
|
35
|
+
if sys.version_info >= (3, 12):
|
|
36
|
+
from typing import Unpack
|
|
37
|
+
else:
|
|
38
|
+
from typing_extensions import Unpack
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
__all__ = ("StreamExistsWaiter", "StreamNotExistsWaiter")
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
class StreamExistsWaiter(Waiter):
|
|
45
|
+
"""
|
|
46
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/waiter/StreamExists.html#Kinesis.Waiter.StreamExists)
|
|
47
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/waiters/#streamexistswaiter)
|
|
48
|
+
"""
|
|
49
|
+
|
|
50
|
+
def wait( # type: ignore[override]
|
|
51
|
+
self, **kwargs: Unpack[DescribeStreamInputWaitTypeDef]
|
|
52
|
+
) -> None:
|
|
53
|
+
"""
|
|
54
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/waiter/StreamExists.html#Kinesis.Waiter.StreamExists.wait)
|
|
55
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/waiters/#streamexistswaiter)
|
|
56
|
+
"""
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
class StreamNotExistsWaiter(Waiter):
|
|
60
|
+
"""
|
|
61
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/waiter/StreamNotExists.html#Kinesis.Waiter.StreamNotExists)
|
|
62
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/waiters/#streamnotexistswaiter)
|
|
63
|
+
"""
|
|
64
|
+
|
|
65
|
+
def wait( # type: ignore[override]
|
|
66
|
+
self, **kwargs: Unpack[DescribeStreamInputWaitTypeDef]
|
|
67
|
+
) -> None:
|
|
68
|
+
"""
|
|
69
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/waiter/StreamNotExists.html#Kinesis.Waiter.StreamNotExists.wait)
|
|
70
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/waiters/#streamnotexistswaiter)
|
|
71
|
+
"""
|