Skip to content

Examples#

Index > PinpointEmail > Examples

Auto-generated documentation for PinpointEmail type annotations stubs module types-aiobotocore-pinpoint-email.

Client#

Implicit type annotations#

Can be used with types-aiobotocore[pinpoint-email] package installed.

Write your PinpointEmail code as usual, type checking and code completion should work out of the box.

# PinpointEmailClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("pinpoint-email") as client:  # (1)
    result = await client.create_deliverability_test_report()  # (2)
  1. client: PinpointEmailClient
  2. result: CreateDeliverabilityTestReportResponseTypeDef
# GetDedicatedIpsPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("pinpoint-email") as client:  # (1)
    paginator = client.get_paginator("get_dedicated_ips")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: PinpointEmailClient
  2. paginator: GetDedicatedIpsPaginator
  3. item: GetDedicatedIpsResponseTypeDef

Explicit type annotations#

With types-aiobotocore-lite[pinpoint-email] or a standalone types_aiobotocore_pinpoint_email package, you have to explicitly specify client: PinpointEmailClient 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.

# PinpointEmailClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_pinpoint_email.client import PinpointEmailClient
from types_aiobotocore_pinpoint_email.type_defs import CreateDeliverabilityTestReportResponseTypeDef
from types_aiobotocore_pinpoint_email.type_defs import CreateDeliverabilityTestReportRequestRequestTypeDef


session = get_session()

async with session.create_client("pinpoint-email") as client:
    client: PinpointEmailClient
    kwargs: CreateDeliverabilityTestReportRequestRequestTypeDef = {...}
    result: CreateDeliverabilityTestReportResponseTypeDef = await client.create_deliverability_test_report(**kwargs)
# GetDedicatedIpsPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_pinpoint_email.client import PinpointEmailClient
from types_aiobotocore_pinpoint_email.paginator import GetDedicatedIpsPaginator
from types_aiobotocore_pinpoint_email.type_defs import GetDedicatedIpsResponseTypeDef


session = get_session()

async with session.create_client("pinpoint-email") as client:
    client: PinpointEmailClient
    paginator: GetDedicatedIpsPaginator = client.get_paginator("get_dedicated_ips")
    async for item in paginator.paginate(...):
        item: GetDedicatedIpsResponseTypeDef
        print(item)