Type annotations for boto3.CognitoIdentityProvider 1.14.54 service, generated by mypy-boto3-buider 2.4.0
Project description
mypy-boto3-cognito-idp
Type annotations for boto3.CognitoIdentityProvider 1.14.54 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.4.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for CognitoIdentityProvider
service.
python -m pip install boto3-stubs[cognito-idp]
How to use
Client annotations
CognitoIdentityProviderClient
provides annotations for boto3.client("cognito-idp")
.
import boto3
from mypy_boto3_cognito_idp import CognitoIdentityProviderClient
from mypy_boto3_cognito_idp.paginator import (
AdminListGroupsForUserPaginator,
AdminListUserAuthEventsPaginator,
ListGroupsPaginator,
ListIdentityProvidersPaginator,
ListResourceServersPaginator,
ListUserPoolClientsPaginator,
ListUserPoolsPaginator,
ListUsersInGroupPaginator,
ListUsersPaginator,
)
from mypy_boto3_cognito_idp.type_defs import AccountRecoverySettingTypeTypeDef, ...
client: CognitoIdentityProviderClient = boto3.client("cognito-idp")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CognitoIdentityProviderClient = session.client("cognito-idp")
Paginators annotations
mypy_boto3_cognito_idp.paginator
module contains type annotations for all paginators.
client: CognitoIdentityProviderClient = boto3.client("cognito-idp")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
admin_list_groups_for_user_paginator: AdminListGroupsForUserPaginator = client.get_paginator("admin_list_groups_for_user")
admin_list_user_auth_events_paginator: AdminListUserAuthEventsPaginator = client.get_paginator("admin_list_user_auth_events")
list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups")
list_identity_providers_paginator: ListIdentityProvidersPaginator = client.get_paginator("list_identity_providers")
list_resource_servers_paginator: ListResourceServersPaginator = client.get_paginator("list_resource_servers")
list_user_pool_clients_paginator: ListUserPoolClientsPaginator = client.get_paginator("list_user_pool_clients")
list_user_pools_paginator: ListUserPoolsPaginator = client.get_paginator("list_user_pools")
list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
list_users_in_group_paginator: ListUsersInGroupPaginator = client.get_paginator("list_users_in_group")
Typed dictionations
mypy_boto3_cognito_idp.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccountRecoverySettingTypeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cognito_idp
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("cognito-idp")
session_client = boto3.Session().client("cognito-idp")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-cognito-idp-1.14.54.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 972149022909d270e851b3390712ce4d391f4a71270e5cac44748f1d94a2b6be |
|
MD5 | cd09baa4ba68f49d4c70a290ffa386a7 |
|
BLAKE2b-256 | 25559b4b259071c31dc4699d13bc48d669f6f2b16f460005ff2f36871d5c0e11 |
Hashes for mypy_boto3_cognito_idp-1.14.54.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29d25d3a16e02a55cf3181f1de159d1fef27aa6248ed62ff5959f3f6d3de1f4a |
|
MD5 | 5254030a04a4b1bcad3183a406f62f9c |
|
BLAKE2b-256 | e38237b71f32bc2a943189193a1974ab0ee996fb856cf14b339ea26d2ce0f3f3 |