Type annotations for boto3.CognitoIdentity 1.14.51 service, generated by mypy-boto3-buider 2.3.1
Project description
mypy-boto3-cognito-identity
Type annotations for boto3.CognitoIdentity 1.14.51 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.3.1.
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 CognitoIdentity
service.
python -m pip install boto3-stubs[cognito-identity]
How to use
Client annotations
CognitoIdentityClient
provides annotations for boto3.client("cognito-identity")
.
import boto3
from mypy_boto3_cognito_identity import CognitoIdentityClient
from mypy_boto3_cognito_identity.paginator import ListIdentityPoolsPaginator
from mypy_boto3_cognito_identity.type_defs import CognitoIdentityProviderTypeDef, ...
client: CognitoIdentityClient = boto3.client("cognito-identity")
# 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: CognitoIdentityClient = session.client("cognito-identity")
Paginators annotations
mypy_boto3_cognito_identity.paginator
module contains type annotations for all paginators.
client: CognitoIdentityClient = boto3.client("cognito-identity")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_identity_pools_paginator: ListIdentityPoolsPaginator = client.get_paginator("list_identity_pools")
Typed dictionations
mypy_boto3_cognito_identity.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> CognitoIdentityProviderTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cognito_identity
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-identity")
session_client = boto3.Session().client("cognito-identity")
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-identity-1.14.51.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f41ccc09577cff95aefd62a79c263a89ad810d7c11b41ac41c65f82b508620ed |
|
MD5 | 92ce5f8dfc7435e5d294f756dee91c59 |
|
BLAKE2b-256 | 1ffc13fa1c73e0013e6cc5ed717dff3962a23128bd57bbe011791ddc384633d4 |
Hashes for mypy_boto3_cognito_identity-1.14.51.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae2de766933a3ad17b57932d71c6150c14bea3584cb087deaf4e2072019e463f |
|
MD5 | b447160299e94c7508cb783d4fe1a0d5 |
|
BLAKE2b-256 | 260dcc3fe72e879828e6c5c518e9c630d9e78cefe32e9868cc166583c1e9802d |