types-boto3-kinesis 1.35.71__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 +42 -0
- types_boto3_kinesis/client.py +543 -0
- types_boto3_kinesis/client.pyi +539 -0
- types_boto3_kinesis/literals.py +526 -0
- types_boto3_kinesis/literals.pyi +524 -0
- types_boto3_kinesis/paginator.py +128 -0
- types_boto3_kinesis/paginator.pyi +117 -0
- types_boto3_kinesis/py.typed +0 -0
- types_boto3_kinesis/type_defs.py +687 -0
- types_boto3_kinesis/type_defs.pyi +599 -0
- types_boto3_kinesis/version.py +7 -0
- types_boto3_kinesis/waiter.py +68 -0
- types_boto3_kinesis/waiter.pyi +63 -0
- types_boto3_kinesis-1.35.71.dist-info/LICENSE +21 -0
- types_boto3_kinesis-1.35.71.dist-info/METADATA +458 -0
- types_boto3_kinesis-1.35.71.dist-info/RECORD +20 -0
- types_boto3_kinesis-1.35.71.dist-info/WHEEL +5 -0
- types_boto3_kinesis-1.35.71.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,539 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Type annotations for kinesis service client.
|
|
3
|
+
|
|
4
|
+
[Open documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/)
|
|
5
|
+
|
|
6
|
+
Usage::
|
|
7
|
+
|
|
8
|
+
```python
|
|
9
|
+
from boto3.session import Session
|
|
10
|
+
from types_boto3_kinesis.client import KinesisClient
|
|
11
|
+
|
|
12
|
+
session = Session()
|
|
13
|
+
client: KinesisClient = session.client("kinesis")
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Copyright 2024 Vlad Emelianov
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
import sys
|
|
20
|
+
from typing import Any, Dict, Mapping, Type, overload
|
|
21
|
+
|
|
22
|
+
from botocore.client import BaseClient, ClientMeta
|
|
23
|
+
|
|
24
|
+
from .paginator import (
|
|
25
|
+
DescribeStreamPaginator,
|
|
26
|
+
ListShardsPaginator,
|
|
27
|
+
ListStreamConsumersPaginator,
|
|
28
|
+
ListStreamsPaginator,
|
|
29
|
+
)
|
|
30
|
+
from .type_defs import (
|
|
31
|
+
AddTagsToStreamInputRequestTypeDef,
|
|
32
|
+
CreateStreamInputRequestTypeDef,
|
|
33
|
+
DecreaseStreamRetentionPeriodInputRequestTypeDef,
|
|
34
|
+
DeleteResourcePolicyInputRequestTypeDef,
|
|
35
|
+
DeleteStreamInputRequestTypeDef,
|
|
36
|
+
DeregisterStreamConsumerInputRequestTypeDef,
|
|
37
|
+
DescribeLimitsOutputTypeDef,
|
|
38
|
+
DescribeStreamConsumerInputRequestTypeDef,
|
|
39
|
+
DescribeStreamConsumerOutputTypeDef,
|
|
40
|
+
DescribeStreamInputRequestTypeDef,
|
|
41
|
+
DescribeStreamOutputTypeDef,
|
|
42
|
+
DescribeStreamSummaryInputRequestTypeDef,
|
|
43
|
+
DescribeStreamSummaryOutputTypeDef,
|
|
44
|
+
DisableEnhancedMonitoringInputRequestTypeDef,
|
|
45
|
+
EmptyResponseMetadataTypeDef,
|
|
46
|
+
EnableEnhancedMonitoringInputRequestTypeDef,
|
|
47
|
+
EnhancedMonitoringOutputTypeDef,
|
|
48
|
+
GetRecordsInputRequestTypeDef,
|
|
49
|
+
GetRecordsOutputTypeDef,
|
|
50
|
+
GetResourcePolicyInputRequestTypeDef,
|
|
51
|
+
GetResourcePolicyOutputTypeDef,
|
|
52
|
+
GetShardIteratorInputRequestTypeDef,
|
|
53
|
+
GetShardIteratorOutputTypeDef,
|
|
54
|
+
IncreaseStreamRetentionPeriodInputRequestTypeDef,
|
|
55
|
+
ListShardsInputRequestTypeDef,
|
|
56
|
+
ListShardsOutputTypeDef,
|
|
57
|
+
ListStreamConsumersInputRequestTypeDef,
|
|
58
|
+
ListStreamConsumersOutputTypeDef,
|
|
59
|
+
ListStreamsInputRequestTypeDef,
|
|
60
|
+
ListStreamsOutputTypeDef,
|
|
61
|
+
ListTagsForStreamInputRequestTypeDef,
|
|
62
|
+
ListTagsForStreamOutputTypeDef,
|
|
63
|
+
MergeShardsInputRequestTypeDef,
|
|
64
|
+
PutRecordInputRequestTypeDef,
|
|
65
|
+
PutRecordOutputTypeDef,
|
|
66
|
+
PutRecordsInputRequestTypeDef,
|
|
67
|
+
PutRecordsOutputTypeDef,
|
|
68
|
+
PutResourcePolicyInputRequestTypeDef,
|
|
69
|
+
RegisterStreamConsumerInputRequestTypeDef,
|
|
70
|
+
RegisterStreamConsumerOutputTypeDef,
|
|
71
|
+
RemoveTagsFromStreamInputRequestTypeDef,
|
|
72
|
+
SplitShardInputRequestTypeDef,
|
|
73
|
+
StartStreamEncryptionInputRequestTypeDef,
|
|
74
|
+
StopStreamEncryptionInputRequestTypeDef,
|
|
75
|
+
SubscribeToShardInputRequestTypeDef,
|
|
76
|
+
SubscribeToShardOutputTypeDef,
|
|
77
|
+
UpdateShardCountInputRequestTypeDef,
|
|
78
|
+
UpdateShardCountOutputTypeDef,
|
|
79
|
+
UpdateStreamModeInputRequestTypeDef,
|
|
80
|
+
)
|
|
81
|
+
from .waiter import StreamExistsWaiter, StreamNotExistsWaiter
|
|
82
|
+
|
|
83
|
+
if sys.version_info >= (3, 12):
|
|
84
|
+
from typing import Literal, Unpack
|
|
85
|
+
else:
|
|
86
|
+
from typing_extensions import Literal, Unpack
|
|
87
|
+
|
|
88
|
+
__all__ = ("KinesisClient",)
|
|
89
|
+
|
|
90
|
+
class BotocoreClientError(Exception):
|
|
91
|
+
MSG_TEMPLATE: str
|
|
92
|
+
|
|
93
|
+
def __init__(self, error_response: Mapping[str, Any], operation_name: str) -> None:
|
|
94
|
+
self.response: Dict[str, Any]
|
|
95
|
+
self.operation_name: str
|
|
96
|
+
|
|
97
|
+
class Exceptions:
|
|
98
|
+
AccessDeniedException: Type[BotocoreClientError]
|
|
99
|
+
ClientError: Type[BotocoreClientError]
|
|
100
|
+
ExpiredIteratorException: Type[BotocoreClientError]
|
|
101
|
+
ExpiredNextTokenException: Type[BotocoreClientError]
|
|
102
|
+
InternalFailureException: Type[BotocoreClientError]
|
|
103
|
+
InvalidArgumentException: Type[BotocoreClientError]
|
|
104
|
+
KMSAccessDeniedException: Type[BotocoreClientError]
|
|
105
|
+
KMSDisabledException: Type[BotocoreClientError]
|
|
106
|
+
KMSInvalidStateException: Type[BotocoreClientError]
|
|
107
|
+
KMSNotFoundException: Type[BotocoreClientError]
|
|
108
|
+
KMSOptInRequired: Type[BotocoreClientError]
|
|
109
|
+
KMSThrottlingException: Type[BotocoreClientError]
|
|
110
|
+
LimitExceededException: Type[BotocoreClientError]
|
|
111
|
+
ProvisionedThroughputExceededException: Type[BotocoreClientError]
|
|
112
|
+
ResourceInUseException: Type[BotocoreClientError]
|
|
113
|
+
ResourceNotFoundException: Type[BotocoreClientError]
|
|
114
|
+
ValidationException: Type[BotocoreClientError]
|
|
115
|
+
|
|
116
|
+
class KinesisClient(BaseClient):
|
|
117
|
+
"""
|
|
118
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client)
|
|
119
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/)
|
|
120
|
+
"""
|
|
121
|
+
|
|
122
|
+
meta: ClientMeta
|
|
123
|
+
|
|
124
|
+
@property
|
|
125
|
+
def exceptions(self) -> Exceptions:
|
|
126
|
+
"""
|
|
127
|
+
KinesisClient exceptions.
|
|
128
|
+
|
|
129
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client)
|
|
130
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#exceptions)
|
|
131
|
+
"""
|
|
132
|
+
|
|
133
|
+
def can_paginate(self, operation_name: str) -> bool:
|
|
134
|
+
"""
|
|
135
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/can_paginate.html)
|
|
136
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#can_paginate)
|
|
137
|
+
"""
|
|
138
|
+
|
|
139
|
+
def generate_presigned_url(
|
|
140
|
+
self,
|
|
141
|
+
ClientMethod: str,
|
|
142
|
+
Params: Mapping[str, Any] = ...,
|
|
143
|
+
ExpiresIn: int = 3600,
|
|
144
|
+
HttpMethod: str = ...,
|
|
145
|
+
) -> str:
|
|
146
|
+
"""
|
|
147
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/generate_presigned_url.html)
|
|
148
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#generate_presigned_url)
|
|
149
|
+
"""
|
|
150
|
+
|
|
151
|
+
def close(self) -> None:
|
|
152
|
+
"""
|
|
153
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/close.html)
|
|
154
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#close)
|
|
155
|
+
"""
|
|
156
|
+
|
|
157
|
+
def add_tags_to_stream(
|
|
158
|
+
self, **kwargs: Unpack[AddTagsToStreamInputRequestTypeDef]
|
|
159
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
160
|
+
"""
|
|
161
|
+
Adds or updates tags for the specified Kinesis data stream.
|
|
162
|
+
|
|
163
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/add_tags_to_stream.html)
|
|
164
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#add_tags_to_stream)
|
|
165
|
+
"""
|
|
166
|
+
|
|
167
|
+
def create_stream(
|
|
168
|
+
self, **kwargs: Unpack[CreateStreamInputRequestTypeDef]
|
|
169
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
170
|
+
"""
|
|
171
|
+
Creates a Kinesis data stream.
|
|
172
|
+
|
|
173
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/create_stream.html)
|
|
174
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#create_stream)
|
|
175
|
+
"""
|
|
176
|
+
|
|
177
|
+
def decrease_stream_retention_period(
|
|
178
|
+
self, **kwargs: Unpack[DecreaseStreamRetentionPeriodInputRequestTypeDef]
|
|
179
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
180
|
+
"""
|
|
181
|
+
Decreases the Kinesis data stream's retention period, which is the length of
|
|
182
|
+
time data records are accessible after they are added to the stream.
|
|
183
|
+
|
|
184
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/decrease_stream_retention_period.html)
|
|
185
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#decrease_stream_retention_period)
|
|
186
|
+
"""
|
|
187
|
+
|
|
188
|
+
def delete_resource_policy(
|
|
189
|
+
self, **kwargs: Unpack[DeleteResourcePolicyInputRequestTypeDef]
|
|
190
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
191
|
+
"""
|
|
192
|
+
Delete a policy for the specified data stream or consumer.
|
|
193
|
+
|
|
194
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/delete_resource_policy.html)
|
|
195
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#delete_resource_policy)
|
|
196
|
+
"""
|
|
197
|
+
|
|
198
|
+
def delete_stream(
|
|
199
|
+
self, **kwargs: Unpack[DeleteStreamInputRequestTypeDef]
|
|
200
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
201
|
+
"""
|
|
202
|
+
Deletes a Kinesis data stream and all its shards and data.
|
|
203
|
+
|
|
204
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/delete_stream.html)
|
|
205
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#delete_stream)
|
|
206
|
+
"""
|
|
207
|
+
|
|
208
|
+
def deregister_stream_consumer(
|
|
209
|
+
self, **kwargs: Unpack[DeregisterStreamConsumerInputRequestTypeDef]
|
|
210
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
211
|
+
"""
|
|
212
|
+
To deregister a consumer, provide its ARN.
|
|
213
|
+
|
|
214
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/deregister_stream_consumer.html)
|
|
215
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#deregister_stream_consumer)
|
|
216
|
+
"""
|
|
217
|
+
|
|
218
|
+
def describe_limits(self) -> DescribeLimitsOutputTypeDef:
|
|
219
|
+
"""
|
|
220
|
+
Describes the shard limits and usage for the account.
|
|
221
|
+
|
|
222
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_limits.html)
|
|
223
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#describe_limits)
|
|
224
|
+
"""
|
|
225
|
+
|
|
226
|
+
def describe_stream(
|
|
227
|
+
self, **kwargs: Unpack[DescribeStreamInputRequestTypeDef]
|
|
228
|
+
) -> DescribeStreamOutputTypeDef:
|
|
229
|
+
"""
|
|
230
|
+
Describes the specified Kinesis data stream.
|
|
231
|
+
|
|
232
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_stream.html)
|
|
233
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#describe_stream)
|
|
234
|
+
"""
|
|
235
|
+
|
|
236
|
+
def describe_stream_consumer(
|
|
237
|
+
self, **kwargs: Unpack[DescribeStreamConsumerInputRequestTypeDef]
|
|
238
|
+
) -> DescribeStreamConsumerOutputTypeDef:
|
|
239
|
+
"""
|
|
240
|
+
To get the description of a registered consumer, provide the ARN of the
|
|
241
|
+
consumer.
|
|
242
|
+
|
|
243
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_stream_consumer.html)
|
|
244
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#describe_stream_consumer)
|
|
245
|
+
"""
|
|
246
|
+
|
|
247
|
+
def describe_stream_summary(
|
|
248
|
+
self, **kwargs: Unpack[DescribeStreamSummaryInputRequestTypeDef]
|
|
249
|
+
) -> DescribeStreamSummaryOutputTypeDef:
|
|
250
|
+
"""
|
|
251
|
+
Provides a summarized description of the specified Kinesis data stream without
|
|
252
|
+
the shard list.
|
|
253
|
+
|
|
254
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_stream_summary.html)
|
|
255
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#describe_stream_summary)
|
|
256
|
+
"""
|
|
257
|
+
|
|
258
|
+
def disable_enhanced_monitoring(
|
|
259
|
+
self, **kwargs: Unpack[DisableEnhancedMonitoringInputRequestTypeDef]
|
|
260
|
+
) -> EnhancedMonitoringOutputTypeDef:
|
|
261
|
+
"""
|
|
262
|
+
Disables enhanced monitoring.
|
|
263
|
+
|
|
264
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/disable_enhanced_monitoring.html)
|
|
265
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#disable_enhanced_monitoring)
|
|
266
|
+
"""
|
|
267
|
+
|
|
268
|
+
def enable_enhanced_monitoring(
|
|
269
|
+
self, **kwargs: Unpack[EnableEnhancedMonitoringInputRequestTypeDef]
|
|
270
|
+
) -> EnhancedMonitoringOutputTypeDef:
|
|
271
|
+
"""
|
|
272
|
+
Enables enhanced Kinesis data stream monitoring for shard-level metrics.
|
|
273
|
+
|
|
274
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/enable_enhanced_monitoring.html)
|
|
275
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#enable_enhanced_monitoring)
|
|
276
|
+
"""
|
|
277
|
+
|
|
278
|
+
def get_records(
|
|
279
|
+
self, **kwargs: Unpack[GetRecordsInputRequestTypeDef]
|
|
280
|
+
) -> GetRecordsOutputTypeDef:
|
|
281
|
+
"""
|
|
282
|
+
Gets data records from a Kinesis data stream's shard.
|
|
283
|
+
|
|
284
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_records.html)
|
|
285
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_records)
|
|
286
|
+
"""
|
|
287
|
+
|
|
288
|
+
def get_resource_policy(
|
|
289
|
+
self, **kwargs: Unpack[GetResourcePolicyInputRequestTypeDef]
|
|
290
|
+
) -> GetResourcePolicyOutputTypeDef:
|
|
291
|
+
"""
|
|
292
|
+
Returns a policy attached to the specified data stream or consumer.
|
|
293
|
+
|
|
294
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_resource_policy.html)
|
|
295
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_resource_policy)
|
|
296
|
+
"""
|
|
297
|
+
|
|
298
|
+
def get_shard_iterator(
|
|
299
|
+
self, **kwargs: Unpack[GetShardIteratorInputRequestTypeDef]
|
|
300
|
+
) -> GetShardIteratorOutputTypeDef:
|
|
301
|
+
"""
|
|
302
|
+
Gets an Amazon Kinesis shard iterator.
|
|
303
|
+
|
|
304
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_shard_iterator.html)
|
|
305
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_shard_iterator)
|
|
306
|
+
"""
|
|
307
|
+
|
|
308
|
+
def increase_stream_retention_period(
|
|
309
|
+
self, **kwargs: Unpack[IncreaseStreamRetentionPeriodInputRequestTypeDef]
|
|
310
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
311
|
+
"""
|
|
312
|
+
Increases the Kinesis data stream's retention period, which is the length of
|
|
313
|
+
time data records are accessible after they are added to the stream.
|
|
314
|
+
|
|
315
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/increase_stream_retention_period.html)
|
|
316
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#increase_stream_retention_period)
|
|
317
|
+
"""
|
|
318
|
+
|
|
319
|
+
def list_shards(
|
|
320
|
+
self, **kwargs: Unpack[ListShardsInputRequestTypeDef]
|
|
321
|
+
) -> ListShardsOutputTypeDef:
|
|
322
|
+
"""
|
|
323
|
+
Lists the shards in a stream and provides information about each shard.
|
|
324
|
+
|
|
325
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_shards.html)
|
|
326
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#list_shards)
|
|
327
|
+
"""
|
|
328
|
+
|
|
329
|
+
def list_stream_consumers(
|
|
330
|
+
self, **kwargs: Unpack[ListStreamConsumersInputRequestTypeDef]
|
|
331
|
+
) -> ListStreamConsumersOutputTypeDef:
|
|
332
|
+
"""
|
|
333
|
+
Lists the consumers registered to receive data from a stream using enhanced
|
|
334
|
+
fan-out, and provides information about each consumer.
|
|
335
|
+
|
|
336
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_stream_consumers.html)
|
|
337
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#list_stream_consumers)
|
|
338
|
+
"""
|
|
339
|
+
|
|
340
|
+
def list_streams(
|
|
341
|
+
self, **kwargs: Unpack[ListStreamsInputRequestTypeDef]
|
|
342
|
+
) -> ListStreamsOutputTypeDef:
|
|
343
|
+
"""
|
|
344
|
+
Lists your Kinesis data streams.
|
|
345
|
+
|
|
346
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_streams.html)
|
|
347
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#list_streams)
|
|
348
|
+
"""
|
|
349
|
+
|
|
350
|
+
def list_tags_for_stream(
|
|
351
|
+
self, **kwargs: Unpack[ListTagsForStreamInputRequestTypeDef]
|
|
352
|
+
) -> ListTagsForStreamOutputTypeDef:
|
|
353
|
+
"""
|
|
354
|
+
Lists the tags for the specified Kinesis data stream.
|
|
355
|
+
|
|
356
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_tags_for_stream.html)
|
|
357
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#list_tags_for_stream)
|
|
358
|
+
"""
|
|
359
|
+
|
|
360
|
+
def merge_shards(
|
|
361
|
+
self, **kwargs: Unpack[MergeShardsInputRequestTypeDef]
|
|
362
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
363
|
+
"""
|
|
364
|
+
Merges two adjacent shards in a Kinesis data stream and combines them into a
|
|
365
|
+
single shard to reduce the stream's capacity to ingest and transport data.
|
|
366
|
+
|
|
367
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/merge_shards.html)
|
|
368
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#merge_shards)
|
|
369
|
+
"""
|
|
370
|
+
|
|
371
|
+
def put_record(self, **kwargs: Unpack[PutRecordInputRequestTypeDef]) -> PutRecordOutputTypeDef:
|
|
372
|
+
"""
|
|
373
|
+
Writes a single data record into an Amazon Kinesis data stream.
|
|
374
|
+
|
|
375
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_record.html)
|
|
376
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#put_record)
|
|
377
|
+
"""
|
|
378
|
+
|
|
379
|
+
def put_records(
|
|
380
|
+
self, **kwargs: Unpack[PutRecordsInputRequestTypeDef]
|
|
381
|
+
) -> PutRecordsOutputTypeDef:
|
|
382
|
+
"""
|
|
383
|
+
Writes multiple data records into a Kinesis data stream in a single call (also
|
|
384
|
+
referred to as a <code>PutRecords</code> request).
|
|
385
|
+
|
|
386
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_records.html)
|
|
387
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#put_records)
|
|
388
|
+
"""
|
|
389
|
+
|
|
390
|
+
def put_resource_policy(
|
|
391
|
+
self, **kwargs: Unpack[PutResourcePolicyInputRequestTypeDef]
|
|
392
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
393
|
+
"""
|
|
394
|
+
Attaches a resource-based policy to a data stream or registered consumer.
|
|
395
|
+
|
|
396
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_resource_policy.html)
|
|
397
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#put_resource_policy)
|
|
398
|
+
"""
|
|
399
|
+
|
|
400
|
+
def register_stream_consumer(
|
|
401
|
+
self, **kwargs: Unpack[RegisterStreamConsumerInputRequestTypeDef]
|
|
402
|
+
) -> RegisterStreamConsumerOutputTypeDef:
|
|
403
|
+
"""
|
|
404
|
+
Registers a consumer with a Kinesis data stream.
|
|
405
|
+
|
|
406
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/register_stream_consumer.html)
|
|
407
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#register_stream_consumer)
|
|
408
|
+
"""
|
|
409
|
+
|
|
410
|
+
def remove_tags_from_stream(
|
|
411
|
+
self, **kwargs: Unpack[RemoveTagsFromStreamInputRequestTypeDef]
|
|
412
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
413
|
+
"""
|
|
414
|
+
Removes tags from the specified Kinesis data stream.
|
|
415
|
+
|
|
416
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/remove_tags_from_stream.html)
|
|
417
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#remove_tags_from_stream)
|
|
418
|
+
"""
|
|
419
|
+
|
|
420
|
+
def split_shard(
|
|
421
|
+
self, **kwargs: Unpack[SplitShardInputRequestTypeDef]
|
|
422
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
423
|
+
"""
|
|
424
|
+
Splits a shard into two new shards in the Kinesis data stream, to increase the
|
|
425
|
+
stream's capacity to ingest and transport data.
|
|
426
|
+
|
|
427
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/split_shard.html)
|
|
428
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#split_shard)
|
|
429
|
+
"""
|
|
430
|
+
|
|
431
|
+
def start_stream_encryption(
|
|
432
|
+
self, **kwargs: Unpack[StartStreamEncryptionInputRequestTypeDef]
|
|
433
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
434
|
+
"""
|
|
435
|
+
Enables or updates server-side encryption using an Amazon Web Services KMS key
|
|
436
|
+
for a specified stream.
|
|
437
|
+
|
|
438
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/start_stream_encryption.html)
|
|
439
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#start_stream_encryption)
|
|
440
|
+
"""
|
|
441
|
+
|
|
442
|
+
def stop_stream_encryption(
|
|
443
|
+
self, **kwargs: Unpack[StopStreamEncryptionInputRequestTypeDef]
|
|
444
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
445
|
+
"""
|
|
446
|
+
Disables server-side encryption for a specified stream.
|
|
447
|
+
|
|
448
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/stop_stream_encryption.html)
|
|
449
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#stop_stream_encryption)
|
|
450
|
+
"""
|
|
451
|
+
|
|
452
|
+
def subscribe_to_shard(
|
|
453
|
+
self, **kwargs: Unpack[SubscribeToShardInputRequestTypeDef]
|
|
454
|
+
) -> SubscribeToShardOutputTypeDef:
|
|
455
|
+
"""
|
|
456
|
+
This operation establishes an HTTP/2 connection between the consumer you
|
|
457
|
+
specify in the <code>ConsumerARN</code> parameter and the shard you specify in
|
|
458
|
+
the <code>ShardId</code> parameter.
|
|
459
|
+
|
|
460
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/subscribe_to_shard.html)
|
|
461
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#subscribe_to_shard)
|
|
462
|
+
"""
|
|
463
|
+
|
|
464
|
+
def update_shard_count(
|
|
465
|
+
self, **kwargs: Unpack[UpdateShardCountInputRequestTypeDef]
|
|
466
|
+
) -> UpdateShardCountOutputTypeDef:
|
|
467
|
+
"""
|
|
468
|
+
Updates the shard count of the specified stream to the specified number of
|
|
469
|
+
shards.
|
|
470
|
+
|
|
471
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/update_shard_count.html)
|
|
472
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#update_shard_count)
|
|
473
|
+
"""
|
|
474
|
+
|
|
475
|
+
def update_stream_mode(
|
|
476
|
+
self, **kwargs: Unpack[UpdateStreamModeInputRequestTypeDef]
|
|
477
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
478
|
+
"""
|
|
479
|
+
Updates the capacity mode of the data stream.
|
|
480
|
+
|
|
481
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/update_stream_mode.html)
|
|
482
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#update_stream_mode)
|
|
483
|
+
"""
|
|
484
|
+
|
|
485
|
+
@overload
|
|
486
|
+
def get_paginator(self, operation_name: Literal["describe_stream"]) -> DescribeStreamPaginator:
|
|
487
|
+
"""
|
|
488
|
+
Create a paginator for an operation.
|
|
489
|
+
|
|
490
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
491
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_paginator)
|
|
492
|
+
"""
|
|
493
|
+
|
|
494
|
+
@overload
|
|
495
|
+
def get_paginator(self, operation_name: Literal["list_shards"]) -> ListShardsPaginator:
|
|
496
|
+
"""
|
|
497
|
+
Create a paginator for an operation.
|
|
498
|
+
|
|
499
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
500
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_paginator)
|
|
501
|
+
"""
|
|
502
|
+
|
|
503
|
+
@overload
|
|
504
|
+
def get_paginator(
|
|
505
|
+
self, operation_name: Literal["list_stream_consumers"]
|
|
506
|
+
) -> ListStreamConsumersPaginator:
|
|
507
|
+
"""
|
|
508
|
+
Create a paginator for an operation.
|
|
509
|
+
|
|
510
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
511
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_paginator)
|
|
512
|
+
"""
|
|
513
|
+
|
|
514
|
+
@overload
|
|
515
|
+
def get_paginator(self, operation_name: Literal["list_streams"]) -> ListStreamsPaginator:
|
|
516
|
+
"""
|
|
517
|
+
Create a paginator for an operation.
|
|
518
|
+
|
|
519
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
520
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_paginator)
|
|
521
|
+
"""
|
|
522
|
+
|
|
523
|
+
@overload
|
|
524
|
+
def get_waiter(self, waiter_name: Literal["stream_exists"]) -> StreamExistsWaiter:
|
|
525
|
+
"""
|
|
526
|
+
Returns an object that can wait for some condition.
|
|
527
|
+
|
|
528
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_waiter.html)
|
|
529
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_waiter)
|
|
530
|
+
"""
|
|
531
|
+
|
|
532
|
+
@overload
|
|
533
|
+
def get_waiter(self, waiter_name: Literal["stream_not_exists"]) -> StreamNotExistsWaiter:
|
|
534
|
+
"""
|
|
535
|
+
Returns an object that can wait for some condition.
|
|
536
|
+
|
|
537
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_waiter.html)
|
|
538
|
+
[Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/client/#get_waiter)
|
|
539
|
+
"""
|