Type annotations for boto3.PinpointEmail 1.14.33 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-pinpoint-email
Type annotations for boto3.PinpointEmail 1.14.33 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 PinpointEmail
service.
python -m pip install boto3-stubs[pinpoint-email]
How to use
Client annotations
PinpointEmailClient
provides annotations for boto3.client("pinpoint-email")
.
import boto3
from mypy_boto3_pinpoint_email import PinpointEmailClient
from mypy_boto3_pinpoint_email.paginator import (
GetDedicatedIpsPaginator,
ListConfigurationSetsPaginator,
ListDedicatedIpPoolsPaginator,
ListDeliverabilityTestReportsPaginator,
ListEmailIdentitiesPaginator,
)
from mypy_boto3_pinpoint_email.type_defs import BlacklistEntryTypeDef, ...
client: PinpointEmailClient = boto3.client("pinpoint-email")
# 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: PinpointEmailClient = session.client("pinpoint-email")
Paginators annotations
mypy_boto3_pinpoint_email.paginator
module contains type annotations for all paginators.
client: PinpointEmailClient = boto3.client("pinpoint-email")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_dedicated_ips_paginator: GetDedicatedIpsPaginator = client.get_paginator("get_dedicated_ips")
list_configuration_sets_paginator: ListConfigurationSetsPaginator = client.get_paginator("list_configuration_sets")
list_dedicated_ip_pools_paginator: ListDedicatedIpPoolsPaginator = client.get_paginator("list_dedicated_ip_pools")
list_deliverability_test_reports_paginator: ListDeliverabilityTestReportsPaginator = client.get_paginator("list_deliverability_test_reports")
list_email_identities_paginator: ListEmailIdentitiesPaginator = client.get_paginator("list_email_identities")
Typed dictionations
mypy_boto3_pinpoint_email.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BlacklistEntryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_pinpoint_email
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("pinpoint-email")
session_client = boto3.Session().client("pinpoint-email")
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-pinpoint-email-1.14.33.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0e401cc9d9b2b1eb35260680900f41b1270bc74139aad3ce38e7ede8be639a6 |
|
MD5 | f4fc07f967f0f58534bd341c933890fa |
|
BLAKE2b-256 | d51221c1f9eea93277d3de2a1035a2716c2f4cfc72d2deb2184aa8a069cd623d |
Hashes for mypy_boto3_pinpoint_email-1.14.33.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 538a2c6e9b3acf667165e45aefc9c5db2cd65d80120133fd40d3e669528dbf94 |
|
MD5 | c0397ff7e626acb70bd5c66af0132fd1 |
|
BLAKE2b-256 | 0101b78c8ef932e19043554ab95b3c12b5e4f12b692ebe08c1ce1c7ff6a1ad75 |