# mypy-boto3-opsworkscm<a id="mypy-boto3-opsworkscm"></a>
[![PyPI - mypy-boto3-opsworkscm](https://img.shields.io/pypi/v/mypy-boto3-opsworkscm.svg?color=blue)](https://pypi.org/project/mypy-boto3-opsworkscm)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-opsworkscm.svg?color=blue)](https://pypi.org/project/mypy-boto3-opsworkscm)
[![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-opsworkscm?color=blue)](https://pypistats.org/packages/mypy-boto3-opsworkscm)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.OpsWorksCM 1.17.72](https://boto3.amazonaws.com/v1/documentation/api/1.17.72/reference/services/opsworkscm.html#OpsWorksCM)
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.13.1](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-opsworkscm docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_opsworkscm/)
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-opsworkscm](#mypy-boto3-opsworkscm)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
## How to install<a id="how-to-install"></a>
Install `boto3-stubs` for `OpsWorksCM` service.
```bash
python -m pip install boto3-stubs[opsworkscm]
```
## Usage<a id="usage"></a>
### VSCode<a id="vscode"></a>
- 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[opsworkscm]` in your environment:
`python -m pip install 'boto3-stubs[opsworkscm]'`
Both type checking and auto-complete should work for `OpsWorksCM` service. No
explicit type annotations required, write your `boto3` code as usual.
### PyCharm<a id="pycharm"></a>
- Install `boto-stubs[opsworkscm]` in your environment:
`python -m pip install 'boto3-stubs[opsworkscm]'`
Both type checking and auto-complete should work for `OpsWorksCM` 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<a id="other-ides"></a>
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
### mypy<a id="mypy"></a>
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[opsworkscm]` in your environment:
`python -m pip install 'boto3-stubs[opsworkscm]'`
- Run `mypy` as usual
Type checking should work for `OpsWorksCM` service. No explicit type
annotations required, write your `boto3` code as usual.
### pyright<a id="pyright"></a>
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[opsworkscm]` in your environment:
`python -m pip install 'boto3-stubs[opsworkscm]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `OpsWorksCM` service. No explicit type
annotations required, write your `boto3` code as usual.
## Explicit type annotations<a id="explicit-type-annotations"></a>
### Client annotations<a id="client-annotations"></a>
`OpsWorksCMClient` provides annotations for `boto3.client("opsworkscm")`.
```python
import boto3
from mypy_boto3_opsworkscm import OpsWorksCMClient
client: OpsWorksCMClient = boto3.client("opsworkscm")
# 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: OpsWorksCMClient = session.client("opsworkscm")
```
### Paginators annotations<a id="paginators-annotations"></a>
`mypy_boto3_opsworkscm.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_opsworkscm import OpsWorksCMClient
from mypy_boto3_opsworkscm.paginator import (
DescribeBackupsPaginator,
DescribeEventsPaginator,
DescribeServersPaginator,
ListTagsForResourcePaginator,
)
client: OpsWorksCMClient = boto3.client("opsworkscm")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups")
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_servers_paginator: DescribeServersPaginator = client.get_paginator("describe_servers")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
```
### Waiters annotations<a id="waiters-annotations"></a>
`mypy_boto3_opsworkscm.waiter` module contains type annotations for all
waiters.
```python
from mypy_boto3_opsworkscm import OpsWorksCMClient
from mypy_boto3_opsworkscm.waiter import (
NodeAssociatedWaiter,
)
client: OpsWorksCMClient = boto3.client("opsworkscm")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
node_associated_waiter: NodeAssociatedWaiter = client.get_waiter("node_associated")
```
### Literals<a id="literals"></a>
`mypy_boto3_opsworkscm.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_opsworkscm.literals import (
BackupStatusType,
BackupTypeType,
DescribeBackupsPaginatorName,
DescribeEventsPaginatorName,
DescribeServersPaginatorName,
ListTagsForResourcePaginatorName,
MaintenanceStatusType,
NodeAssociatedWaiterName,
NodeAssociationStatusType,
ServerStatusType,
)
def check_value(value: BackupStatusType) -> bool:
...
```
### Typed dictionaries<a id="typed-dictionaries"></a>
`mypy_boto3_opsworkscm.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_opsworkscm.type_defs import (
AccountAttributeTypeDef,
AssociateNodeResponseTypeDef,
BackupTypeDef,
CreateBackupResponseTypeDef,
CreateServerResponseTypeDef,
DescribeAccountAttributesResponseTypeDef,
DescribeBackupsResponseTypeDef,
DescribeEventsResponseTypeDef,
DescribeNodeAssociationStatusResponseTypeDef,
DescribeServersResponseTypeDef,
DisassociateNodeResponseTypeDef,
EngineAttributeTypeDef,
ExportServerEngineAttributeResponseTypeDef,
ListTagsForResourceResponseTypeDef,
PaginatorConfigTypeDef,
ServerEventTypeDef,
ServerTypeDef,
StartMaintenanceResponseTypeDef,
TagTypeDef,
UpdateServerEngineAttributesResponseTypeDef,
UpdateServerResponseTypeDef,
WaiterConfigTypeDef,
)
def get_structure() -> AccountAttributeTypeDef:
return {
...
}
```
## Versioning<a id="versioning"></a>
`mypy-boto3-op
PyPI 官网下载 | mypy-boto3-opsworkscm-1.17.72.post1.tar.gz
版权申诉
108 浏览量
2022-01-14
02:20:56
上传
评论
收藏 11KB GZ 举报
![avatar](https://profile-avatar.csdnimg.cn/277f6345dca0446498fbbc03843436aa_qq_38161040.jpg!1)
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- TIA博途 WinCC下载到面板时,提示错误:“装载过程终止由于传输错误:8020AB001A06FFF4!”解决办法.docx
- 一个简单的C#人事管理系统.rar
- 一个基本的图书管理系统.rar
- Python合并两张图片.rar
- matlab画图.rar
- VerilogVHDL\FPGA入门教程FPGA器件边练边学-快速入门Verilogvhdl
- 基于C++的mfc的仿QQ聊天系统(高分课程设计期末大作业)
- 基于Java web的学生管理系统(源码+数据库+报告)高分项目
- 基于Java web的学生管理系统(源码+数据库+报告)期末大作业&课程设计
- FM1702SL芯片13.56MHZ NFC读卡器开发板PROTELPCB图+FM1702SL中文说明书+FM1715编程指南
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
![feedback](https://img-home.csdnimg.cn/images/20220527035711.png)
![feedback](https://img-home.csdnimg.cn/images/20220527035711.png)
![feedback-tip](https://img-home.csdnimg.cn/images/20220527035111.png)