boto3-stubs 1.35.71__tar.gz → 1.35.73__tar.gz
Sign up to get free protection for your applications and to get access to all the features.
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/PKG-INFO +54 -37
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/README.md +40 -32
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/__init__.pyi +42 -0
- boto3_stubs-1.35.73/boto3-stubs/compat.pyi +13 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/crt.pyi +10 -6
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/__init__.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/action.pyi +7 -3
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/attr.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/base.pyi +8 -2
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/client.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/collection.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/docstring.pyi +6 -0
- boto3_stubs-1.35.73/boto3-stubs/docs/method.pyi +27 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/resource.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/service.pyi +6 -2
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/subresource.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/utils.pyi +10 -4
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/docs/waiter.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/dynamodb/conditions.pyi +31 -38
- boto3_stubs-1.35.73/boto3-stubs/dynamodb/table.pyi +39 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/dynamodb/transform.pyi +18 -12
- boto3_stubs-1.35.73/boto3-stubs/dynamodb/types.pyi +48 -0
- boto3_stubs-1.35.73/boto3-stubs/ec2/createtags.pyi +12 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/ec2/deletetags.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/exceptions.pyi +6 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/resources/action.pyi +12 -6
- boto3_stubs-1.35.73/boto3-stubs/resources/base.pyi +40 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/resources/collection.pyi +10 -6
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/resources/factory.pyi +9 -3
- boto3_stubs-1.35.73/boto3-stubs/resources/model.pyi +123 -0
- boto3_stubs-1.35.73/boto3-stubs/resources/params.pyi +23 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/resources/response.pyi +20 -14
- boto3_stubs-1.35.73/boto3-stubs/s3/constants.pyi +8 -0
- boto3_stubs-1.35.73/boto3-stubs/s3/inject.pyi +145 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/s3/transfer.pyi +23 -17
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/session.pyi +45 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/utils.pyi +10 -4
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3_stubs.egg-info/PKG-INFO +54 -37
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3_stubs.egg-info/requires.txt +14 -2
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/setup.py +10 -4
- boto3_stubs-1.35.71/boto3-stubs/compat.pyi +0 -8
- boto3_stubs-1.35.71/boto3-stubs/docs/method.pyi +0 -21
- boto3_stubs-1.35.71/boto3-stubs/dynamodb/table.pyi +0 -33
- boto3_stubs-1.35.71/boto3-stubs/dynamodb/types.pyi +0 -59
- boto3_stubs-1.35.71/boto3-stubs/ec2/createtags.pyi +0 -6
- boto3_stubs-1.35.71/boto3-stubs/resources/base.pyi +0 -36
- boto3_stubs-1.35.71/boto3-stubs/resources/model.pyi +0 -121
- boto3_stubs-1.35.71/boto3-stubs/resources/params.pyi +0 -17
- boto3_stubs-1.35.71/boto3-stubs/s3/constants.pyi +0 -2
- boto3_stubs-1.35.71/boto3-stubs/s3/inject.pyi +0 -139
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/LICENSE +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/dynamodb/__init__.pyi +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/ec2/__init__.pyi +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/py.typed +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/resources/__init__.pyi +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3-stubs/s3/__init__.pyi +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3_stubs.egg-info/SOURCES.txt +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3_stubs.egg-info/dependency_links.txt +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3_stubs.egg-info/not-zip-safe +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/boto3_stubs.egg-info/top_level.txt +0 -0
- {boto3_stubs-1.35.71 → boto3_stubs-1.35.73}/setup.cfg +0 -0
@@ -1,7 +1,7 @@
|
|
1
1
|
Metadata-Version: 2.1
|
2
2
|
Name: boto3-stubs
|
3
|
-
Version: 1.35.
|
4
|
-
Summary: Type annotations for boto3 1.35.
|
3
|
+
Version: 1.35.73
|
4
|
+
Summary: Type annotations for boto3 1.35.73 generated with mypy-boto3-builder 8.5.0
|
5
5
|
Home-page: https://github.com/youtype/mypy_boto3_builder
|
6
6
|
Author: Vlad Emelianov
|
7
7
|
Author-email: vlad.emelianov.nz@gmail.com
|
@@ -9,7 +9,7 @@ License: MIT License
|
|
9
9
|
Project-URL: Documentation, https://youtype.github.io/boto3_stubs_docs/
|
10
10
|
Project-URL: Source, https://github.com/youtype/mypy_boto3_builder
|
11
11
|
Project-URL: Tracker, https://github.com/youtype/mypy_boto3_builder/issues
|
12
|
-
Keywords: boto3
|
12
|
+
Keywords: boto3 boto3-stubs type-annotations typeshed autocomplete
|
13
13
|
Classifier: Development Status :: 5 - Production/Stable
|
14
14
|
Classifier: Intended Audience :: Developers
|
15
15
|
Classifier: Environment :: Console
|
@@ -209,6 +209,7 @@ Requires-Dist: mypy-boto3-inspector<1.36.0,>=1.35.0; extra == "all"
|
|
209
209
|
Requires-Dist: mypy-boto3-inspector-scan<1.36.0,>=1.35.0; extra == "all"
|
210
210
|
Requires-Dist: mypy-boto3-inspector2<1.36.0,>=1.35.0; extra == "all"
|
211
211
|
Requires-Dist: mypy-boto3-internetmonitor<1.36.0,>=1.35.0; extra == "all"
|
212
|
+
Requires-Dist: mypy-boto3-invoicing<1.36.0,>=1.35.0; extra == "all"
|
212
213
|
Requires-Dist: mypy-boto3-iot<1.36.0,>=1.35.0; extra == "all"
|
213
214
|
Requires-Dist: mypy-boto3-iot-data<1.36.0,>=1.35.0; extra == "all"
|
214
215
|
Requires-Dist: mypy-boto3-iot-jobs-data<1.36.0,>=1.35.0; extra == "all"
|
@@ -295,6 +296,7 @@ Requires-Dist: mypy-boto3-neptune<1.36.0,>=1.35.0; extra == "all"
|
|
295
296
|
Requires-Dist: mypy-boto3-neptune-graph<1.36.0,>=1.35.0; extra == "all"
|
296
297
|
Requires-Dist: mypy-boto3-neptunedata<1.36.0,>=1.35.0; extra == "all"
|
297
298
|
Requires-Dist: mypy-boto3-network-firewall<1.36.0,>=1.35.0; extra == "all"
|
299
|
+
Requires-Dist: mypy-boto3-networkflowmonitor<1.36.0,>=1.35.0; extra == "all"
|
298
300
|
Requires-Dist: mypy-boto3-networkmanager<1.36.0,>=1.35.0; extra == "all"
|
299
301
|
Requires-Dist: mypy-boto3-networkmonitor<1.36.0,>=1.35.0; extra == "all"
|
300
302
|
Requires-Dist: mypy-boto3-notifications<1.36.0,>=1.35.0; extra == "all"
|
@@ -373,6 +375,7 @@ Requires-Dist: mypy-boto3-scheduler<1.36.0,>=1.35.0; extra == "all"
|
|
373
375
|
Requires-Dist: mypy-boto3-schemas<1.36.0,>=1.35.0; extra == "all"
|
374
376
|
Requires-Dist: mypy-boto3-sdb<1.36.0,>=1.35.0; extra == "all"
|
375
377
|
Requires-Dist: mypy-boto3-secretsmanager<1.36.0,>=1.35.0; extra == "all"
|
378
|
+
Requires-Dist: mypy-boto3-security-ir<1.36.0,>=1.35.0; extra == "all"
|
376
379
|
Requires-Dist: mypy-boto3-securityhub<1.36.0,>=1.35.0; extra == "all"
|
377
380
|
Requires-Dist: mypy-boto3-securitylake<1.36.0,>=1.35.0; extra == "all"
|
378
381
|
Requires-Dist: mypy-boto3-serverlessrepo<1.36.0,>=1.35.0; extra == "all"
|
@@ -442,8 +445,8 @@ Requires-Dist: mypy-boto3-rds<1.36.0,>=1.35.0; extra == "essential"
|
|
442
445
|
Requires-Dist: mypy-boto3-s3<1.36.0,>=1.35.0; extra == "essential"
|
443
446
|
Requires-Dist: mypy-boto3-sqs<1.36.0,>=1.35.0; extra == "essential"
|
444
447
|
Provides-Extra: boto3
|
445
|
-
Requires-Dist: boto3==1.35.
|
446
|
-
Requires-Dist: botocore==1.35.
|
448
|
+
Requires-Dist: boto3==1.35.73; extra == "boto3"
|
449
|
+
Requires-Dist: botocore==1.35.73; extra == "boto3"
|
447
450
|
Provides-Extra: accessanalyzer
|
448
451
|
Requires-Dist: mypy-boto3-accessanalyzer<1.36.0,>=1.35.0; extra == "accessanalyzer"
|
449
452
|
Provides-Extra: account
|
@@ -790,6 +793,8 @@ Provides-Extra: inspector2
|
|
790
793
|
Requires-Dist: mypy-boto3-inspector2<1.36.0,>=1.35.0; extra == "inspector2"
|
791
794
|
Provides-Extra: internetmonitor
|
792
795
|
Requires-Dist: mypy-boto3-internetmonitor<1.36.0,>=1.35.0; extra == "internetmonitor"
|
796
|
+
Provides-Extra: invoicing
|
797
|
+
Requires-Dist: mypy-boto3-invoicing<1.36.0,>=1.35.0; extra == "invoicing"
|
793
798
|
Provides-Extra: iot
|
794
799
|
Requires-Dist: mypy-boto3-iot<1.36.0,>=1.35.0; extra == "iot"
|
795
800
|
Provides-Extra: iot-data
|
@@ -962,6 +967,8 @@ Provides-Extra: neptunedata
|
|
962
967
|
Requires-Dist: mypy-boto3-neptunedata<1.36.0,>=1.35.0; extra == "neptunedata"
|
963
968
|
Provides-Extra: network-firewall
|
964
969
|
Requires-Dist: mypy-boto3-network-firewall<1.36.0,>=1.35.0; extra == "network-firewall"
|
970
|
+
Provides-Extra: networkflowmonitor
|
971
|
+
Requires-Dist: mypy-boto3-networkflowmonitor<1.36.0,>=1.35.0; extra == "networkflowmonitor"
|
965
972
|
Provides-Extra: networkmanager
|
966
973
|
Requires-Dist: mypy-boto3-networkmanager<1.36.0,>=1.35.0; extra == "networkmanager"
|
967
974
|
Provides-Extra: networkmonitor
|
@@ -1118,6 +1125,8 @@ Provides-Extra: sdb
|
|
1118
1125
|
Requires-Dist: mypy-boto3-sdb<1.36.0,>=1.35.0; extra == "sdb"
|
1119
1126
|
Provides-Extra: secretsmanager
|
1120
1127
|
Requires-Dist: mypy-boto3-secretsmanager<1.36.0,>=1.35.0; extra == "secretsmanager"
|
1128
|
+
Provides-Extra: security-ir
|
1129
|
+
Requires-Dist: mypy-boto3-security-ir<1.36.0,>=1.35.0; extra == "security-ir"
|
1121
1130
|
Provides-Extra: securityhub
|
1122
1131
|
Requires-Dist: mypy-boto3-securityhub<1.36.0,>=1.35.0; extra == "securityhub"
|
1123
1132
|
Provides-Extra: securitylake
|
@@ -1250,7 +1259,7 @@ Requires-Dist: mypy-boto3-xray<1.36.0,>=1.35.0; extra == "xray"
|
|
1250
1259
|
|
1251
1260
|

|
1252
1261
|
|
1253
|
-
Type annotations for [boto3 1.35.
|
1262
|
+
Type annotations for [boto3 1.35.73](https://pypi.org/project/boto3/)
|
1254
1263
|
compatible with [VSCode](https://code.visualstudio.com/),
|
1255
1264
|
[PyCharm](https://www.jetbrains.com/pycharm/),
|
1256
1265
|
[Emacs](https://www.gnu.org/software/emacs/),
|
@@ -1259,14 +1268,14 @@ compatible with [VSCode](https://code.visualstudio.com/),
|
|
1259
1268
|
[pyright](https://github.com/microsoft/pyright) and other tools.
|
1260
1269
|
|
1261
1270
|
Generated by
|
1262
|
-
[mypy-boto3-builder 8.
|
1271
|
+
[mypy-boto3-builder 8.5.0](https://github.com/youtype/mypy_boto3_builder).
|
1263
1272
|
|
1264
1273
|
More information can be found in
|
1265
1274
|
[boto3-stubs docs](https://youtype.github.io/boto3_stubs_docs/).
|
1266
1275
|
|
1267
1276
|
See how it helps you find and fix potential bugs:
|
1268
1277
|
|
1269
|
-

|
1270
1279
|
|
1271
1280
|
- [boto3-stubs](#boto3-stubs)
|
1272
1281
|
- [How to install](#how-to-install)
|
@@ -1282,8 +1291,8 @@ See how it helps you find and fix potential bugs:
|
|
1282
1291
|
- [Other IDEs](#other-ides)
|
1283
1292
|
- [mypy](#mypy)
|
1284
1293
|
- [pyright](#pyright)
|
1285
|
-
- [Explicit type annotations](#explicit-type-annotations)
|
1286
1294
|
- [Pylint compatibility](#pylint-compatibility)
|
1295
|
+
- [Explicit type annotations](#explicit-type-annotations)
|
1287
1296
|
- [How it works](#how-it-works)
|
1288
1297
|
- [What's new](#what's-new)
|
1289
1298
|
- [Implemented features](#implemented-features)
|
@@ -1511,6 +1520,31 @@ Optionally, you can install `boto3-stubs` to `typings` directory.
|
|
1511
1520
|
Type checking should now work. No explicit type annotations required, write
|
1512
1521
|
your `boto3` code as usual.
|
1513
1522
|
|
1523
|
+
<a id="pylint-compatibility"></a>
|
1524
|
+
|
1525
|
+
### Pylint compatibility
|
1526
|
+
|
1527
|
+
It is totally safe to use `TYPE_CHECKING` flag in order to avoid `boto3-stubs`
|
1528
|
+
dependency in production. However, there is an issue in `pylint` that it
|
1529
|
+
complains about undefined variables. To fix it, set all types to `object` in
|
1530
|
+
non-`TYPE_CHECKING` mode.
|
1531
|
+
|
1532
|
+
```python
|
1533
|
+
from typing import TYPE_CHECKING
|
1534
|
+
|
1535
|
+
if TYPE_CHECKING:
|
1536
|
+
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
|
1537
|
+
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
|
1538
|
+
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
|
1539
|
+
else:
|
1540
|
+
EC2Client = object
|
1541
|
+
EC2ServiceResource = object
|
1542
|
+
BundleTaskCompleteWaiter = object
|
1543
|
+
DescribeVolumesPaginator = object
|
1544
|
+
|
1545
|
+
...
|
1546
|
+
```
|
1547
|
+
|
1514
1548
|
<a id="explicit-type-annotations"></a>
|
1515
1549
|
|
1516
1550
|
### Explicit type annotations
|
@@ -1537,32 +1571,6 @@ bundle_task_complete_waiter: BundleTaskCompleteWaiter = ec2_client.get_waiter(
|
|
1537
1571
|
describe_volumes_paginator: DescribeVolumesPaginator = ec2_client.get_paginator("describe_volumes")
|
1538
1572
|
```
|
1539
1573
|
|
1540
|
-
<a id="pylint-compatibility"></a>
|
1541
|
-
|
1542
|
-
### Pylint compatibility
|
1543
|
-
|
1544
|
-
It is totally safe to use `TYPE_CHECKING` flag in order to avoid `boto3-stubs`
|
1545
|
-
dependency in production. However, there is an issue in `pylint` that it
|
1546
|
-
complains about undefined variables. To fix it, set all types to `object` in
|
1547
|
-
non-`TYPE_CHECKING` mode.
|
1548
|
-
|
1549
|
-
```python
|
1550
|
-
import boto3
|
1551
|
-
from typing import TYPE_CHECKING
|
1552
|
-
|
1553
|
-
if TYPE_CHECKING:
|
1554
|
-
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
|
1555
|
-
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
|
1556
|
-
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
|
1557
|
-
else:
|
1558
|
-
EC2Client = object
|
1559
|
-
EC2ServiceResource = object
|
1560
|
-
BundleTaskCompleteWaiter = object
|
1561
|
-
DescribeVolumesPaginator = object
|
1562
|
-
|
1563
|
-
...
|
1564
|
-
```
|
1565
|
-
|
1566
1574
|
<a id="how-it-works"></a>
|
1567
1575
|
|
1568
1576
|
## How it works
|
@@ -1651,9 +1659,9 @@ repository.
|
|
1651
1659
|
|
1652
1660
|
## Submodules
|
1653
1661
|
|
1654
|
-
- `boto3-stubs[full]` - Type annotations for all
|
1662
|
+
- `boto3-stubs[full]` - Type annotations for all 400 services in one package
|
1655
1663
|
(recommended).
|
1656
|
-
- `boto3-stubs[all]` - Type annotations for all
|
1664
|
+
- `boto3-stubs[all]` - Type annotations for all 400 services in separate
|
1657
1665
|
packages.
|
1658
1666
|
- `boto3-stubs[essential]` - Type annotations for
|
1659
1667
|
[CloudFormation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/),
|
@@ -2166,6 +2174,9 @@ repository.
|
|
2166
2174
|
- `boto3-stubs[internetmonitor]` - Type annotations for
|
2167
2175
|
[CloudWatchInternetMonitor](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_internetmonitor/)
|
2168
2176
|
service.
|
2177
|
+
- `boto3-stubs[invoicing]` - Type annotations for
|
2178
|
+
[Invoicing](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_invoicing/)
|
2179
|
+
service.
|
2169
2180
|
- `boto3-stubs[iot]` - Type annotations for
|
2170
2181
|
[IoT](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/) service.
|
2171
2182
|
- `boto3-stubs[iot-data]` - Type annotations for
|
@@ -2418,6 +2429,9 @@ repository.
|
|
2418
2429
|
- `boto3-stubs[network-firewall]` - Type annotations for
|
2419
2430
|
[NetworkFirewall](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_network_firewall/)
|
2420
2431
|
service.
|
2432
|
+
- `boto3-stubs[networkflowmonitor]` - Type annotations for
|
2433
|
+
[NetworkFlowMonitor](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_networkflowmonitor/)
|
2434
|
+
service.
|
2421
2435
|
- `boto3-stubs[networkmanager]` - Type annotations for
|
2422
2436
|
[NetworkManager](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_networkmanager/)
|
2423
2437
|
service.
|
@@ -2647,6 +2661,9 @@ repository.
|
|
2647
2661
|
- `boto3-stubs[secretsmanager]` - Type annotations for
|
2648
2662
|
[SecretsManager](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_secretsmanager/)
|
2649
2663
|
service.
|
2664
|
+
- `boto3-stubs[security-ir]` - Type annotations for
|
2665
|
+
[SecurityIncidentResponse](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_security_ir/)
|
2666
|
+
service.
|
2650
2667
|
- `boto3-stubs[securityhub]` - Type annotations for
|
2651
2668
|
[SecurityHub](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_securityhub/)
|
2652
2669
|
service.
|
@@ -9,7 +9,7 @@
|
|
9
9
|
|
10
10
|

|
11
11
|
|
12
|
-
Type annotations for [boto3 1.35.
|
12
|
+
Type annotations for [boto3 1.35.73](https://pypi.org/project/boto3/)
|
13
13
|
compatible with [VSCode](https://code.visualstudio.com/),
|
14
14
|
[PyCharm](https://www.jetbrains.com/pycharm/),
|
15
15
|
[Emacs](https://www.gnu.org/software/emacs/),
|
@@ -18,14 +18,14 @@ compatible with [VSCode](https://code.visualstudio.com/),
|
|
18
18
|
[pyright](https://github.com/microsoft/pyright) and other tools.
|
19
19
|
|
20
20
|
Generated by
|
21
|
-
[mypy-boto3-builder 8.
|
21
|
+
[mypy-boto3-builder 8.5.0](https://github.com/youtype/mypy_boto3_builder).
|
22
22
|
|
23
23
|
More information can be found in
|
24
24
|
[boto3-stubs docs](https://youtype.github.io/boto3_stubs_docs/).
|
25
25
|
|
26
26
|
See how it helps you find and fix potential bugs:
|
27
27
|
|
28
|
-

|
29
29
|
|
30
30
|
- [boto3-stubs](#boto3-stubs)
|
31
31
|
- [How to install](#how-to-install)
|
@@ -41,8 +41,8 @@ See how it helps you find and fix potential bugs:
|
|
41
41
|
- [Other IDEs](#other-ides)
|
42
42
|
- [mypy](#mypy)
|
43
43
|
- [pyright](#pyright)
|
44
|
-
- [Explicit type annotations](#explicit-type-annotations)
|
45
44
|
- [Pylint compatibility](#pylint-compatibility)
|
45
|
+
- [Explicit type annotations](#explicit-type-annotations)
|
46
46
|
- [How it works](#how-it-works)
|
47
47
|
- [What's new](#what's-new)
|
48
48
|
- [Implemented features](#implemented-features)
|
@@ -270,6 +270,31 @@ Optionally, you can install `boto3-stubs` to `typings` directory.
|
|
270
270
|
Type checking should now work. No explicit type annotations required, write
|
271
271
|
your `boto3` code as usual.
|
272
272
|
|
273
|
+
<a id="pylint-compatibility"></a>
|
274
|
+
|
275
|
+
### Pylint compatibility
|
276
|
+
|
277
|
+
It is totally safe to use `TYPE_CHECKING` flag in order to avoid `boto3-stubs`
|
278
|
+
dependency in production. However, there is an issue in `pylint` that it
|
279
|
+
complains about undefined variables. To fix it, set all types to `object` in
|
280
|
+
non-`TYPE_CHECKING` mode.
|
281
|
+
|
282
|
+
```python
|
283
|
+
from typing import TYPE_CHECKING
|
284
|
+
|
285
|
+
if TYPE_CHECKING:
|
286
|
+
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
|
287
|
+
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
|
288
|
+
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
|
289
|
+
else:
|
290
|
+
EC2Client = object
|
291
|
+
EC2ServiceResource = object
|
292
|
+
BundleTaskCompleteWaiter = object
|
293
|
+
DescribeVolumesPaginator = object
|
294
|
+
|
295
|
+
...
|
296
|
+
```
|
297
|
+
|
273
298
|
<a id="explicit-type-annotations"></a>
|
274
299
|
|
275
300
|
### Explicit type annotations
|
@@ -296,32 +321,6 @@ bundle_task_complete_waiter: BundleTaskCompleteWaiter = ec2_client.get_waiter(
|
|
296
321
|
describe_volumes_paginator: DescribeVolumesPaginator = ec2_client.get_paginator("describe_volumes")
|
297
322
|
```
|
298
323
|
|
299
|
-
<a id="pylint-compatibility"></a>
|
300
|
-
|
301
|
-
### Pylint compatibility
|
302
|
-
|
303
|
-
It is totally safe to use `TYPE_CHECKING` flag in order to avoid `boto3-stubs`
|
304
|
-
dependency in production. However, there is an issue in `pylint` that it
|
305
|
-
complains about undefined variables. To fix it, set all types to `object` in
|
306
|
-
non-`TYPE_CHECKING` mode.
|
307
|
-
|
308
|
-
```python
|
309
|
-
import boto3
|
310
|
-
from typing import TYPE_CHECKING
|
311
|
-
|
312
|
-
if TYPE_CHECKING:
|
313
|
-
from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
|
314
|
-
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
|
315
|
-
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
|
316
|
-
else:
|
317
|
-
EC2Client = object
|
318
|
-
EC2ServiceResource = object
|
319
|
-
BundleTaskCompleteWaiter = object
|
320
|
-
DescribeVolumesPaginator = object
|
321
|
-
|
322
|
-
...
|
323
|
-
```
|
324
|
-
|
325
324
|
<a id="how-it-works"></a>
|
326
325
|
|
327
326
|
## How it works
|
@@ -410,9 +409,9 @@ repository.
|
|
410
409
|
|
411
410
|
## Submodules
|
412
411
|
|
413
|
-
- `boto3-stubs[full]` - Type annotations for all
|
412
|
+
- `boto3-stubs[full]` - Type annotations for all 400 services in one package
|
414
413
|
(recommended).
|
415
|
-
- `boto3-stubs[all]` - Type annotations for all
|
414
|
+
- `boto3-stubs[all]` - Type annotations for all 400 services in separate
|
416
415
|
packages.
|
417
416
|
- `boto3-stubs[essential]` - Type annotations for
|
418
417
|
[CloudFormation](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/),
|
@@ -925,6 +924,9 @@ repository.
|
|
925
924
|
- `boto3-stubs[internetmonitor]` - Type annotations for
|
926
925
|
[CloudWatchInternetMonitor](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_internetmonitor/)
|
927
926
|
service.
|
927
|
+
- `boto3-stubs[invoicing]` - Type annotations for
|
928
|
+
[Invoicing](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_invoicing/)
|
929
|
+
service.
|
928
930
|
- `boto3-stubs[iot]` - Type annotations for
|
929
931
|
[IoT](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/) service.
|
930
932
|
- `boto3-stubs[iot-data]` - Type annotations for
|
@@ -1177,6 +1179,9 @@ repository.
|
|
1177
1179
|
- `boto3-stubs[network-firewall]` - Type annotations for
|
1178
1180
|
[NetworkFirewall](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_network_firewall/)
|
1179
1181
|
service.
|
1182
|
+
- `boto3-stubs[networkflowmonitor]` - Type annotations for
|
1183
|
+
[NetworkFlowMonitor](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_networkflowmonitor/)
|
1184
|
+
service.
|
1180
1185
|
- `boto3-stubs[networkmanager]` - Type annotations for
|
1181
1186
|
[NetworkManager](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_networkmanager/)
|
1182
1187
|
service.
|
@@ -1406,6 +1411,9 @@ repository.
|
|
1406
1411
|
- `boto3-stubs[secretsmanager]` - Type annotations for
|
1407
1412
|
[SecretsManager](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_secretsmanager/)
|
1408
1413
|
service.
|
1414
|
+
- `boto3-stubs[security-ir]` - Type annotations for
|
1415
|
+
[SecurityIncidentResponse](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_security_ir/)
|
1416
|
+
service.
|
1409
1417
|
- `boto3-stubs[securityhub]` - Type annotations for
|
1410
1418
|
[SecurityHub](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_securityhub/)
|
1411
1419
|
service.
|
@@ -191,6 +191,7 @@ from mypy_boto3_inspector.client import InspectorClient
|
|
191
191
|
from mypy_boto3_inspector2.client import Inspector2Client
|
192
192
|
from mypy_boto3_inspector_scan.client import InspectorscanClient
|
193
193
|
from mypy_boto3_internetmonitor.client import CloudWatchInternetMonitorClient
|
194
|
+
from mypy_boto3_invoicing.client import InvoicingClient
|
194
195
|
from mypy_boto3_iot.client import IoTClient
|
195
196
|
from mypy_boto3_iot1click_devices.client import IoT1ClickDevicesServiceClient
|
196
197
|
from mypy_boto3_iot1click_projects.client import IoT1ClickProjectsClient
|
@@ -281,6 +282,7 @@ from mypy_boto3_neptune.client import NeptuneClient
|
|
281
282
|
from mypy_boto3_neptune_graph.client import NeptuneGraphClient
|
282
283
|
from mypy_boto3_neptunedata.client import NeptuneDataClient
|
283
284
|
from mypy_boto3_network_firewall.client import NetworkFirewallClient
|
285
|
+
from mypy_boto3_networkflowmonitor.client import NetworkFlowMonitorClient
|
284
286
|
from mypy_boto3_networkmanager.client import NetworkManagerClient
|
285
287
|
from mypy_boto3_networkmonitor.client import CloudWatchNetworkMonitorClient
|
286
288
|
from mypy_boto3_notifications.client import UserNotificationsClient
|
@@ -361,6 +363,7 @@ from mypy_boto3_scheduler.client import EventBridgeSchedulerClient
|
|
361
363
|
from mypy_boto3_schemas.client import SchemasClient
|
362
364
|
from mypy_boto3_sdb.client import SimpleDBClient
|
363
365
|
from mypy_boto3_secretsmanager.client import SecretsManagerClient
|
366
|
+
from mypy_boto3_security_ir.client import SecurityIncidentResponseClient
|
364
367
|
from mypy_boto3_securityhub.client import SecurityHubClient
|
365
368
|
from mypy_boto3_securitylake.client import SecurityLakeClient
|
366
369
|
from mypy_boto3_serverlessrepo.client import ServerlessApplicationRepositoryClient
|
@@ -2700,6 +2703,19 @@ def client(
|
|
2700
2703
|
config: Optional[Config] = ...,
|
2701
2704
|
) -> CloudWatchInternetMonitorClient: ...
|
2702
2705
|
@overload
|
2706
|
+
def client(
|
2707
|
+
service_name: Literal["invoicing"],
|
2708
|
+
region_name: Optional[str] = ...,
|
2709
|
+
api_version: Optional[str] = ...,
|
2710
|
+
use_ssl: Optional[bool] = ...,
|
2711
|
+
verify: Union[bool, str, None] = ...,
|
2712
|
+
endpoint_url: Optional[str] = ...,
|
2713
|
+
aws_access_key_id: Optional[str] = ...,
|
2714
|
+
aws_secret_access_key: Optional[str] = ...,
|
2715
|
+
aws_session_token: Optional[str] = ...,
|
2716
|
+
config: Optional[Config] = ...,
|
2717
|
+
) -> InvoicingClient: ...
|
2718
|
+
@overload
|
2703
2719
|
def client(
|
2704
2720
|
service_name: Literal["iot"],
|
2705
2721
|
region_name: Optional[str] = ...,
|
@@ -3818,6 +3834,19 @@ def client(
|
|
3818
3834
|
config: Optional[Config] = ...,
|
3819
3835
|
) -> NetworkFirewallClient: ...
|
3820
3836
|
@overload
|
3837
|
+
def client(
|
3838
|
+
service_name: Literal["networkflowmonitor"],
|
3839
|
+
region_name: Optional[str] = ...,
|
3840
|
+
api_version: Optional[str] = ...,
|
3841
|
+
use_ssl: Optional[bool] = ...,
|
3842
|
+
verify: Union[bool, str, None] = ...,
|
3843
|
+
endpoint_url: Optional[str] = ...,
|
3844
|
+
aws_access_key_id: Optional[str] = ...,
|
3845
|
+
aws_secret_access_key: Optional[str] = ...,
|
3846
|
+
aws_session_token: Optional[str] = ...,
|
3847
|
+
config: Optional[Config] = ...,
|
3848
|
+
) -> NetworkFlowMonitorClient: ...
|
3849
|
+
@overload
|
3821
3850
|
def client(
|
3822
3851
|
service_name: Literal["networkmanager"],
|
3823
3852
|
region_name: Optional[str] = ...,
|
@@ -4832,6 +4861,19 @@ def client(
|
|
4832
4861
|
config: Optional[Config] = ...,
|
4833
4862
|
) -> SecretsManagerClient: ...
|
4834
4863
|
@overload
|
4864
|
+
def client(
|
4865
|
+
service_name: Literal["security-ir"],
|
4866
|
+
region_name: Optional[str] = ...,
|
4867
|
+
api_version: Optional[str] = ...,
|
4868
|
+
use_ssl: Optional[bool] = ...,
|
4869
|
+
verify: Union[bool, str, None] = ...,
|
4870
|
+
endpoint_url: Optional[str] = ...,
|
4871
|
+
aws_access_key_id: Optional[str] = ...,
|
4872
|
+
aws_secret_access_key: Optional[str] = ...,
|
4873
|
+
aws_session_token: Optional[str] = ...,
|
4874
|
+
config: Optional[Config] = ...,
|
4875
|
+
) -> SecurityIncidentResponseClient: ...
|
4876
|
+
@overload
|
4835
4877
|
def client(
|
4836
4878
|
service_name: Literal["securityhub"],
|
4837
4879
|
region_name: Optional[str] = ...,
|
@@ -1,11 +1,17 @@
|
|
1
|
+
"""
|
2
|
+
Type annotations for boto3.crt module.
|
3
|
+
|
4
|
+
Copyright 2024 Vlad Emelianov
|
5
|
+
"""
|
6
|
+
|
1
7
|
import threading
|
2
|
-
from typing import Any
|
8
|
+
from typing import Any
|
3
9
|
|
4
10
|
from botocore.client import BaseClient
|
5
11
|
from s3transfer.crt import BotocoreCRTRequestSerializer, CRTTransferManager
|
6
12
|
|
7
|
-
CRT_S3_CLIENT:
|
8
|
-
BOTOCORE_CRT_SERIALIZER:
|
13
|
+
CRT_S3_CLIENT: CRTS3Client | None = ...
|
14
|
+
BOTOCORE_CRT_SERIALIZER: BotocoreCRTRequestSerializer | None = ...
|
9
15
|
|
10
16
|
CLIENT_CREATION_LOCK: threading.Lock = ...
|
11
17
|
PROCESS_LOCK_NAME: str = ...
|
@@ -19,6 +25,4 @@ class CRTS3Client:
|
|
19
25
|
|
20
26
|
def is_crt_compatible_request(client: BaseClient, crt_s3_client: CRTS3Client) -> bool: ...
|
21
27
|
def compare_identity(boto3_creds: Any, crt_s3_creds: Any) -> bool: ...
|
22
|
-
def create_crt_transfer_manager(
|
23
|
-
client: BaseClient, config: Any
|
24
|
-
) -> Optional[CRTTransferManager]: ...
|
28
|
+
def create_crt_transfer_manager(client: BaseClient, config: Any) -> CRTTransferManager | None: ...
|
@@ -1,4 +1,8 @@
|
|
1
|
-
|
1
|
+
"""
|
2
|
+
Type annotations for boto3.docs.action module.
|
3
|
+
|
4
|
+
Copyright 2024 Vlad Emelianov
|
5
|
+
"""
|
2
6
|
|
3
7
|
from boto3.resources.model import Action
|
4
8
|
from botocore.docs.bcdoc.restdoc import DocumentStructure
|
@@ -8,8 +12,8 @@ from botocore.model import ServiceModel
|
|
8
12
|
from .base import NestedDocumenter
|
9
13
|
|
10
14
|
PUT_DATA_WARNING_MESSAGE: str
|
11
|
-
WARNING_MESSAGES:
|
12
|
-
IGNORE_PARAMS:
|
15
|
+
WARNING_MESSAGES: dict[str, dict[str, str]]
|
16
|
+
IGNORE_PARAMS: dict[str, dict[str, list[str]]]
|
13
17
|
|
14
18
|
class ActionDocumenter(NestedDocumenter):
|
15
19
|
def document_actions(self, section: DocumentStructure) -> None: ...
|
@@ -1,7 +1,13 @@
|
|
1
|
-
|
1
|
+
"""
|
2
|
+
Type annotations for boto3.docs.base module.
|
3
|
+
|
4
|
+
Copyright 2024 Vlad Emelianov
|
5
|
+
"""
|
6
|
+
|
7
|
+
from typing import Any
|
2
8
|
|
3
9
|
class BaseDocumenter:
|
4
|
-
member_map:
|
10
|
+
member_map: dict[str, Any]
|
5
11
|
represents_service_resource: Any
|
6
12
|
def __init__(self, resource: Any) -> None: ...
|
7
13
|
@property
|
@@ -0,0 +1,27 @@
|
|
1
|
+
"""
|
2
|
+
Type annotations for boto3.docs.method module.
|
3
|
+
|
4
|
+
Copyright 2024 Vlad Emelianov
|
5
|
+
"""
|
6
|
+
|
7
|
+
from typing import Any
|
8
|
+
|
9
|
+
from boto3.resources.model import Action
|
10
|
+
from botocore.docs.bcdoc.restdoc import DocumentStructure
|
11
|
+
from botocore.hooks import BaseEventHooks
|
12
|
+
|
13
|
+
def document_model_driven_resource_method(
|
14
|
+
section: DocumentStructure,
|
15
|
+
method_name: str,
|
16
|
+
operation_model: Any,
|
17
|
+
event_emitter: BaseEventHooks,
|
18
|
+
method_description: str | None = ...,
|
19
|
+
example_prefix: str | None = ...,
|
20
|
+
include_input: Any | None = ...,
|
21
|
+
include_output: Any | None = ...,
|
22
|
+
exclude_input: Any | None = ...,
|
23
|
+
exclude_output: Any | None = ...,
|
24
|
+
document_output: bool = ...,
|
25
|
+
resource_action_model: Action | None = ...,
|
26
|
+
include_signature: bool = ...,
|
27
|
+
) -> None: ...
|
@@ -1,4 +1,8 @@
|
|
1
|
-
|
1
|
+
"""
|
2
|
+
Type annotations for boto3.docs.service module.
|
3
|
+
|
4
|
+
Copyright 2024 Vlad Emelianov
|
5
|
+
"""
|
2
6
|
|
3
7
|
from botocore.docs.bcdoc.restdoc import DocumentStructure
|
4
8
|
from botocore.docs.service import ServiceDocumenter as BaseServiceDocumenter
|
@@ -6,7 +10,7 @@ from botocore.session import Session
|
|
6
10
|
|
7
11
|
class ServiceDocumenter(BaseServiceDocumenter):
|
8
12
|
EXAMPLE_PATH: str
|
9
|
-
sections:
|
13
|
+
sections: list[str]
|
10
14
|
def __init__(self, service_name: str, session: Session, root_docs_path: str) -> None: ...
|
11
15
|
def document_service(self) -> bytes: ...
|
12
16
|
def client_api(self, section: DocumentStructure) -> None: ...
|