Skip to content

PinpointEmail module#

Index > PinpointEmail

Auto-generated documentation for PinpointEmail type annotations stubs module mypy-boto3-pinpoint-email.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and PinpointEmail.

From PyPI with pip#

Install boto3-stubs for PinpointEmail service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[pinpoint-email]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[pinpoint-email]'


# standalone installation
python -m pip install mypy-boto3-pinpoint-email

How to uninstall#

python -m pip uninstall -y mypy-boto3-pinpoint-email

Usage#

Code samples can be found in Examples.

PinpointEmailClient#

Type annotations and code completion for boto3.client("pinpoint-email") as PinpointEmailClient boto3 documentation

# PinpointEmailClient usage example

from boto3.session import Session

from mypy_boto3_pinpoint_email.client import PinpointEmailClient

def get_client() -> PinpointEmailClient:
    return Session().client("pinpoint-email")

Paginators#

Type annotations and code completion for paginators from boto3.client("pinpoint-email").get_paginator("...").

# GetDedicatedIpsPaginator usage example

from boto3.session import Session

from mypy_boto3_pinpoint_email.paginator import GetDedicatedIpsPaginator

def get_get_dedicated_ips_paginator() -> GetDedicatedIpsPaginator:
    return Session().client("pinpoint-email").get_paginator("get_dedicated_ips"))

Literals#

Type annotations for literals used in methods and schemas.

# BehaviorOnMxFailureType usage example

from mypy_boto3_pinpoint_email.literals import BehaviorOnMxFailureType

def get_value() -> BehaviorOnMxFailureType:
    return "REJECT_MESSAGE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# BlacklistEntryTypeDef usage example

from mypy_boto3_pinpoint_email.type_defs import BlacklistEntryTypeDef

def get_value() -> BlacklistEntryTypeDef:
    return {
        "RblName": ...,
    }