Type annotations for boto3.Amplify 1.14.1 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-amplify
Type annotations for boto3.Amplify 1.14.1 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.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 Amplify
service.
python -m pip install boto3-stubs[amplify]
How to use
Client annotations
AmplifyClient
provides annotations for boto3.client("amplify")
.
import boto3
from mypy_boto3_amplify import AmplifyClient
from mypy_boto3_amplify.paginator import (
ListAppsPaginator,
ListBranchesPaginator,
ListDomainAssociationsPaginator,
ListJobsPaginator,
)
from mypy_boto3_amplify.type_defs import AppTypeDef, ...
client: AmplifyClient = boto3.client("amplify")
# 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: AmplifyClient = session.client("amplify")
Paginators annotations
mypy_boto3_amplify.paginator
module contains type annotations for all paginators.
client: AmplifyClient = boto3.client("amplify")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_apps_paginator: ListAppsPaginator = client.get_paginator("list_apps")
list_branches_paginator: ListBranchesPaginator = client.get_paginator("list_branches")
list_domain_associations_paginator: ListDomainAssociationsPaginator = client.get_paginator("list_domain_associations")
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
Typed dictionations
mypy_boto3_amplify.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AppTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_amplify
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("amplify")
session_client = boto3.Session().client("amplify")
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-amplify-1.14.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc348a2c00a22a131fe950a6841781f869b2294bcacabdf52eb428cd313f03b0 |
|
MD5 | 99eb80d96e2d9bd1c809526ad5a54d95 |
|
BLAKE2b-256 | d315cb64193f283a1db6ce78616e3dc62842508e8008712b21d8b29506e8536d |
Hashes for mypy_boto3_amplify-1.14.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e0c530d81041006751792a8abdfdfff83be55e96be96036e9cf094e81a422d7 |
|
MD5 | 4e0cc17b0dbd5bcdc3fb0d34bf9fee64 |
|
BLAKE2b-256 | ff0f4c9235c2e0d2441f156f8a998c17b27ecfc4e3919d0faa742eea1caf539d |