Skip to content

CognitoIdentityProvider module#

Index > CognitoIdentityProvider

Auto-generated documentation for CognitoIdentityProvider type annotations stubs module mypy-boto3-cognito-idp.

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.36.26' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add CognitoIdentityProvider 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 CognitoIdentityProvider.

From PyPI with pip#

Install boto3-stubs for CognitoIdentityProvider service.

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CognitoIdentityProviderClient#

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

# CognitoIdentityProviderClient usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.client import CognitoIdentityProviderClient

def get_client() -> CognitoIdentityProviderClient:
    return Session().client("cognito-idp")

Paginators#

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

# AdminListGroupsForUserPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import AdminListGroupsForUserPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# AccountTakeoverEventActionTypeType usage example

from mypy_boto3_cognito_idp.literals import AccountTakeoverEventActionTypeType

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

Type definitions#

Type annotations for type definitions used in methods and schema.