Skip to content

Examples#

Index > CognitoIdentity > Examples

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

Client#

Implicit type annotations#

Can be used with types-aiobotocore[cognito-identity] package installed.

Write your CognitoIdentity code as usual, type checking and code completion should work out of the box.

# CognitoIdentityClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("cognito-identity") as client:  # (1)
    result = await client.create_identity_pool()  # (2)
  1. client: CognitoIdentityClient
  2. result: IdentityPoolTypeDef
# ListIdentityPoolsPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("cognito-identity") as client:  # (1)
    paginator = client.get_paginator("list_identity_pools")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: CognitoIdentityClient
  2. paginator: ListIdentityPoolsPaginator
  3. item: ListIdentityPoolsResponseTypeDef

Explicit type annotations#

With types-aiobotocore-lite[cognito-identity] or a standalone types_aiobotocore_cognito_identity package, you have to explicitly specify client: CognitoIdentityClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# CognitoIdentityClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_cognito_identity.client import CognitoIdentityClient
from types_aiobotocore_cognito_identity.type_defs import IdentityPoolTypeDef
from types_aiobotocore_cognito_identity.type_defs import CreateIdentityPoolInputRequestTypeDef


session = get_session()

async with session.create_client("cognito-identity") as client:
    client: CognitoIdentityClient
    kwargs: CreateIdentityPoolInputRequestTypeDef = {...}
    result: IdentityPoolTypeDef = await client.create_identity_pool(**kwargs)
# ListIdentityPoolsPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_cognito_identity.client import CognitoIdentityClient
from types_aiobotocore_cognito_identity.paginator import ListIdentityPoolsPaginator
from types_aiobotocore_cognito_identity.type_defs import ListIdentityPoolsResponseTypeDef


session = get_session()

async with session.create_client("cognito-identity") as client:
    client: CognitoIdentityClient
    paginator: ListIdentityPoolsPaginator = client.get_paginator("list_identity_pools")
    async for item in paginator.paginate(...):
        item: ListIdentityPoolsResponseTypeDef
        print(item)