<a id="mypy-boto3-cloudwatch"></a>
# mypy-boto3-cloudwatch
[![PyPI - mypy-boto3-cloudwatch](https://img.shields.io/pypi/v/mypy-boto3-cloudwatch.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudwatch)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cloudwatch.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudwatch)
[![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-cloudwatch?color=blue)](https://pypistats.org/packages/mypy-boto3-cloudwatch)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.CloudWatch 1.17.90](https://boto3.amazonaws.com/v1/documentation/api/1.17.90/reference/services/cloudwatch.html#CloudWatch)
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.16.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-cloudwatch docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_cloudwatch/)
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-cloudwatch](#mypy-boto3-cloudwatch)
- [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)
- [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 `CloudWatch` service.
```bash
python -m pip install boto3-stubs[cloudwatch]
```
<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[cloudwatch]` in your environment:
`python -m pip install 'boto3-stubs[cloudwatch]'`
Both type checking and auto-complete should work for `CloudWatch` service. No
explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[cloudwatch]` in your environment:
`python -m pip install 'boto3-stubs[cloudwatch]'`
Both type checking and auto-complete should work for `CloudWatch` 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 support `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[cloudwatch]` in your environment:
`python -m pip install 'boto3-stubs[cloudwatch]'`
- Run `mypy` as usual
Type checking should work for `CloudWatch` 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[cloudwatch]` in your environment:
`python -m pip install 'boto3-stubs[cloudwatch]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CloudWatch` 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
`CloudWatchClient` provides annotations for `boto3.client("cloudwatch")`.
```python
import boto3
from mypy_boto3_cloudwatch import CloudWatchClient
client: CloudWatchClient = boto3.client("cloudwatch")
# 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: CloudWatchClient = session.client("cloudwatch")
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_cloudwatch.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_cloudwatch import CloudWatchClient
from mypy_boto3_cloudwatch.paginator import (
DescribeAlarmHistoryPaginator,
DescribeAlarmsPaginator,
GetMetricDataPaginator,
ListDashboardsPaginator,
ListMetricsPaginator,
)
client: CloudWatchClient = boto3.client("cloudwatch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_alarm_history_paginator: DescribeAlarmHistoryPaginator = client.get_paginator("describe_alarm_history")
describe_alarms_paginator: DescribeAlarmsPaginator = client.get_paginator("describe_alarms")
get_metric_data_paginator: GetMetricDataPaginator = client.get_paginator("get_metric_data")
list_dashboards_paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards")
list_metrics_paginator: ListMetricsPaginator = client.get_paginator("list_metrics")
```
<a id="waiters-annotations"></a>
### Waiters annotations
`mypy_boto3_cloudwatch.waiter` module contains type annotations for all
waiters.
```python
from mypy_boto3_cloudwatch import CloudWatchClient
from mypy_boto3_cloudwatch.waiter import (
AlarmExistsWaiter,
CompositeAlarmExistsWaiter,
)
client: CloudWatchClient = boto3.client("cloudwatch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
alarm_exists_waiter: AlarmExistsWaiter = client.get_waiter("alarm_exists")
composite_alarm_exists_waiter: CompositeAlarmExistsWaiter = client.get_waiter("composite_alarm_exists")
```
<a id="service-resource-annotations"></a>
### Service Resource annotations
`CloudWatchServiceResource` provides annotations for
`boto3.resource("cloudwatch")`.
```python
from mypy_boto3_cloudwatch import CloudWatchServiceResource
resource: CloudWatchServiceResource = boto3.resource("cloudwatch")
# now resource 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_resource: CloudWatchServiceResource = session.resource("cloudwatch")
```
<a id="other-resources-annotations"></a>
### Other resources annotations
`mypy_boto3_cloudwatch.service_resource` module contains type annotations for
all resources.
```python
from mypy_boto3_cloudwatch import CloudWatchServiceResource
from mypy_boto3_cloudwatch.service_resource import (
Alarm,
Metric,
)
resource: CloudWatchServiceResource = boto3.resource("cloudwatch")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_alarm: Alarm = resource.Alarm(...)
my_metric: Metric = resource.Metric(...)
```
<a id="collections-annotations"></a>
### Collections annotations
`mypy_boto3_cloudwatch.service_resource` module contains type annota
没有合适的资源?快使用搜索试试~ 我知道了~
PyPI 官网下载 | mypy-boto3-cloudwatch-1.17.90.post1.tar.gz
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 146 浏览量
2022-01-13
12:11:09
上传
评论
收藏 18KB GZ 举报
温馨提示
共27个文件
py:10个
pyi:7个
txt:4个
资源来自pypi官网。 资源全名:mypy-boto3-cloudwatch-1.17.90.post1.tar.gz
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-cloudwatch-1.17.90.post1.tar.gz (27个子文件)
mypy-boto3-cloudwatch-1.17.90.post1
PKG-INFO 16KB
mypy_boto3_cloudwatch.egg-info
PKG-INFO 16KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 879B
top_level.txt 22B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
mypy_boto3_cloudwatch
type_defs.py 16KB
py.typed 0B
waiter.py 3KB
type_defs.pyi 16KB
literals.py 3KB
client.py 26KB
__main__.py 749B
waiter.pyi 3KB
__init__.py 2KB
service_resource.pyi 15KB
client.pyi 26KB
paginator.pyi 7KB
paginator.py 7KB
version.py 61B
literals.pyi 3KB
__init__.pyi 2KB
service_resource.py 15KB
README.md 12KB
共 27 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功