# mypy-boto3-eks
[![PyPI - mypy-boto3-eks](https://img.shields.io/pypi/v/mypy-boto3-eks.svg?color=blue)](https://pypi.org/project/mypy-boto3-eks)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-eks.svg?color=blue)](https://pypi.org/project/mypy-boto3-eks)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.EKS 1.17.5](https://boto3.amazonaws.com/v1/documentation/api/1.17.5/reference/services/eks.html#EKS) service
compatible with
[VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright)
and other tools.
Generated by [mypy-boto3-buider 4.4.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-eks](#mypy-boto3-eks)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Service Resource annotations](#service-resource-annotations)
- [Other resources annotations](#other-resources-annotations)
- [Collections annotations](#collections-annotations)
- [Typed dictionations](#typed-dictionations)
## How to install
Install `boto3-stubs` for `EKS` service.
```bash
python -m pip install boto3-stubs[eks]
```
## Usage
### VSCode
- Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[eks]` in your environment: `python -m pip install 'boto3-stubs[eks]'`
Both type checking and auto-complete should work for `EKS` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[eks]` in your environment: `python -m pip install 'boto3-stubs[eks]'`
Both type checking and auto-complete should work for `EKS` service.
No explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[eks]` in your environment: `python -m pip install 'boto3-stubs[eks]'`
- Run `mypy` as usual
Type checking should work for `EKS` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[eks]` in your environment: `python -m pip install 'boto3-stubs[eks]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `EKS` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`EKSClient` provides annotations for `boto3.client("eks")`.
```python
import boto3
from mypy_boto3_eks import EKSClient
client: EKSClient = boto3.client("eks")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: EKSClient = session.client("eks")
```
### Paginators annotations
`mypy_boto3_eks.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_eks import EKSClient
from mypy_boto3_eks.paginator import (
DescribeAddonVersionsPaginator,
ListAddonsPaginator,
ListClustersPaginator,
ListFargateProfilesPaginator,
ListNodegroupsPaginator,
ListUpdatesPaginator,
)
client: EKSClient = boto3.client("eks")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_addon_versions_paginator: DescribeAddonVersionsPaginator = client.get_paginator("describe_addon_versions")
list_addons_paginator: ListAddonsPaginator = client.get_paginator("list_addons")
list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
list_fargate_profiles_paginator: ListFargateProfilesPaginator = client.get_paginator("list_fargate_profiles")
list_nodegroups_paginator: ListNodegroupsPaginator = client.get_paginator("list_nodegroups")
list_updates_paginator: ListUpdatesPaginator = client.get_paginator("list_updates")
```
### Waiters annotations
`mypy_boto3_eks.waiter` module contains type annotations for all waiters.
```python
from mypy_boto3_eks import EKSClient
from mypy_boto3_eks.waiter import (
AddonActiveWaiter,
AddonDeletedWaiter,
ClusterActiveWaiter,
ClusterDeletedWaiter,
NodegroupActiveWaiter,
NodegroupDeletedWaiter,
)
client: EKSClient = boto3.client("eks")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
addon_active_waiter: AddonActiveWaiter = client.get_waiter("addon_active")
addon_deleted_waiter: AddonDeletedWaiter = client.get_waiter("addon_deleted")
cluster_active_waiter: ClusterActiveWaiter = client.get_waiter("cluster_active")
cluster_deleted_waiter: ClusterDeletedWaiter = client.get_waiter("cluster_deleted")
nodegroup_active_waiter: NodegroupActiveWaiter = client.get_waiter("nodegroup_active")
nodegroup_deleted_waiter: NodegroupDeletedWaiter = client.get_waiter("nodegroup_deleted")
```
### Typed dictionations
`mypy_boto3_eks.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_eks.type_defs import (
AddonHealthTypeDef,
AddonInfoTypeDef,
AddonIssueTypeDef,
AddonTypeDef,
AddonVersionInfoTypeDef,
AutoScalingGroupTypeDef,
CertificateTypeDef,
ClusterTypeDef,
CompatibilityTypeDef,
EncryptionConfigTypeDef,
ErrorDetailTypeDef,
FargateProfileSelectorTypeDef,
FargateProfileTypeDef,
IdentityTypeDef,
IssueTypeDef,
KubernetesNetworkConfigResponseTypeDef,
LaunchTemplateSpecificationTypeDef,
LogSetupTypeDef,
LoggingTypeDef,
NodegroupHealthTypeDef,
NodegroupResourcesTypeDef,
NodegroupScalingConfigTypeDef,
NodegroupTypeDef,
OIDCTypeDef,
ProviderTypeDef,
RemoteAccessConfigTypeDef,
UpdateParamTypeDef,
UpdateTypeDef,
VpcConfigResponseTypeDef,
CreateAddonResponseTypeDef,
CreateClusterResponseTypeDef,
CreateFargateProfileResponseTypeDef,
CreateNodegroupResponseTypeDef,
DeleteAddonResponseTypeDef,
DeleteClusterResponseTypeDef,
DeleteFargateProfileResponseTypeDef,
DeleteNodegroupResponseTypeDef,
DescribeAddonResponseTypeDef,
DescribeAddonVersionsResponseTypeDef,
DescribeClusterResponseTypeDef,
DescribeFargateProfileResponseTypeDef,
DescribeNodegroupResponseTypeDef,
DescribeUpdateResponseTypeDef,
KubernetesNetworkConfigRequestTypeDef,
ListAddonsResponseTypeDef,
ListClustersResponseTypeDef,
ListFargateProfilesResponseTypeDef,
ListNodegroupsResponseTypeDef,
ListTagsForResourceResponseTypeDef,
ListUpdatesResponseTypeDef,
PaginatorConfigTypeDef,
UpdateAddonRe
PyPI 官网下载 | mypy-boto3-eks-1.17.5.0.tar.gz
版权申诉
2 浏览量
2022-01-28
16:10:50
上传
评论
收藏 13KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- 基于C++的二叉排序树(免费提供源码)
- demo(1).zip
- 网页版扫雷image文件
- matlab+数据预处理+ARIMA预测+异常值+检测+适用于各种类型的数据集
- mubanyuanshizhan-0604-24
- Python旅游数据爬虫及可视化展示源码
- 基于MFC恶意PE,Android签名流检测系统框架 vs2022 + c/c++ + mfc + PE + APK
- 基于MFC恶意文件检测系统 框架 vs2022 + c/c++ + hook + PE + inject + 动态调试工具Imm
- 基于MFC恶意文件检测系统框架 vs2022 + c/c++ + hook + PE + inject + 动态调试工具Imm
- 八路抢答器电子工艺实习报告
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈