Skip to content

CognitoIdentity module#

Index > CognitoIdentity

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

How to install#

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 boto3-stubs for CognitoIdentity service.

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

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

How to uninstall#

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


Code samples can be found in Examples.


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

# CognitoIdentityClient usage example

from boto3.session import Session

from mypy_boto3_cognito_identity.client import CognitoIdentityClient

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


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

# ListIdentityPoolsPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_identity.paginator import ListIdentityPoolsPaginator

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


Type annotations for literals used in methods and schemas.

# AmbiguousRoleResolutionTypeType usage example

from mypy_boto3_cognito_identity.literals import AmbiguousRoleResolutionTypeType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# CognitoIdentityProviderTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import CognitoIdentityProviderTypeDef

def get_value() -> CognitoIdentityProviderTypeDef:
    return {
        "ProviderName": ...,