Pinpoint module#
Index > Pinpoint
Auto-generated documentation for Pinpoint type annotations stubs module mypy-boto3-pinpoint.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.2' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
Pinpoint
service. - Use provided commands to install generated packages.
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 schema.
# ActionType usage example
from mypy_boto3_pinpoint.literals import ActionType
def get_value() -> ActionType:
return "DEEP_LINK"
- ActionType
- AlignmentType
- AttributeTypeType
- ButtonActionType
- CampaignStatusType
- ChannelTypeType
- DayOfWeekType
- DeliveryStatusType
- DimensionTypeType
- DurationType
- EndpointTypesElementType
- FilterTypeType
- FormatType
- FrequencyType
- IncludeType
- JobStatusType
- JourneyRunStatusType
- LayoutType
- MessageTypeType
- ModeType
- OperatorType
- RecencyTypeType
- SegmentTypeType
- SourceTypeType
- StateType
- TemplateTypeType
- TimezoneEstimationMethodsElementType
- TypeType
- PinpointServiceName
- ServiceName
- ResourceServiceName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.