Skip to content

Pinpoint module#

Index > Pinpoint

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

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 Pinpoint.

From PyPI with pip#

Install boto3-stubs for Pinpoint service.

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


# 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]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

PinpointClient#

Type annotations and code completion for boto3.client("pinpoint") as PinpointClient boto3 documentation

# PinpointClient usage example

from boto3.session import Session

from mypy_boto3_pinpoint.client import PinpointClient

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

Literals#

Type annotations for literals used in methods and schemas.

# ActionType usage example

from mypy_boto3_pinpoint.literals import ActionType

def get_value() -> ActionType:
    return "DEEP_LINK"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ADMChannelRequestTypeDef usage example

from mypy_boto3_pinpoint.type_defs import ADMChannelRequestTypeDef

def get_value() -> ADMChannelRequestTypeDef:
    return {
        "ClientId": ...,
        "ClientSecret": ...,
    }