<a id="mypy-boto3-cloudcontrol"></a>
# mypy-boto3-cloudcontrol
[![PyPI - mypy-boto3-cloudcontrol](https://img.shields.io/pypi/v/mypy-boto3-cloudcontrol.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudcontrol)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cloudcontrol.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudcontrol)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-cloudcontrol?color=blue)](https://pypistats.org/packages/mypy-boto3-cloudcontrol)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.CloudControlApi 1.18.60](https://boto3.amazonaws.com/v1/documentation/api/1.18.60/reference/services/cloudcontrol.html#CloudControlApi)
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-builder 5.5.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudcontrol docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_cloudcontrol/)
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-cloudcontrol](#mypy-boto3-cloudcontrol)
- [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)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
Install `boto3-stubs` for `CloudControlApi` service.
```bash
python -m pip install boto3-stubs[cloudcontrol]
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### 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[cloudcontrol]` in your environment:
`python -m pip install 'boto3-stubs[cloudcontrol]'`
Both type checking and auto-complete should work for `CloudControlApi` service.
No explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[cloudcontrol]` in your environment:
`python -m pip install 'boto3-stubs[cloudcontrol]'`
Both type checking and auto-complete should work for `CloudControlApi` 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.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[cloudcontrol]` in your environment:
`python -m pip install 'boto3-stubs[cloudcontrol]'`
- Run `mypy` as usual
Type checking should work for `CloudControlApi` service. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[cloudcontrol]` in your environment:
`python -m pip install 'boto3-stubs[cloudcontrol]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CloudControlApi` service. No explicit type
annotations required, write your `boto3` code as usual.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`CloudControlApiClient` provides annotations for
`boto3.client("cloudcontrol")`.
```python
import boto3
from mypy_boto3_cloudcontrol import CloudControlApiClient
client: CloudControlApiClient = boto3.client("cloudcontrol")
# 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: CloudControlApiClient = session.client("cloudcontrol")
```
<a id="waiters-annotations"></a>
### Waiters annotations
`mypy_boto3_cloudcontrol.waiter` module contains type annotations for all
waiters.
```python
from mypy_boto3_cloudcontrol import CloudControlApiClient
from mypy_boto3_cloudcontrol.waiter import (
ResourceRequestSuccessWaiter,
)
client: CloudControlApiClient = boto3.client("cloudcontrol")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
resource_request_success_waiter: ResourceRequestSuccessWaiter = client.get_waiter("resource_request_success")
```
<a id="literals"></a>
### Literals
`mypy_boto3_cloudcontrol.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_cloudcontrol.literals import (
HandlerErrorCodeType,
OperationStatusType,
OperationType,
ResourceRequestSuccessWaiterName,
ServiceName,
WaiterName,
)
def check_value(value: HandlerErrorCodeType) -> bool:
...
```
<a id="typed-dictionaries"></a>
### Typed dictionaries
`mypy_boto3_cloudcontrol.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudcontrol.type_defs import (
CancelResourceRequestInputRequestTypeDef,
CancelResourceRequestOutputTypeDef,
CreateResourceInputRequestTypeDef,
CreateResourceOutputTypeDef,
DeleteResourceInputRequestTypeDef,
DeleteResourceOutputTypeDef,
GetResourceInputRequestTypeDef,
GetResourceOutputTypeDef,
GetResourceRequestStatusInputRequestTypeDef,
GetResourceRequestStatusOutputTypeDef,
ListResourceRequestsInputRequestTypeDef,
ListResourceRequestsOutputTypeDef,
ListResourcesInputRequestTypeDef,
ListResourcesOutputTypeDef,
ProgressEventTypeDef,
ResourceDescriptionTypeDef,
ResourceRequestStatusFilterTypeDef,
ResponseMetadataTypeDef,
UpdateResourceInputRequestTypeDef,
UpdateResourceOutputTypeDef,
WaiterConfigTypeDef,
)
def get_structure() -> CancelResourceRequestInputRequestTypeDef:
return {
...
}
```
<a id="versioning"></a>
## Versioning
`mypy-boto3-cloudcontrol` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
<a id="documentation"></a>
## Documentation
All type annotations can be found in
[mypy-boto3-cloudcontrol docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_cloudcontrol/)
<a id="support-and-contributing"></a>
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder/issues/)
repository.
PyPI 官网下载 | mypy-boto3-cloudcontrol-1.18.60.tar.gz
版权申诉
107 浏览量
2022-02-01
09:50:41
上传
评论
收藏 11KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- Picasso_v3.1 2.ipa
- chromedriver-mac-arm64.zip
- 蓝zapro.apk
- chromedriver-linux64.zip
- UCAS研一深度学习实验-MNIST手写数字识别python源码+详细注释(高分项目)
- 基于Python和PyTorch框架完成的一个手写数字识别实验源码(带MINIST手写数字数据集)+详细注释(高分项目)
- 基于Matlab在MNIST数据集上利用CNN完成手写体数字识别任务,并实现单层CNN反向传播算法+源代码+文档说明(高分项目)
- NVIDIA驱动、CUDA和Pytorch及其依赖
- 基于SVM多特征融合的微表情识别python源码+项目说明+详细注释(高分课程设计)
- html动态爱心代码一(附源码)
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
评论0