CognitoIdentity module#
Index > CognitoIdentity
Auto-generated documentation for CognitoIdentity type annotations stubs module types-aiobotocore-cognito-identity.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore package locally with mypy-boto3-builder.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==2.25.0' mypy-boto3-builder - Select
aiobotocoreAWS SDK. - Add
CognitoIdentityservice. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore for CognitoIdentity service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[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-aiobotocore-lite[cognito-identity]'
# standalone installation
python -m pip install types-aiobotocore-cognito-identity
How to uninstall#
python -m pip uninstall -y types-aiobotocore-cognito-identity
Usage#
Code samples can be found in Examples.
CognitoIdentityClient#
Type annotations and code completion for session.create_client("cognito-identity") as CognitoIdentityClient
boto3 documentation
# CognitoIdentityClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_cognito_identity.client import CognitoIdentityClient
session = get_session()
async with session.create_client("cognito-identity") as client:
client: CognitoIdentityClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("cognito-identity").get_paginator("...").
# ListIdentityPoolsPaginator usage example
from types_aiobotocore_cognito_identity.paginator import ListIdentityPoolsPaginator
def get_list_identity_pools_paginator() -> ListIdentityPoolsPaginator:
return client.get_paginator("list_identity_pools"))
Literals#
Type annotations for literals used in methods and schema.
# AmbiguousRoleResolutionTypeType usage example
from types_aiobotocore_cognito_identity.literals import AmbiguousRoleResolutionTypeType
def get_value() -> AmbiguousRoleResolutionTypeType:
return "AuthenticatedRole"
- AmbiguousRoleResolutionTypeType
- ErrorCodeType
- ListIdentityPoolsPaginatorName
- MappingRuleMatchTypeType
- RoleMappingTypeType
- CognitoIdentityServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- CognitoIdentityProviderTypeDef
- CredentialsTypeDef
- DeleteIdentitiesInputTypeDef
- ResponseMetadataTypeDef
- UnprocessedIdentityIdTypeDef
- DeleteIdentityPoolInputTypeDef
- DescribeIdentityInputTypeDef
- DescribeIdentityPoolInputTypeDef
- GetCredentialsForIdentityInputTypeDef
- GetIdInputTypeDef
- GetIdentityPoolRolesInputTypeDef
- GetOpenIdTokenForDeveloperIdentityInputTypeDef
- GetOpenIdTokenInputTypeDef
- GetPrincipalTagAttributeMapInputTypeDef
- IdentityDescriptionTypeDef
- IdentityPoolShortDescriptionTypeDef
- ListIdentitiesInputTypeDef
- PaginatorConfigTypeDef
- ListIdentityPoolsInputTypeDef
- ListTagsForResourceInputTypeDef
- LookupDeveloperIdentityInputTypeDef
- MappingRuleTypeDef
- MergeDeveloperIdentitiesInputTypeDef
- SetPrincipalTagAttributeMapInputTypeDef
- TagResourceInputTypeDef
- UnlinkDeveloperIdentityInputTypeDef
- UnlinkIdentityInputTypeDef
- UntagResourceInputTypeDef
- CreateIdentityPoolInputTypeDef
- IdentityPoolRequestTypeDef
- EmptyResponseMetadataTypeDef
- GetCredentialsForIdentityResponseTypeDef
- GetIdResponseTypeDef
- GetOpenIdTokenForDeveloperIdentityResponseTypeDef
- GetOpenIdTokenResponseTypeDef
- GetPrincipalTagAttributeMapResponseTypeDef
- IdentityDescriptionResponseTypeDef
- IdentityPoolTypeDef
- ListTagsForResourceResponseTypeDef
- LookupDeveloperIdentityResponseTypeDef
- MergeDeveloperIdentitiesResponseTypeDef
- SetPrincipalTagAttributeMapResponseTypeDef
- DeleteIdentitiesResponseTypeDef
- ListIdentitiesResponseTypeDef
- ListIdentityPoolsResponseTypeDef
- ListIdentityPoolsInputPaginateTypeDef
- RulesConfigurationTypeOutputTypeDef
- RulesConfigurationTypeTypeDef
- RoleMappingOutputTypeDef
- RulesConfigurationTypeUnionTypeDef
- GetIdentityPoolRolesResponseTypeDef
- RoleMappingTypeDef
- RoleMappingUnionTypeDef
- SetIdentityPoolRolesInputTypeDef