Skip to content

CognitoIdentityProvider module

Index > CognitoIdentityProvider

Auto-generated documentation for CognitoIdentityProvider type annotations stubs module types-aiobotocore-cognito-idp.

How to install

From PyPI with pip

Install types-aioboto3 for CognitoIdentityProvider service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[cognito-idp]'


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


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

How to uninstall

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

Usage

Code samples can be found in Examples.

CognitoIdentityProviderClient

Type annotations and code completion for session.client("cognito-idp") as CognitoIdentityProviderClient boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_cognito_idp.client import CognitoIdentityProviderClient


session = Session()
async with session.client("cognito-idp") as client:
    client: CognitoIdentityProviderClient

Paginators

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

Usage example
from types_aiobotocore_cognito_idp.paginator import AdminListGroupsForUserPaginator

def get_admin_list_groups_for_user_paginator() -> AdminListGroupsForUserPaginator:
    return client.get_paginator("admin_list_groups_for_user"))

Literals

Type annotations for literals used in methods and schema.

Usage example
from types_aiobotocore_cognito_idp.literals import AccountTakeoverEventActionTypeType

def get_value() -> AccountTakeoverEventActionTypeType:
    return "BLOCK"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_cognito_idp.type_defs import RecoveryOptionTypeTypeDef

def get_value() -> RecoveryOptionTypeTypeDef:
    return {
        "Priority": ...,
        "Name": ...,
    }