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"
- 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
- TypeType
- PinpointServiceName
- ServiceName
- ResourceServiceName
- RegionName
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": ...,
}
- ADMChannelRequestTypeDef
- ADMChannelResponseTypeDef
- ADMMessageTypeDef
- APNSChannelRequestTypeDef
- APNSChannelResponseTypeDef
- APNSMessageTypeDef
- APNSPushNotificationTemplateTypeDef
- APNSSandboxChannelRequestTypeDef
- APNSSandboxChannelResponseTypeDef
- APNSVoipChannelRequestTypeDef
- APNSVoipChannelResponseTypeDef
- APNSVoipSandboxChannelRequestTypeDef
- APNSVoipSandboxChannelResponseTypeDef
- ActivityResponseTypeDef
- ContactCenterActivityTypeDef
- HoldoutActivityTypeDef
- AddressConfigurationTypeDef
- AndroidPushNotificationTemplateTypeDef
- ApplicationResponseTypeDef
- CampaignHookTypeDef
- CampaignLimitsTypeDef
- QuietTimeTypeDef
- AttributeDimensionTypeDef
- AttributesResourceTypeDef
- BaiduChannelRequestTypeDef
- BaiduChannelResponseTypeDef
- BaiduMessageTypeDef
- CampaignCustomMessageTypeDef
- CampaignEmailMessageTypeDef
- CampaignStateTypeDef
- CustomDeliveryConfigurationTypeDef
- CampaignSmsMessageTypeDef
- ChannelResponseTypeDef
- ClosedDaysRuleTypeDef
- WaitTimeTypeDef
- CreateApplicationRequestTypeDef
- EmailTemplateRequestTypeDef
- CreateTemplateMessageBodyTypeDef
- ExportJobRequestTypeDef
- ImportJobRequestTypeDef
- TemplateCreateMessageBodyTypeDef
- CreateRecommenderConfigurationTypeDef
- RecommenderConfigurationResponseTypeDef
- SMSTemplateRequestTypeDef
- VoiceTemplateRequestTypeDef
- JourneyCustomMessageTypeDef
- DefaultButtonConfigurationTypeDef
- DefaultMessageTypeDef
- DefaultPushNotificationMessageTypeDef
- DefaultPushNotificationTemplateTypeDef
- DeleteAdmChannelRequestRequestTypeDef
- DeleteApnsChannelRequestRequestTypeDef
- DeleteApnsSandboxChannelRequestRequestTypeDef
- DeleteApnsVoipChannelRequestRequestTypeDef
- DeleteApnsVoipSandboxChannelRequestRequestTypeDef
- DeleteAppRequestRequestTypeDef
- DeleteBaiduChannelRequestRequestTypeDef
- DeleteCampaignRequestRequestTypeDef
- DeleteEmailChannelRequestRequestTypeDef
- EmailChannelResponseTypeDef
- DeleteEmailTemplateRequestRequestTypeDef
- MessageBodyTypeDef
- DeleteEndpointRequestRequestTypeDef
- DeleteEventStreamRequestRequestTypeDef
- EventStreamTypeDef
- DeleteGcmChannelRequestRequestTypeDef
- GCMChannelResponseTypeDef
- DeleteInAppTemplateRequestRequestTypeDef
- DeleteJourneyRequestRequestTypeDef
- DeletePushTemplateRequestRequestTypeDef
- DeleteRecommenderConfigurationRequestRequestTypeDef
- DeleteSegmentRequestRequestTypeDef
- DeleteSmsChannelRequestRequestTypeDef
- SMSChannelResponseTypeDef
- DeleteSmsTemplateRequestRequestTypeDef
- DeleteUserEndpointsRequestRequestTypeDef
- DeleteVoiceChannelRequestRequestTypeDef
- VoiceChannelResponseTypeDef
- DeleteVoiceTemplateRequestRequestTypeDef
- GCMMessageTypeDef
- SMSMessageTypeDef
- VoiceMessageTypeDef
- EmailChannelRequestTypeDef
- JourneyEmailMessageTypeDef
- RawEmailTypeDef
- EmailTemplateResponseTypeDef
- EmptyResponseMetadataTypeDef
- EndpointDemographicTypeDef
- EndpointLocationTypeDef
- EndpointUserTypeDef
- EndpointItemResponseTypeDef
- EndpointMessageResultTypeDef
- EndpointSendConfigurationTypeDef
- MetricDimensionTypeDef
- SetDimensionTypeDef
- EventItemResponseTypeDef
- SessionTypeDef
- ExportJobResourceTypeDef
- GCMChannelRequestTypeDef
- GPSCoordinatesTypeDef
- GetAdmChannelRequestRequestTypeDef
- GetApnsChannelRequestRequestTypeDef
- GetApnsSandboxChannelRequestRequestTypeDef
- GetApnsVoipChannelRequestRequestTypeDef
- GetApnsVoipSandboxChannelRequestRequestTypeDef
- GetAppRequestRequestTypeDef
- GetApplicationDateRangeKpiRequestRequestTypeDef
- GetApplicationSettingsRequestRequestTypeDef
- GetAppsRequestRequestTypeDef
- GetBaiduChannelRequestRequestTypeDef
- GetCampaignActivitiesRequestRequestTypeDef
- GetCampaignDateRangeKpiRequestRequestTypeDef
- GetCampaignRequestRequestTypeDef
- GetCampaignVersionRequestRequestTypeDef
- GetCampaignVersionsRequestRequestTypeDef
- GetCampaignsRequestRequestTypeDef
- GetChannelsRequestRequestTypeDef
- GetEmailChannelRequestRequestTypeDef
- GetEmailTemplateRequestRequestTypeDef
- GetEndpointRequestRequestTypeDef
- GetEventStreamRequestRequestTypeDef
- GetExportJobRequestRequestTypeDef
- GetExportJobsRequestRequestTypeDef
- GetGcmChannelRequestRequestTypeDef
- GetImportJobRequestRequestTypeDef
- GetImportJobsRequestRequestTypeDef
- GetInAppMessagesRequestRequestTypeDef
- GetInAppTemplateRequestRequestTypeDef
- GetJourneyDateRangeKpiRequestRequestTypeDef
- GetJourneyExecutionActivityMetricsRequestRequestTypeDef
- JourneyExecutionActivityMetricsResponseTypeDef
- GetJourneyExecutionMetricsRequestRequestTypeDef
- JourneyExecutionMetricsResponseTypeDef
- GetJourneyRequestRequestTypeDef
- GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef
- JourneyRunExecutionActivityMetricsResponseTypeDef
- GetJourneyRunExecutionMetricsRequestRequestTypeDef
- JourneyRunExecutionMetricsResponseTypeDef
- GetJourneyRunsRequestRequestTypeDef
- GetPushTemplateRequestRequestTypeDef
- GetRecommenderConfigurationRequestRequestTypeDef
- GetRecommenderConfigurationsRequestRequestTypeDef
- GetSegmentExportJobsRequestRequestTypeDef
- GetSegmentImportJobsRequestRequestTypeDef
- GetSegmentRequestRequestTypeDef
- GetSegmentVersionRequestRequestTypeDef
- GetSegmentVersionsRequestRequestTypeDef
- GetSegmentsRequestRequestTypeDef
- GetSmsChannelRequestRequestTypeDef
- GetSmsTemplateRequestRequestTypeDef
- SMSTemplateResponseTypeDef
- GetUserEndpointsRequestRequestTypeDef
- GetVoiceChannelRequestRequestTypeDef
- GetVoiceTemplateRequestRequestTypeDef
- VoiceTemplateResponseTypeDef
- ImportJobResourceTypeDef
- InAppMessageBodyConfigTypeDef
- OverrideButtonConfigurationTypeDef
- InAppMessageHeaderConfigTypeDef
- JourneyChannelSettingsTypeDef
- JourneyLimitsTypeDef
- JourneyPushMessageTypeDef
- JourneyScheduleTypeDef
- JourneyRunResponseTypeDef
- JourneySMSMessageTypeDef
- JourneyStateRequestTypeDef
- ListJourneysRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TagsModelTypeDef
- ListTemplateVersionsRequestRequestTypeDef
- ListTemplatesRequestRequestTypeDef
- MessageTypeDef
- MessageResultTypeDef
- NumberValidateRequestTypeDef
- NumberValidateResponseTypeDef
- OpenHoursRuleTypeDef
- WriteEventStreamTypeDef
- RandomSplitEntryTypeDef
- RecencyDimensionTypeDef
- UpdateAttributesRequestTypeDef
- ResponseMetadataTypeDef
- ResultRowValueTypeDef
- SMSChannelRequestTypeDef
- SegmentConditionTypeDef
- SegmentReferenceTypeDef
- SegmentImportResourceTypeDef
- SendOTPMessageRequestParametersTypeDef
- SimpleEmailPartTypeDef
- TemplateActiveVersionRequestTypeDef
- TemplateTypeDef
- TemplateResponseTypeDef
- TemplateVersionResponseTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateRecommenderConfigurationTypeDef
- VoiceChannelRequestTypeDef
- VerificationResponseTypeDef
- VerifyOTPMessageRequestParametersTypeDef
- UpdateAdmChannelRequestRequestTypeDef
- DeleteAdmChannelResponseTypeDef
- GetAdmChannelResponseTypeDef
- UpdateAdmChannelResponseTypeDef
- UpdateApnsChannelRequestRequestTypeDef
- DeleteApnsChannelResponseTypeDef
- GetApnsChannelResponseTypeDef
- UpdateApnsChannelResponseTypeDef
- UpdateApnsSandboxChannelRequestRequestTypeDef
- DeleteApnsSandboxChannelResponseTypeDef
- GetApnsSandboxChannelResponseTypeDef
- UpdateApnsSandboxChannelResponseTypeDef
- UpdateApnsVoipChannelRequestRequestTypeDef
- DeleteApnsVoipChannelResponseTypeDef
- GetApnsVoipChannelResponseTypeDef
- UpdateApnsVoipChannelResponseTypeDef
- UpdateApnsVoipSandboxChannelRequestRequestTypeDef
- DeleteApnsVoipSandboxChannelResponseTypeDef
- GetApnsVoipSandboxChannelResponseTypeDef
- UpdateApnsVoipSandboxChannelResponseTypeDef
- ActivitiesResponseTypeDef
- ApplicationsResponseTypeDef
- CreateAppResponseTypeDef
- DeleteAppResponseTypeDef
- GetAppResponseTypeDef
- ApplicationSettingsResourceTypeDef
- WriteApplicationSettingsRequestTypeDef
- RemoveAttributesResponseTypeDef
- UpdateBaiduChannelRequestRequestTypeDef
- DeleteBaiduChannelResponseTypeDef
- GetBaiduChannelResponseTypeDef
- UpdateBaiduChannelResponseTypeDef
- ChannelsResponseTypeDef
- ClosedDaysTypeDef
- WaitActivityTypeDef
- CreateAppRequestRequestTypeDef
- CreateEmailTemplateRequestRequestTypeDef
- UpdateEmailTemplateRequestRequestTypeDef
- CreateEmailTemplateResponseTypeDef
- CreatePushTemplateResponseTypeDef
- CreateSmsTemplateResponseTypeDef
- CreateVoiceTemplateResponseTypeDef
- CreateExportJobRequestRequestTypeDef
- CreateImportJobRequestRequestTypeDef
- CreateInAppTemplateResponseTypeDef
- CreateRecommenderConfigurationRequestRequestTypeDef
- CreateRecommenderConfigurationResponseTypeDef
- DeleteRecommenderConfigurationResponseTypeDef
- GetRecommenderConfigurationResponseTypeDef
- ListRecommenderConfigurationsResponseTypeDef
- UpdateRecommenderConfigurationResponseTypeDef
- CreateSmsTemplateRequestRequestTypeDef
- UpdateSmsTemplateRequestRequestTypeDef
- CreateVoiceTemplateRequestRequestTypeDef
- UpdateVoiceTemplateRequestRequestTypeDef
- CustomMessageActivityTypeDef
- PushNotificationTemplateRequestTypeDef
- PushNotificationTemplateResponseTypeDef
- DeleteEmailChannelResponseTypeDef
- GetEmailChannelResponseTypeDef
- UpdateEmailChannelResponseTypeDef
- DeleteEmailTemplateResponseTypeDef
- DeleteInAppTemplateResponseTypeDef
- DeletePushTemplateResponseTypeDef
- DeleteSmsTemplateResponseTypeDef
- DeleteVoiceTemplateResponseTypeDef
- UpdateEmailTemplateResponseTypeDef
- UpdateEndpointResponseTypeDef
- UpdateEndpointsBatchResponseTypeDef
- UpdateInAppTemplateResponseTypeDef
- UpdatePushTemplateResponseTypeDef
- UpdateSmsTemplateResponseTypeDef
- UpdateTemplateActiveVersionResponseTypeDef
- UpdateVoiceTemplateResponseTypeDef
- DeleteEventStreamResponseTypeDef
- GetEventStreamResponseTypeDef
- PutEventStreamResponseTypeDef
- DeleteGcmChannelResponseTypeDef
- GetGcmChannelResponseTypeDef
- UpdateGcmChannelResponseTypeDef
- DeleteSmsChannelResponseTypeDef
- GetSmsChannelResponseTypeDef
- UpdateSmsChannelResponseTypeDef
- DeleteVoiceChannelResponseTypeDef
- GetVoiceChannelResponseTypeDef
- UpdateVoiceChannelResponseTypeDef
- UpdateEmailChannelRequestRequestTypeDef
- EmailMessageActivityTypeDef
- GetEmailTemplateResponseTypeDef
- EndpointBatchItemTypeDef
- EndpointRequestTypeDef
- EndpointResponseTypeDef
- PublicEndpointTypeDef
- SendUsersMessageResponseTypeDef
- EventDimensionsTypeDef
- SegmentDemographicsTypeDef
- ItemResponseTypeDef
- EventTypeDef
- ExportJobResponseTypeDef
- UpdateGcmChannelRequestRequestTypeDef
- GPSPointDimensionTypeDef
- GetJourneyExecutionActivityMetricsResponseTypeDef
- GetJourneyExecutionMetricsResponseTypeDef
- GetJourneyRunExecutionActivityMetricsResponseTypeDef
- GetJourneyRunExecutionMetricsResponseTypeDef
- GetSmsTemplateResponseTypeDef
- GetVoiceTemplateResponseTypeDef
- ImportJobResponseTypeDef
- InAppMessageButtonTypeDef
- PushMessageActivityTypeDef
- JourneyRunsResponseTypeDef
- SMSMessageActivityTypeDef
- UpdateJourneyStateRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestRequestTypeDef
- MessageResponseTypeDef
- PhoneNumberValidateRequestRequestTypeDef
- PhoneNumberValidateResponseTypeDef
- OpenHoursTypeDef
- PutEventStreamRequestRequestTypeDef
- RandomSplitActivityTypeDef
- SegmentBehaviorsTypeDef
- RemoveAttributesRequestRequestTypeDef
- ResultRowTypeDef
- UpdateSmsChannelRequestRequestTypeDef
- SendOTPMessageRequestRequestTypeDef
- SimpleEmailTypeDef
- UpdateTemplateActiveVersionRequestRequestTypeDef
- TemplateConfigurationTypeDef
- TemplatesResponseTypeDef
- TemplateVersionsResponseTypeDef
- UpdateRecommenderConfigurationRequestRequestTypeDef
- UpdateVoiceChannelRequestRequestTypeDef
- VerifyOTPMessageResponseTypeDef
- VerifyOTPMessageRequestRequestTypeDef
- GetCampaignActivitiesResponseTypeDef
- GetAppsResponseTypeDef
- GetApplicationSettingsResponseTypeDef
- UpdateApplicationSettingsResponseTypeDef
- UpdateApplicationSettingsRequestRequestTypeDef
- GetChannelsResponseTypeDef
- GetRecommenderConfigurationsResponseTypeDef
- CreatePushTemplateRequestRequestTypeDef
- UpdatePushTemplateRequestRequestTypeDef
- GetPushTemplateResponseTypeDef
- EndpointBatchRequestTypeDef
- UpdateEndpointRequestRequestTypeDef
- DeleteEndpointResponseTypeDef
- EndpointsResponseTypeDef
- GetEndpointResponseTypeDef
- SendUsersMessagesResponseTypeDef
- CampaignEventFilterTypeDef
- EventConditionTypeDef
- EventFilterTypeDef
- EventsResponseTypeDef
- EventsBatchTypeDef
- CreateExportJobResponseTypeDef
- ExportJobsResponseTypeDef
- GetExportJobResponseTypeDef
- SegmentLocationTypeDef
- CreateImportJobResponseTypeDef
- GetImportJobResponseTypeDef
- ImportJobsResponseTypeDef
- InAppMessageContentTypeDef
- GetJourneyRunsResponseTypeDef
- SendMessagesResponseTypeDef
- SendOTPMessageResponseTypeDef
- BaseKpiResultTypeDef
- EmailMessageTypeDef
- ListTemplatesResponseTypeDef
- ListTemplateVersionsResponseTypeDef
- UpdateEndpointsBatchRequestRequestTypeDef
- DeleteUserEndpointsResponseTypeDef
- GetUserEndpointsResponseTypeDef
- InAppCampaignScheduleTypeDef
- ScheduleTypeDef
- EventStartConditionTypeDef
- PutEventsResponseTypeDef
- EventsRequestTypeDef
- GetExportJobsResponseTypeDef
- GetSegmentExportJobsResponseTypeDef
- SegmentDimensionsTypeDef
- GetImportJobsResponseTypeDef
- GetSegmentImportJobsResponseTypeDef
- CampaignInAppMessageTypeDef
- InAppMessageTypeDef
- InAppTemplateRequestTypeDef
- InAppTemplateResponseTypeDef
- ApplicationDateRangeKpiResponseTypeDef
- CampaignDateRangeKpiResponseTypeDef
- JourneyDateRangeKpiResponseTypeDef
- DirectMessageConfigurationTypeDef
- StartConditionTypeDef
- PutEventsRequestRequestTypeDef
- SegmentGroupTypeDef
- SimpleConditionTypeDef
- MessageConfigurationTypeDef
- InAppMessageCampaignTypeDef
- CreateInAppTemplateRequestRequestTypeDef
- UpdateInAppTemplateRequestRequestTypeDef
- GetInAppTemplateResponseTypeDef
- GetApplicationDateRangeKpiResponseTypeDef
- GetCampaignDateRangeKpiResponseTypeDef
- GetJourneyDateRangeKpiResponseTypeDef
- MessageRequestTypeDef
- SendUsersMessageRequestTypeDef
- SegmentGroupListTypeDef
- ConditionTypeDef
- MultiConditionalBranchTypeDef
- TreatmentResourceTypeDef
- WriteTreatmentResourceTypeDef
- InAppMessagesResponseTypeDef
- SendMessagesRequestRequestTypeDef
- SendUsersMessagesRequestRequestTypeDef
- SegmentResponseTypeDef
- WriteSegmentRequestTypeDef
- ConditionalSplitActivityTypeDef
- MultiConditionalSplitActivityTypeDef
- CampaignResponseTypeDef
- WriteCampaignRequestTypeDef
- GetInAppMessagesResponseTypeDef
- CreateSegmentResponseTypeDef
- DeleteSegmentResponseTypeDef
- GetSegmentResponseTypeDef
- GetSegmentVersionResponseTypeDef
- SegmentsResponseTypeDef
- UpdateSegmentResponseTypeDef
- CreateSegmentRequestRequestTypeDef
- UpdateSegmentRequestRequestTypeDef
- ActivityTypeDef
- CampaignsResponseTypeDef
- CreateCampaignResponseTypeDef
- DeleteCampaignResponseTypeDef
- GetCampaignResponseTypeDef
- GetCampaignVersionResponseTypeDef
- UpdateCampaignResponseTypeDef
- CreateCampaignRequestRequestTypeDef
- UpdateCampaignRequestRequestTypeDef
- GetSegmentVersionsResponseTypeDef
- GetSegmentsResponseTypeDef
- JourneyResponseTypeDef
- WriteJourneyRequestTypeDef
- GetCampaignVersionsResponseTypeDef
- GetCampaignsResponseTypeDef
- CreateJourneyResponseTypeDef
- DeleteJourneyResponseTypeDef
- GetJourneyResponseTypeDef
- JourneysResponseTypeDef
- UpdateJourneyResponseTypeDef
- UpdateJourneyStateResponseTypeDef
- CreateJourneyRequestRequestTypeDef
- UpdateJourneyRequestRequestTypeDef
- ListJourneysResponseTypeDef