Examples#
Index > CognitoIdentityProvider > Examples
Auto-generated documentation for CognitoIdentityProvider type annotations stubs module types-aiobotocore-cognito-idp.
Client#
Implicit type annotations#
Can be used with types-aiobotocore[cognito-idp]
package installed.
Write your CognitoIdentityProvider
code as usual,
type checking and code completion should work out of the box.
# CognitoIdentityProviderClient usage example
from aiobotocore.session import get_session
session = get_session()
async with session.create_client("cognito-idp") as client: # (1)
result = await client.admin_add_user_to_group() # (2)
- client: CognitoIdentityProviderClient
- result: EmptyResponseMetadataTypeDef
# AdminListGroupsForUserPaginator usage example
from aiobotocore.session import get_session
session = get_session()
async with session.create_client("cognito-idp") as client: # (1)
paginator = client.get_paginator("admin_list_groups_for_user") # (2)
async for item in paginator.paginate(...):
print(item) # (3)
- client: CognitoIdentityProviderClient
- paginator: AdminListGroupsForUserPaginator
- item: AdminListGroupsForUserResponseTypeDef
Explicit type annotations#
With types-aiobotocore-lite[cognito-idp]
or a standalone types_aiobotocore_cognito_idp
package, you have to explicitly specify
client: CognitoIdentityProviderClient
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.
# CognitoIdentityProviderClient usage example with type annotations
from aiobotocore.session import get_session
from types_aiobotocore_cognito_idp.client import CognitoIdentityProviderClient
from types_aiobotocore_cognito_idp.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_cognito_idp.type_defs import AdminAddUserToGroupRequestRequestTypeDef
session = get_session()
async with session.create_client("cognito-idp") as client:
client: CognitoIdentityProviderClient
kwargs: AdminAddUserToGroupRequestRequestTypeDef = {...}
result: EmptyResponseMetadataTypeDef = await client.admin_add_user_to_group(**kwargs)
# AdminListGroupsForUserPaginator usage example with type annotations
from aiobotocore.session import get_session
from types_aiobotocore_cognito_idp.client import CognitoIdentityProviderClient
from types_aiobotocore_cognito_idp.paginator import AdminListGroupsForUserPaginator
from types_aiobotocore_cognito_idp.type_defs import AdminListGroupsForUserResponseTypeDef
session = get_session()
async with session.create_client("cognito-idp") as client:
client: CognitoIdentityProviderClient
paginator: AdminListGroupsForUserPaginator = client.get_paginator("admin_list_groups_for_user")
async for item in paginator.paginate(...):
item: AdminListGroupsForUserResponseTypeDef
print(item)