Python库 | mypy-boto3-cognito-sync-1.17.67.0.tar.gz

# mypy-boto3-cognito-sync [](https://pypi.org/project/mypy-boto3-cognito-sync) [](https://pypi.org/project/mypy-boto3-cognito-sync) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/mypy-boto3-cognito-sync)  Type annotations for [boto3.CognitoSync 1.17.67](https://boto3.amazonaws.com/v1/documentation/api/1.17.67/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.10.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-cognito-sync docs](https://github.com/vemel/mypy_boto3_builder/service_docs/mypy_boto3_cognito_sync/README.md) See how it helps to find and fix potential bugs:  - [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) - [Literals](#literals) - [Typed dictionaries](#typed-dictionaries) ## 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") ``` ### Literals `mypy_boto3_cognito_sync.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_cognito_sync.literals import ( BulkPublishStatus, Operation, Platform, StreamingStatus, ) def check_value(value: BulkPublishStatus) -> bool: ... ``` ### Typed dictionaries `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() -> BulkPublishResponseTypeDef: return { ... } ```