mypy-boto3-kinesis 1.35.26__py3-none-any.whl → 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.
- mypy_boto3_kinesis/__init__.py +2 -0
- mypy_boto3_kinesis/__init__.pyi +2 -0
- mypy_boto3_kinesis/__main__.py +11 -8
- mypy_boto3_kinesis/client.py +115 -111
- mypy_boto3_kinesis/client.pyi +115 -110
- mypy_boto3_kinesis/literals.py +30 -10
- mypy_boto3_kinesis/literals.pyi +30 -10
- mypy_boto3_kinesis/paginator.py +56 -38
- mypy_boto3_kinesis/paginator.pyi +53 -37
- mypy_boto3_kinesis/type_defs.py +600 -762
- mypy_boto3_kinesis/type_defs.pyi +503 -751
- mypy_boto3_kinesis/version.py +3 -1
- mypy_boto3_kinesis/waiter.py +16 -11
- mypy_boto3_kinesis/waiter.pyi +16 -11
- {mypy_boto3_kinesis-1.35.26.dist-info → mypy_boto3_kinesis-1.36.0.dist-info}/LICENSE +1 -1
- {mypy_boto3_kinesis-1.35.26.dist-info → mypy_boto3_kinesis-1.36.0.dist-info}/METADATA +90 -23
- mypy_boto3_kinesis-1.36.0.dist-info/RECORD +20 -0
- {mypy_boto3_kinesis-1.35.26.dist-info → mypy_boto3_kinesis-1.36.0.dist-info}/WHEEL +1 -1
- mypy_boto3_kinesis-1.35.26.dist-info/RECORD +0 -20
- {mypy_boto3_kinesis-1.35.26.dist-info → mypy_boto3_kinesis-1.36.0.dist-info}/top_level.txt +0 -0
mypy_boto3_kinesis/__init__.py
CHANGED
|
@@ -27,6 +27,8 @@ Usage::
|
|
|
27
27
|
list_stream_consumers_paginator: ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers")
|
|
28
28
|
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
|
|
29
29
|
```
|
|
30
|
+
|
|
31
|
+
Copyright 2025 Vlad Emelianov
|
|
30
32
|
"""
|
|
31
33
|
|
|
32
34
|
from .client import KinesisClient
|
mypy_boto3_kinesis/__init__.pyi
CHANGED
|
@@ -27,6 +27,8 @@ Usage::
|
|
|
27
27
|
list_stream_consumers_paginator: ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers")
|
|
28
28
|
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
|
|
29
29
|
```
|
|
30
|
+
|
|
31
|
+
Copyright 2025 Vlad Emelianov
|
|
30
32
|
"""
|
|
31
33
|
|
|
32
34
|
from .client import KinesisClient
|
mypy_boto3_kinesis/__main__.py
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Main CLI entrypoint.
|
|
3
|
+
|
|
4
|
+
Copyright 2025 Vlad Emelianov
|
|
3
5
|
"""
|
|
4
6
|
|
|
5
7
|
import sys
|
|
@@ -9,14 +11,14 @@ def print_info() -> None:
|
|
|
9
11
|
"""
|
|
10
12
|
Print package info to stdout.
|
|
11
13
|
"""
|
|
12
|
-
|
|
13
|
-
"Type annotations for boto3
|
|
14
|
-
"Version: 1.
|
|
15
|
-
"Builder version: 8.
|
|
14
|
+
sys.stdout.write(
|
|
15
|
+
"Type annotations for boto3 Kinesis 1.36.0\n"
|
|
16
|
+
"Version: 1.36.0\n"
|
|
17
|
+
"Builder version: 8.8.0\n"
|
|
16
18
|
"Docs: https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis//\n"
|
|
17
|
-
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#
|
|
19
|
+
"Boto3 docs: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#kinesis\n"
|
|
18
20
|
"Other services: https://pypi.org/project/boto3-stubs/\n"
|
|
19
|
-
"Changelog: https://github.com/youtype/mypy_boto3_builder/releases"
|
|
21
|
+
"Changelog: https://github.com/youtype/mypy_boto3_builder/releases\n"
|
|
20
22
|
)
|
|
21
23
|
|
|
22
24
|
|
|
@@ -24,7 +26,7 @@ def print_version() -> None:
|
|
|
24
26
|
"""
|
|
25
27
|
Print package version to stdout.
|
|
26
28
|
"""
|
|
27
|
-
|
|
29
|
+
sys.stdout.write("1.36.0\n")
|
|
28
30
|
|
|
29
31
|
|
|
30
32
|
def main() -> None:
|
|
@@ -32,7 +34,8 @@ def main() -> None:
|
|
|
32
34
|
Main CLI entrypoint.
|
|
33
35
|
"""
|
|
34
36
|
if "--version" in sys.argv:
|
|
35
|
-
|
|
37
|
+
print_version()
|
|
38
|
+
return
|
|
36
39
|
print_info()
|
|
37
40
|
|
|
38
41
|
|
mypy_boto3_kinesis/client.py
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
|
-
Type annotations for kinesis service
|
|
2
|
+
Type annotations for kinesis service Client.
|
|
3
3
|
|
|
4
|
-
[
|
|
4
|
+
[Documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/)
|
|
5
5
|
|
|
6
6
|
Usage::
|
|
7
7
|
|
|
@@ -12,12 +12,18 @@ Usage::
|
|
|
12
12
|
session = Session()
|
|
13
13
|
client: KinesisClient = session.client("kinesis")
|
|
14
14
|
```
|
|
15
|
+
|
|
16
|
+
Copyright 2025 Vlad Emelianov
|
|
15
17
|
"""
|
|
16
18
|
|
|
19
|
+
from __future__ import annotations
|
|
20
|
+
|
|
17
21
|
import sys
|
|
18
|
-
from typing import Any,
|
|
22
|
+
from typing import Any, overload
|
|
19
23
|
|
|
20
24
|
from botocore.client import BaseClient, ClientMeta
|
|
25
|
+
from botocore.errorfactory import BaseClientExceptions
|
|
26
|
+
from botocore.exceptions import ClientError as BotocoreClientError
|
|
21
27
|
|
|
22
28
|
from .paginator import (
|
|
23
29
|
DescribeStreamPaginator,
|
|
@@ -78,6 +84,11 @@ from .type_defs import (
|
|
|
78
84
|
)
|
|
79
85
|
from .waiter import StreamExistsWaiter, StreamNotExistsWaiter
|
|
80
86
|
|
|
87
|
+
if sys.version_info >= (3, 9):
|
|
88
|
+
from builtins import type as Type
|
|
89
|
+
from collections.abc import Mapping
|
|
90
|
+
else:
|
|
91
|
+
from typing import Mapping, Type
|
|
81
92
|
if sys.version_info >= (3, 12):
|
|
82
93
|
from typing import Literal, Unpack
|
|
83
94
|
else:
|
|
@@ -87,15 +98,7 @@ else:
|
|
|
87
98
|
__all__ = ("KinesisClient",)
|
|
88
99
|
|
|
89
100
|
|
|
90
|
-
class
|
|
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
|
-
|
|
98
|
-
class Exceptions:
|
|
101
|
+
class Exceptions(BaseClientExceptions):
|
|
99
102
|
AccessDeniedException: Type[BotocoreClientError]
|
|
100
103
|
ClientError: Type[BotocoreClientError]
|
|
101
104
|
ExpiredIteratorException: Type[BotocoreClientError]
|
|
@@ -128,34 +131,36 @@ class KinesisClient(BaseClient):
|
|
|
128
131
|
"""
|
|
129
132
|
KinesisClient exceptions.
|
|
130
133
|
|
|
131
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client
|
|
134
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client)
|
|
132
135
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#exceptions)
|
|
133
136
|
"""
|
|
134
137
|
|
|
135
|
-
def
|
|
136
|
-
self, **kwargs: Unpack[AddTagsToStreamInputRequestTypeDef]
|
|
137
|
-
) -> EmptyResponseMetadataTypeDef:
|
|
138
|
+
def can_paginate(self, operation_name: str) -> bool:
|
|
138
139
|
"""
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client.add_tags_to_stream)
|
|
142
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#add_tags_to_stream)
|
|
140
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/can_paginate.html)
|
|
141
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#can_paginate)
|
|
143
142
|
"""
|
|
144
143
|
|
|
145
|
-
def
|
|
144
|
+
def generate_presigned_url(
|
|
145
|
+
self,
|
|
146
|
+
ClientMethod: str,
|
|
147
|
+
Params: Mapping[str, Any] = ...,
|
|
148
|
+
ExpiresIn: int = 3600,
|
|
149
|
+
HttpMethod: str = ...,
|
|
150
|
+
) -> str:
|
|
146
151
|
"""
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client.can_paginate)
|
|
150
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#can_paginate)
|
|
152
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/generate_presigned_url.html)
|
|
153
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#generate_presigned_url)
|
|
151
154
|
"""
|
|
152
155
|
|
|
153
|
-
def
|
|
156
|
+
def add_tags_to_stream(
|
|
157
|
+
self, **kwargs: Unpack[AddTagsToStreamInputRequestTypeDef]
|
|
158
|
+
) -> EmptyResponseMetadataTypeDef:
|
|
154
159
|
"""
|
|
155
|
-
|
|
160
|
+
Adds or updates tags for the specified Kinesis data stream.
|
|
156
161
|
|
|
157
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
158
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#
|
|
162
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/add_tags_to_stream.html)
|
|
163
|
+
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#add_tags_to_stream)
|
|
159
164
|
"""
|
|
160
165
|
|
|
161
166
|
def create_stream(
|
|
@@ -164,7 +169,7 @@ class KinesisClient(BaseClient):
|
|
|
164
169
|
"""
|
|
165
170
|
Creates a Kinesis data stream.
|
|
166
171
|
|
|
167
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
172
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/create_stream.html)
|
|
168
173
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#create_stream)
|
|
169
174
|
"""
|
|
170
175
|
|
|
@@ -173,10 +178,9 @@ class KinesisClient(BaseClient):
|
|
|
173
178
|
) -> EmptyResponseMetadataTypeDef:
|
|
174
179
|
"""
|
|
175
180
|
Decreases the Kinesis data stream's retention period, which is the length of
|
|
176
|
-
time data records are accessible after they are added to the
|
|
177
|
-
stream.
|
|
181
|
+
time data records are accessible after they are added to the stream.
|
|
178
182
|
|
|
179
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
183
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/decrease_stream_retention_period.html)
|
|
180
184
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#decrease_stream_retention_period)
|
|
181
185
|
"""
|
|
182
186
|
|
|
@@ -186,7 +190,7 @@ class KinesisClient(BaseClient):
|
|
|
186
190
|
"""
|
|
187
191
|
Delete a policy for the specified data stream or consumer.
|
|
188
192
|
|
|
189
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
193
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/delete_resource_policy.html)
|
|
190
194
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#delete_resource_policy)
|
|
191
195
|
"""
|
|
192
196
|
|
|
@@ -196,7 +200,7 @@ class KinesisClient(BaseClient):
|
|
|
196
200
|
"""
|
|
197
201
|
Deletes a Kinesis data stream and all its shards and data.
|
|
198
202
|
|
|
199
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
203
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/delete_stream.html)
|
|
200
204
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#delete_stream)
|
|
201
205
|
"""
|
|
202
206
|
|
|
@@ -206,7 +210,7 @@ class KinesisClient(BaseClient):
|
|
|
206
210
|
"""
|
|
207
211
|
To deregister a consumer, provide its ARN.
|
|
208
212
|
|
|
209
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
213
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/deregister_stream_consumer.html)
|
|
210
214
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#deregister_stream_consumer)
|
|
211
215
|
"""
|
|
212
216
|
|
|
@@ -214,7 +218,7 @@ class KinesisClient(BaseClient):
|
|
|
214
218
|
"""
|
|
215
219
|
Describes the shard limits and usage for the account.
|
|
216
220
|
|
|
217
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
221
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_limits.html)
|
|
218
222
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#describe_limits)
|
|
219
223
|
"""
|
|
220
224
|
|
|
@@ -224,7 +228,7 @@ class KinesisClient(BaseClient):
|
|
|
224
228
|
"""
|
|
225
229
|
Describes the specified Kinesis data stream.
|
|
226
230
|
|
|
227
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
231
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_stream.html)
|
|
228
232
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#describe_stream)
|
|
229
233
|
"""
|
|
230
234
|
|
|
@@ -235,7 +239,7 @@ class KinesisClient(BaseClient):
|
|
|
235
239
|
To get the description of a registered consumer, provide the ARN of the
|
|
236
240
|
consumer.
|
|
237
241
|
|
|
238
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
242
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_stream_consumer.html)
|
|
239
243
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#describe_stream_consumer)
|
|
240
244
|
"""
|
|
241
245
|
|
|
@@ -244,10 +248,9 @@ class KinesisClient(BaseClient):
|
|
|
244
248
|
) -> DescribeStreamSummaryOutputTypeDef:
|
|
245
249
|
"""
|
|
246
250
|
Provides a summarized description of the specified Kinesis data stream without
|
|
247
|
-
the shard
|
|
248
|
-
list.
|
|
251
|
+
the shard list.
|
|
249
252
|
|
|
250
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
253
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/describe_stream_summary.html)
|
|
251
254
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#describe_stream_summary)
|
|
252
255
|
"""
|
|
253
256
|
|
|
@@ -257,7 +260,7 @@ class KinesisClient(BaseClient):
|
|
|
257
260
|
"""
|
|
258
261
|
Disables enhanced monitoring.
|
|
259
262
|
|
|
260
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
263
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/disable_enhanced_monitoring.html)
|
|
261
264
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#disable_enhanced_monitoring)
|
|
262
265
|
"""
|
|
263
266
|
|
|
@@ -267,31 +270,17 @@ class KinesisClient(BaseClient):
|
|
|
267
270
|
"""
|
|
268
271
|
Enables enhanced Kinesis data stream monitoring for shard-level metrics.
|
|
269
272
|
|
|
270
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
273
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/enable_enhanced_monitoring.html)
|
|
271
274
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#enable_enhanced_monitoring)
|
|
272
275
|
"""
|
|
273
276
|
|
|
274
|
-
def generate_presigned_url(
|
|
275
|
-
self,
|
|
276
|
-
ClientMethod: str,
|
|
277
|
-
Params: Mapping[str, Any] = ...,
|
|
278
|
-
ExpiresIn: int = 3600,
|
|
279
|
-
HttpMethod: str = ...,
|
|
280
|
-
) -> str:
|
|
281
|
-
"""
|
|
282
|
-
Generate a presigned url given a client, its method, and arguments.
|
|
283
|
-
|
|
284
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client.generate_presigned_url)
|
|
285
|
-
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#generate_presigned_url)
|
|
286
|
-
"""
|
|
287
|
-
|
|
288
277
|
def get_records(
|
|
289
278
|
self, **kwargs: Unpack[GetRecordsInputRequestTypeDef]
|
|
290
279
|
) -> GetRecordsOutputTypeDef:
|
|
291
280
|
"""
|
|
292
281
|
Gets data records from a Kinesis data stream's shard.
|
|
293
282
|
|
|
294
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
283
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_records.html)
|
|
295
284
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_records)
|
|
296
285
|
"""
|
|
297
286
|
|
|
@@ -301,7 +290,7 @@ class KinesisClient(BaseClient):
|
|
|
301
290
|
"""
|
|
302
291
|
Returns a policy attached to the specified data stream or consumer.
|
|
303
292
|
|
|
304
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
293
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_resource_policy.html)
|
|
305
294
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_resource_policy)
|
|
306
295
|
"""
|
|
307
296
|
|
|
@@ -311,7 +300,7 @@ class KinesisClient(BaseClient):
|
|
|
311
300
|
"""
|
|
312
301
|
Gets an Amazon Kinesis shard iterator.
|
|
313
302
|
|
|
314
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
303
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_shard_iterator.html)
|
|
315
304
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_shard_iterator)
|
|
316
305
|
"""
|
|
317
306
|
|
|
@@ -320,10 +309,9 @@ class KinesisClient(BaseClient):
|
|
|
320
309
|
) -> EmptyResponseMetadataTypeDef:
|
|
321
310
|
"""
|
|
322
311
|
Increases the Kinesis data stream's retention period, which is the length of
|
|
323
|
-
time data records are accessible after they are added to the
|
|
324
|
-
stream.
|
|
312
|
+
time data records are accessible after they are added to the stream.
|
|
325
313
|
|
|
326
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
314
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/increase_stream_retention_period.html)
|
|
327
315
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#increase_stream_retention_period)
|
|
328
316
|
"""
|
|
329
317
|
|
|
@@ -333,7 +321,7 @@ class KinesisClient(BaseClient):
|
|
|
333
321
|
"""
|
|
334
322
|
Lists the shards in a stream and provides information about each shard.
|
|
335
323
|
|
|
336
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
324
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_shards.html)
|
|
337
325
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#list_shards)
|
|
338
326
|
"""
|
|
339
327
|
|
|
@@ -342,10 +330,9 @@ class KinesisClient(BaseClient):
|
|
|
342
330
|
) -> ListStreamConsumersOutputTypeDef:
|
|
343
331
|
"""
|
|
344
332
|
Lists the consumers registered to receive data from a stream using enhanced
|
|
345
|
-
fan-out, and provides information about each
|
|
346
|
-
consumer.
|
|
333
|
+
fan-out, and provides information about each consumer.
|
|
347
334
|
|
|
348
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
335
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_stream_consumers.html)
|
|
349
336
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#list_stream_consumers)
|
|
350
337
|
"""
|
|
351
338
|
|
|
@@ -355,7 +342,7 @@ class KinesisClient(BaseClient):
|
|
|
355
342
|
"""
|
|
356
343
|
Lists your Kinesis data streams.
|
|
357
344
|
|
|
358
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
345
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_streams.html)
|
|
359
346
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#list_streams)
|
|
360
347
|
"""
|
|
361
348
|
|
|
@@ -365,7 +352,7 @@ class KinesisClient(BaseClient):
|
|
|
365
352
|
"""
|
|
366
353
|
Lists the tags for the specified Kinesis data stream.
|
|
367
354
|
|
|
368
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
355
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/list_tags_for_stream.html)
|
|
369
356
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#list_tags_for_stream)
|
|
370
357
|
"""
|
|
371
358
|
|
|
@@ -374,10 +361,9 @@ class KinesisClient(BaseClient):
|
|
|
374
361
|
) -> EmptyResponseMetadataTypeDef:
|
|
375
362
|
"""
|
|
376
363
|
Merges two adjacent shards in a Kinesis data stream and combines them into a
|
|
377
|
-
single shard to reduce the stream's capacity to ingest and transport
|
|
378
|
-
data.
|
|
364
|
+
single shard to reduce the stream's capacity to ingest and transport data.
|
|
379
365
|
|
|
380
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
366
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/merge_shards.html)
|
|
381
367
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#merge_shards)
|
|
382
368
|
"""
|
|
383
369
|
|
|
@@ -385,7 +371,7 @@ class KinesisClient(BaseClient):
|
|
|
385
371
|
"""
|
|
386
372
|
Writes a single data record into an Amazon Kinesis data stream.
|
|
387
373
|
|
|
388
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
374
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_record.html)
|
|
389
375
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#put_record)
|
|
390
376
|
"""
|
|
391
377
|
|
|
@@ -394,10 +380,9 @@ class KinesisClient(BaseClient):
|
|
|
394
380
|
) -> PutRecordsOutputTypeDef:
|
|
395
381
|
"""
|
|
396
382
|
Writes multiple data records into a Kinesis data stream in a single call (also
|
|
397
|
-
referred to as a
|
|
398
|
-
request).
|
|
383
|
+
referred to as a <code>PutRecords</code> request).
|
|
399
384
|
|
|
400
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
385
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_records.html)
|
|
401
386
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#put_records)
|
|
402
387
|
"""
|
|
403
388
|
|
|
@@ -407,7 +392,7 @@ class KinesisClient(BaseClient):
|
|
|
407
392
|
"""
|
|
408
393
|
Attaches a resource-based policy to a data stream or registered consumer.
|
|
409
394
|
|
|
410
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
395
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/put_resource_policy.html)
|
|
411
396
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#put_resource_policy)
|
|
412
397
|
"""
|
|
413
398
|
|
|
@@ -417,7 +402,7 @@ class KinesisClient(BaseClient):
|
|
|
417
402
|
"""
|
|
418
403
|
Registers a consumer with a Kinesis data stream.
|
|
419
404
|
|
|
420
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
405
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/register_stream_consumer.html)
|
|
421
406
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#register_stream_consumer)
|
|
422
407
|
"""
|
|
423
408
|
|
|
@@ -427,7 +412,7 @@ class KinesisClient(BaseClient):
|
|
|
427
412
|
"""
|
|
428
413
|
Removes tags from the specified Kinesis data stream.
|
|
429
414
|
|
|
430
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
415
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/remove_tags_from_stream.html)
|
|
431
416
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#remove_tags_from_stream)
|
|
432
417
|
"""
|
|
433
418
|
|
|
@@ -436,10 +421,9 @@ class KinesisClient(BaseClient):
|
|
|
436
421
|
) -> EmptyResponseMetadataTypeDef:
|
|
437
422
|
"""
|
|
438
423
|
Splits a shard into two new shards in the Kinesis data stream, to increase the
|
|
439
|
-
stream's capacity to ingest and transport
|
|
440
|
-
data.
|
|
424
|
+
stream's capacity to ingest and transport data.
|
|
441
425
|
|
|
442
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
426
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/split_shard.html)
|
|
443
427
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#split_shard)
|
|
444
428
|
"""
|
|
445
429
|
|
|
@@ -448,10 +432,9 @@ class KinesisClient(BaseClient):
|
|
|
448
432
|
) -> EmptyResponseMetadataTypeDef:
|
|
449
433
|
"""
|
|
450
434
|
Enables or updates server-side encryption using an Amazon Web Services KMS key
|
|
451
|
-
for a specified
|
|
452
|
-
stream.
|
|
435
|
+
for a specified stream.
|
|
453
436
|
|
|
454
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
437
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/start_stream_encryption.html)
|
|
455
438
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#start_stream_encryption)
|
|
456
439
|
"""
|
|
457
440
|
|
|
@@ -461,7 +444,7 @@ class KinesisClient(BaseClient):
|
|
|
461
444
|
"""
|
|
462
445
|
Disables server-side encryption for a specified stream.
|
|
463
446
|
|
|
464
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
447
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/stop_stream_encryption.html)
|
|
465
448
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#stop_stream_encryption)
|
|
466
449
|
"""
|
|
467
450
|
|
|
@@ -470,11 +453,10 @@ class KinesisClient(BaseClient):
|
|
|
470
453
|
) -> SubscribeToShardOutputTypeDef:
|
|
471
454
|
"""
|
|
472
455
|
This operation establishes an HTTP/2 connection between the consumer you
|
|
473
|
-
specify in the
|
|
474
|
-
|
|
475
|
-
parameter.
|
|
456
|
+
specify in the <code>ConsumerARN</code> parameter and the shard you specify in
|
|
457
|
+
the <code>ShardId</code> parameter.
|
|
476
458
|
|
|
477
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
459
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/subscribe_to_shard.html)
|
|
478
460
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#subscribe_to_shard)
|
|
479
461
|
"""
|
|
480
462
|
|
|
@@ -485,7 +467,7 @@ class KinesisClient(BaseClient):
|
|
|
485
467
|
Updates the shard count of the specified stream to the specified number of
|
|
486
468
|
shards.
|
|
487
469
|
|
|
488
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
470
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/update_shard_count.html)
|
|
489
471
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#update_shard_count)
|
|
490
472
|
"""
|
|
491
473
|
|
|
@@ -495,50 +477,72 @@ class KinesisClient(BaseClient):
|
|
|
495
477
|
"""
|
|
496
478
|
Updates the capacity mode of the data stream.
|
|
497
479
|
|
|
498
|
-
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html
|
|
480
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/update_stream_mode.html)
|
|
499
481
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#update_stream_mode)
|
|
500
482
|
"""
|
|
501
483
|
|
|
502
|
-
@overload
|
|
503
|
-
def get_paginator(
|
|
484
|
+
@overload # type: ignore[override]
|
|
485
|
+
def get_paginator( # type: ignore[override]
|
|
486
|
+
self, operation_name: Literal["describe_stream"]
|
|
487
|
+
) -> DescribeStreamPaginator:
|
|
504
488
|
"""
|
|
505
|
-
|
|
489
|
+
Create a paginator for an operation.
|
|
490
|
+
|
|
491
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
506
492
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_paginator)
|
|
507
493
|
"""
|
|
508
494
|
|
|
509
|
-
@overload
|
|
510
|
-
def get_paginator(
|
|
495
|
+
@overload # type: ignore[override]
|
|
496
|
+
def get_paginator( # type: ignore[override]
|
|
497
|
+
self, operation_name: Literal["list_shards"]
|
|
498
|
+
) -> ListShardsPaginator:
|
|
511
499
|
"""
|
|
512
|
-
|
|
500
|
+
Create a paginator for an operation.
|
|
501
|
+
|
|
502
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
513
503
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_paginator)
|
|
514
504
|
"""
|
|
515
505
|
|
|
516
|
-
@overload
|
|
517
|
-
def get_paginator(
|
|
506
|
+
@overload # type: ignore[override]
|
|
507
|
+
def get_paginator( # type: ignore[override]
|
|
518
508
|
self, operation_name: Literal["list_stream_consumers"]
|
|
519
509
|
) -> ListStreamConsumersPaginator:
|
|
520
510
|
"""
|
|
521
|
-
|
|
511
|
+
Create a paginator for an operation.
|
|
512
|
+
|
|
513
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
522
514
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_paginator)
|
|
523
515
|
"""
|
|
524
516
|
|
|
525
|
-
@overload
|
|
526
|
-
def get_paginator(
|
|
517
|
+
@overload # type: ignore[override]
|
|
518
|
+
def get_paginator( # type: ignore[override]
|
|
519
|
+
self, operation_name: Literal["list_streams"]
|
|
520
|
+
) -> ListStreamsPaginator:
|
|
527
521
|
"""
|
|
528
|
-
|
|
522
|
+
Create a paginator for an operation.
|
|
523
|
+
|
|
524
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_paginator.html)
|
|
529
525
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_paginator)
|
|
530
526
|
"""
|
|
531
527
|
|
|
532
|
-
@overload
|
|
533
|
-
def get_waiter(
|
|
528
|
+
@overload # type: ignore[override]
|
|
529
|
+
def get_waiter( # type: ignore[override]
|
|
530
|
+
self, waiter_name: Literal["stream_exists"]
|
|
531
|
+
) -> StreamExistsWaiter:
|
|
534
532
|
"""
|
|
535
|
-
|
|
533
|
+
Returns an object that can wait for some condition.
|
|
534
|
+
|
|
535
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_waiter.html)
|
|
536
536
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_waiter)
|
|
537
537
|
"""
|
|
538
538
|
|
|
539
|
-
@overload
|
|
540
|
-
def get_waiter(
|
|
539
|
+
@overload # type: ignore[override]
|
|
540
|
+
def get_waiter( # type: ignore[override]
|
|
541
|
+
self, waiter_name: Literal["stream_not_exists"]
|
|
542
|
+
) -> StreamNotExistsWaiter:
|
|
541
543
|
"""
|
|
542
|
-
|
|
544
|
+
Returns an object that can wait for some condition.
|
|
545
|
+
|
|
546
|
+
[Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/client/get_waiter.html)
|
|
543
547
|
[Show boto3-stubs documentation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_kinesis/client/#get_waiter)
|
|
544
548
|
"""
|