Skip to content

CognitoSync module#

Index > CognitoSync

Auto-generated documentation for CognitoSync type annotations stubs module mypy-boto3-cognito-sync.

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

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

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CognitoSync.

From PyPI with pip#

Install boto3-stubs for CognitoSync service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[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 'boto3-stubs-lite[cognito-sync]'

# standalone installation
python -m pip install mypy-boto3-cognito-sync

How to uninstall#

python -m pip uninstall -y mypy-boto3-cognito-sync

Usage#

Code samples can be found in Examples.

CognitoSyncClient#

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

# CognitoSyncClient usage example

from boto3.session import Session

from mypy_boto3_cognito_sync.client import CognitoSyncClient

def get_client() -> CognitoSyncClient:
    return Session().client("cognito-sync")

Literals#

Type annotations for literals used in methods and schema.

# BulkPublishStatusType usage example

from mypy_boto3_cognito_sync.literals import BulkPublishStatusType

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

Type definitions#

Type annotations for type definitions used in methods and schema.