Skip to content

CognitoIdentity module#

Index > CognitoIdentity

Auto-generated documentation for CognitoIdentity type annotations stubs module types-boto3-cognito-identity.

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 AWS SDK.
  3. Add CognitoIdentity 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 CognitoIdentity.

From PyPI with pip#

Install types-boto3 for CognitoIdentity service.

# install with boto3 type annotations
python -m pip install 'types-boto3[cognito-identity]'

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

# standalone installation
python -m pip install types-boto3-cognito-identity

How to uninstall#

python -m pip uninstall -y types-boto3-cognito-identity

Usage#

Code samples can be found in Examples.

CognitoIdentityClient#

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

# CognitoIdentityClient usage example

from boto3.session import Session

from types_boto3_cognito_identity.client import CognitoIdentityClient

def get_client() -> CognitoIdentityClient:
    return Session().client("cognito-identity")

Paginators#

Type annotations and code completion for paginators from boto3.client("cognito-identity").get_paginator("...").

# ListIdentityPoolsPaginator usage example

from boto3.session import Session

from types_boto3_cognito_identity.paginator import ListIdentityPoolsPaginator

def get_list_identity_pools_paginator() -> ListIdentityPoolsPaginator:
    return Session().client("cognito-identity").get_paginator("list_identity_pools"))

Literals#

Type annotations for literals used in methods and schema.

# AmbiguousRoleResolutionTypeType usage example

from types_boto3_cognito_identity.literals import AmbiguousRoleResolutionTypeType

def get_value() -> AmbiguousRoleResolutionTypeType:
    return "AuthenticatedRole"

Type definitions#

Type annotations for type definitions used in methods and schema.