Skip to content

CognitoSync module#

Index > CognitoSync

Auto-generated documentation for CognitoSync type annotations stubs module types-aiobotocore-cognito-sync.

How to install#

You can generate type annotations for aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==2.25.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add CognitoSync service.
  4. Use provided commands to install generated packages.

From PyPI with pip#

Install types-aiobotocore for CognitoSync service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[cognito-sync]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[cognito-sync]'

# standalone installation
python -m pip install types-aiobotocore-cognito-sync

How to uninstall#

python -m pip uninstall -y types-aiobotocore-cognito-sync

Usage#

Code samples can be found in Examples.

CognitoSyncClient#

Type annotations and code completion for session.create_client("cognito-sync") as CognitoSyncClient boto3 documentation

# CognitoSyncClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_cognito_sync.client import CognitoSyncClient


session = get_session()
async with session.create_client("cognito-sync") as client:
    client: CognitoSyncClient

Literals#

Type annotations for literals used in methods and schema.

# BulkPublishStatusType usage example

from types_aiobotocore_cognito_sync.literals import BulkPublishStatusType

def get_value() -> BulkPublishStatusType:
    return "FAILED"

Type definitions#

Type annotations for type definitions used in methods and schema.