# mypy-boto3-cognito-sync
[![PyPI - mypy-boto3-cognito-sync](https://img.shields.io/pypi/v/mypy-boto3-cognito-sync.svg?color=blue)](https://pypi.org/project/mypy-boto3-cognito-sync)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cognito-sync.svg?color=blue)](https://pypi.org/project/mypy-boto3-cognito-sync)
[![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.CognitoSync 1.16.61](https://boto3.amazonaws.com/v1/documentation/api/1.16.61/reference/services/cognito-sync.html#CognitoSync) 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.3.1](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-cognito-sync](#mypy-boto3-cognito-sync)
- [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 `CognitoSync` service.
```bash
python -m pip install boto3-stubs[cognito-sync]
```
## 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[cognito-sync]` in your environment: `python -m pip install 'boto3-stubs[cognito-sync]'`
Both type checking and auto-complete should work for `CognitoSync` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[cognito-sync]` in your environment: `python -m pip install 'boto3-stubs[cognito-sync]'`
Both type checking and auto-complete should work for `CognitoSync` 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[cognito-sync]` in your environment: `python -m pip install 'boto3-stubs[cognito-sync]'`
- Run `mypy` as usual
Type checking should work for `CognitoSync` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[cognito-sync]` in your environment: `python -m pip install 'boto3-stubs[cognito-sync]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CognitoSync` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CognitoSyncClient` provides annotations for `boto3.client("cognito-sync")`.
```python
import boto3
from mypy_boto3_cognito_sync import CognitoSyncClient
client: CognitoSyncClient = boto3.client("cognito-sync")
# 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: CognitoSyncClient = session.client("cognito-sync")
```
### Typed dictionations
`mypy_boto3_cognito_sync.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_cognito_sync.type_defs import (
BulkPublishResponseTypeDef,
CognitoStreamsTypeDef,
DatasetTypeDef,
DeleteDatasetResponseTypeDef,
DescribeDatasetResponseTypeDef,
DescribeIdentityPoolUsageResponseTypeDef,
DescribeIdentityUsageResponseTypeDef,
GetBulkPublishDetailsResponseTypeDef,
GetCognitoEventsResponseTypeDef,
GetIdentityPoolConfigurationResponseTypeDef,
IdentityPoolUsageTypeDef,
IdentityUsageTypeDef,
ListDatasetsResponseTypeDef,
ListIdentityPoolUsageResponseTypeDef,
ListRecordsResponseTypeDef,
PushSyncTypeDef,
RecordPatchTypeDef,
RecordTypeDef,
RegisterDeviceResponseTypeDef,
SetIdentityPoolConfigurationResponseTypeDef,
UpdateRecordsResponseTypeDef,
)
def get_structure() -> CognitoStreamsTypeDef:
return {
...
}
```
PyPI 官网下载 | mypy-boto3-cognito-sync-1.16.61.0.tar.gz
版权申诉
176 浏览量
2022-01-28
15:30:08
上传
评论
收藏 8KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- 基于QT+C++的智能云监护仪项目,能够实时显示使用者心电、血氧、血压波形及其它各种参数+源码(毕业设计&课程设计&项目开发)
- 基于java开发的app接收硬件端传输的心音信号,具有显示心音波形,发出心音的功能+源码(毕业设计&课程设计&项目开发)
- Python 程序语言设计模式思路-行为型模式:职责链模式:将请求从一个处理者传递到下一个处理者
- 9241703124789646.16健身系统2.apk
- postgresql-16.3-1-windows-x64.exe
- Python 程序语言设计模式思路-结构型模式:装饰器讲解及利用Python装饰器模式实现高效日志记录和性能测试
- 基于YOLOv5和DeepSORT的多目标跟踪仿真与记录
- Python 程序语言设计模式思路-创建型模式:原型模式:通过复制现有对象来创建新对象,面向对象编程
- 卸载软件geek卸载软件geek
- Python 程序语言设计模式思路-创建型模式:单例模式,确保一个类的唯一实例(装饰器)面向对象编程、继承
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈