# mypy-boto3-elasticache<a id="mypy-boto3-elasticache"></a>
[![PyPI - mypy-boto3-elasticache](https://img.shields.io/pypi/v/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-elasticache.svg?color=blue)](https://pypi.org/project/mypy-boto3-elasticache)
[![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-elasticache?color=blue)](https://pypistats.org/packages/mypy-boto3-elasticache)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.ElastiCache 1.17.90](https://boto3.amazonaws.com/v1/documentation/api/1.17.90/reference/services/elasticache.html#ElastiCache)
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.15.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-elasticache docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_elasticache/)
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-elasticache](#mypy-boto3-elasticache)
- [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 `ElastiCache` service.
```bash
python -m pip install boto3-stubs[elasticache]
```
## 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[elasticache]` in your environment:
`python -m pip install 'boto3-stubs[elasticache]'`
Both type checking and auto-complete should work for `ElastiCache` service. No
explicit type annotations required, write your `boto3` code as usual.
### PyCharm<a id="pycharm"></a>
- Install `boto-stubs[elasticache]` in your environment:
`python -m pip install 'boto3-stubs[elasticache]'`
Both type checking and auto-complete should work for `ElastiCache` 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[elasticache]` in your environment:
`python -m pip install 'boto3-stubs[elasticache]'`
- Run `mypy` as usual
Type checking should work for `ElastiCache` 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[elasticache]` in your environment:
`python -m pip install 'boto3-stubs[elasticache]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `ElastiCache` 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>
`ElastiCacheClient` provides annotations for `boto3.client("elasticache")`.
```python
import boto3
from mypy_boto3_elasticache import ElastiCacheClient
client: ElastiCacheClient = boto3.client("elasticache")
# 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: ElastiCacheClient = session.client("elasticache")
```
### Paginators annotations<a id="paginators-annotations"></a>
`mypy_boto3_elasticache.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_elasticache import ElastiCacheClient
from mypy_boto3_elasticache.paginator import (
DescribeCacheClustersPaginator,
DescribeCacheEngineVersionsPaginator,
DescribeCacheParameterGroupsPaginator,
DescribeCacheParametersPaginator,
DescribeCacheSecurityGroupsPaginator,
DescribeCacheSubnetGroupsPaginator,
DescribeEngineDefaultParametersPaginator,
DescribeEventsPaginator,
DescribeGlobalReplicationGroupsPaginator,
DescribeReplicationGroupsPaginator,
DescribeReservedCacheNodesPaginator,
DescribeReservedCacheNodesOfferingsPaginator,
DescribeServiceUpdatesPaginator,
DescribeSnapshotsPaginator,
DescribeUpdateActionsPaginator,
DescribeUserGroupsPaginator,
DescribeUsersPaginator,
)
client: ElastiCacheClient = boto3.client("elasticache")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_cache_clusters_paginator: DescribeCacheClustersPaginator = client.get_paginator("describe_cache_clusters")
describe_cache_engine_versions_paginator: DescribeCacheEngineVersionsPaginator = client.get_paginator("describe_cache_engine_versions")
describe_cache_parameter_groups_paginator: DescribeCacheParameterGroupsPaginator = client.get_paginator("describe_cache_parameter_groups")
describe_cache_parameters_paginator: DescribeCacheParametersPaginator = client.get_paginator("describe_cache_parameters")
describe_cache_security_groups_paginator: DescribeCacheSecurityGroupsPaginator = client.get_paginator("describe_cache_security_groups")
describe_cache_subnet_groups_paginator: DescribeCacheSubnetGroupsPaginator = client.get_paginator("describe_cache_subnet_groups")
describe_engine_default_parameters_paginator: DescribeEngineDefaultParametersPaginator = client.get_paginator("describe_engine_default_parameters")
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_global_replication_groups_paginator: DescribeGlobalReplicationGroupsPaginator = client.get_paginator("describe_global_replication_groups")
describe_replication_groups_paginator: DescribeReplicationGroupsPaginator = client.get_paginator("describe_replication_groups")
describe_reserved_cache_nodes_paginator: DescribeReservedCacheNodesPaginator = client.get_paginator("describe_reserved_cache_nodes")
describe_reserved_cache_nodes_offerings_paginator: DescribeReservedCacheNodesOfferingsPaginator = client.get_paginator("describe_reserved_cache_nodes_offerings")
describe_service_updates_paginator: DescribeServiceUpdatesPaginator = client.get_paginator("describe_service_updates")
describe_snapshots_paginator: DescribeSnapshotsPaginator = client.get_paginator("describe_snapshots")
describe_update_actions_paginator: DescribeUpdateActionsPaginator = client.get_paginator("describe_update_actions")
describe_user_groups_paginator: DescribeUserGroupsPaginator = client.get_paginator("describe_user_groups")
describe_users_paginator: DescribeUsersPagi
没有合适的资源?快使用搜索试试~ 我知道了~
PyPI 官网下载 | mypy-boto3-elasticache-1.17.90.tar.gz
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 90 浏览量
2022-01-28
16:14:47
上传
评论
收藏 31KB GZ 举报
温馨提示
共25个文件
py:9个
pyi:6个
txt:4个
资源来自pypi官网。 资源全名:mypy-boto3-elasticache-1.17.90.tar.gz
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-elasticache-1.17.90.tar.gz (25个子文件)
mypy-boto3-elasticache-1.17.90
PKG-INFO 20KB
mypy_boto3_elasticache.egg-info
PKG-INFO 20KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 815B
top_level.txt 23B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
README.md 16KB
mypy_boto3_elasticache
type_defs.py 36KB
py.typed 0B
waiter.py 5KB
type_defs.pyi 36KB
literals.py 5KB
client.py 60KB
__main__.py 741B
waiter.pyi 5KB
__init__.py 6KB
client.pyi 60KB
paginator.pyi 22KB
paginator.py 22KB
version.py 55B
literals.pyi 5KB
__init__.pyi 6KB
共 25 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功