PinpointClient
Auto-generated documentation for Pinpoint type annotations stubs module mypy-boto3-pinpoint.
PinpointClient
Type annotations and code completion for boto3.client("pinpoint")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_pinpoint.client import PinpointClient
def get_pinpoint_client() -> PinpointClient:
return Session().client("pinpoint")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("pinpoint").exceptions
structure.
client = boto3.client("pinpoint")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.ForbiddenException,
client.InternalServerErrorException,
client.MethodNotAllowedException,
client.NotFoundException,
client.PayloadTooLargeException,
client.TooManyRequestsException,
) as e:
print(e)
from mypy_boto3_pinpoint.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("pinpoint").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("pinpoint").close
method.
boto3 documentation
create_app
Creates an application.
Type annotations and code completion for boto3.client("pinpoint").create_app
method.
boto3 documentation
def create_app(
self,
*,
CreateApplicationRequest: CreateApplicationRequestTypeDef, # (1)
) -> CreateAppResponseTypeDef: # (2)
...
kwargs: CreateAppRequestRequestTypeDef = { # (1)
"CreateApplicationRequest": ...,
}
parent.create_app(**kwargs)
create_campaign
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
Type annotations and code completion for boto3.client("pinpoint").create_campaign
method.
boto3 documentation
def create_campaign(
self,
*,
ApplicationId: str,
WriteCampaignRequest: WriteCampaignRequestTypeDef, # (1)
) -> CreateCampaignResponseTypeDef: # (2)
...
kwargs: CreateCampaignRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteCampaignRequest": ...,
}
parent.create_campaign(**kwargs)
create_email_template
Creates a message template for messages that are sent through the email channel.
Type annotations and code completion for boto3.client("pinpoint").create_email_template
method.
boto3 documentation
def create_email_template(
self,
*,
EmailTemplateRequest: EmailTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateEmailTemplateResponseTypeDef: # (2)
...
kwargs: CreateEmailTemplateRequestRequestTypeDef = { # (1)
"EmailTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_email_template(**kwargs)
create_export_job
Creates an export job for an application.
Type annotations and code completion for boto3.client("pinpoint").create_export_job
method.
boto3 documentation
def create_export_job(
self,
*,
ApplicationId: str,
ExportJobRequest: ExportJobRequestTypeDef, # (1)
) -> CreateExportJobResponseTypeDef: # (2)
...
kwargs: CreateExportJobRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ExportJobRequest": ...,
}
parent.create_export_job(**kwargs)
create_import_job
Creates an import job for an application.
Type annotations and code completion for boto3.client("pinpoint").create_import_job
method.
boto3 documentation
def create_import_job(
self,
*,
ApplicationId: str,
ImportJobRequest: ImportJobRequestTypeDef, # (1)
) -> CreateImportJobResponseTypeDef: # (2)
...
kwargs: CreateImportJobRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ImportJobRequest": ...,
}
parent.create_import_job(**kwargs)
create_in_app_template
Creates a new message template for messages using the in-app message channel.
Type annotations and code completion for boto3.client("pinpoint").create_in_app_template
method.
boto3 documentation
def create_in_app_template(
self,
*,
InAppTemplateRequest: InAppTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateInAppTemplateResponseTypeDef: # (2)
...
kwargs: CreateInAppTemplateRequestRequestTypeDef = { # (1)
"InAppTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_in_app_template(**kwargs)
create_journey
Creates a journey for an application.
Type annotations and code completion for boto3.client("pinpoint").create_journey
method.
boto3 documentation
def create_journey(
self,
*,
ApplicationId: str,
WriteJourneyRequest: WriteJourneyRequestTypeDef, # (1)
) -> CreateJourneyResponseTypeDef: # (2)
...
kwargs: CreateJourneyRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteJourneyRequest": ...,
}
parent.create_journey(**kwargs)
create_push_template
Creates a message template for messages that are sent through a push notification channel.
Type annotations and code completion for boto3.client("pinpoint").create_push_template
method.
boto3 documentation
def create_push_template(
self,
*,
PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreatePushTemplateResponseTypeDef: # (2)
...
kwargs: CreatePushTemplateRequestRequestTypeDef = { # (1)
"PushNotificationTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_push_template(**kwargs)
create_recommender_configuration
Creates an Amazon Pinpoint configuration for a recommender model.
Type annotations and code completion for boto3.client("pinpoint").create_recommender_configuration
method.
boto3 documentation
def create_recommender_configuration(
self,
*,
CreateRecommenderConfiguration: CreateRecommenderConfigurationTypeDef, # (1)
) -> CreateRecommenderConfigurationResponseTypeDef: # (2)
...
kwargs: CreateRecommenderConfigurationRequestRequestTypeDef = { # (1)
"CreateRecommenderConfiguration": ...,
}
parent.create_recommender_configuration(**kwargs)
create_segment
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
Type annotations and code completion for boto3.client("pinpoint").create_segment
method.
boto3 documentation
def create_segment(
self,
*,
ApplicationId: str,
WriteSegmentRequest: WriteSegmentRequestTypeDef, # (1)
) -> CreateSegmentResponseTypeDef: # (2)
...
kwargs: CreateSegmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteSegmentRequest": ...,
}
parent.create_segment(**kwargs)
create_sms_template
Creates a message template for messages that are sent through the SMS channel.
Type annotations and code completion for boto3.client("pinpoint").create_sms_template
method.
boto3 documentation
def create_sms_template(
self,
*,
SMSTemplateRequest: SMSTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateSmsTemplateResponseTypeDef: # (2)
...
kwargs: CreateSmsTemplateRequestRequestTypeDef = { # (1)
"SMSTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_sms_template(**kwargs)
create_voice_template
Creates a message template for messages that are sent through the voice channel.
Type annotations and code completion for boto3.client("pinpoint").create_voice_template
method.
boto3 documentation
def create_voice_template(
self,
*,
TemplateName: str,
VoiceTemplateRequest: VoiceTemplateRequestTypeDef, # (1)
) -> CreateVoiceTemplateResponseTypeDef: # (2)
...
kwargs: CreateVoiceTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"VoiceTemplateRequest": ...,
}
parent.create_voice_template(**kwargs)
delete_adm_channel
Disables the ADM channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_adm_channel
method.
boto3 documentation
def delete_adm_channel(
self,
*,
ApplicationId: str,
) -> DeleteAdmChannelResponseTypeDef: # (1)
...
kwargs: DeleteAdmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_adm_channel(**kwargs)
delete_apns_channel
Disables the APNs channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_apns_channel
method.
boto3 documentation
def delete_apns_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsChannelResponseTypeDef: # (1)
...
kwargs: DeleteApnsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_channel(**kwargs)
delete_apns_sandbox_channel
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_apns_sandbox_channel
method.
boto3 documentation
def delete_apns_sandbox_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsSandboxChannelResponseTypeDef: # (1)
...
kwargs: DeleteApnsSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_sandbox_channel(**kwargs)
delete_apns_voip_channel
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_apns_voip_channel
method.
boto3 documentation
def delete_apns_voip_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsVoipChannelResponseTypeDef: # (1)
...
kwargs: DeleteApnsVoipChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_voip_channel(**kwargs)
delete_apns_voip_sandbox_channel
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_apns_voip_sandbox_channel
method.
boto3 documentation
def delete_apns_voip_sandbox_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsVoipSandboxChannelResponseTypeDef: # (1)
...
kwargs: DeleteApnsVoipSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_voip_sandbox_channel(**kwargs)
delete_app
Deletes an application.
Type annotations and code completion for boto3.client("pinpoint").delete_app
method.
boto3 documentation
def delete_app(
self,
*,
ApplicationId: str,
) -> DeleteAppResponseTypeDef: # (1)
...
kwargs: DeleteAppRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_app(**kwargs)
delete_baidu_channel
Disables the Baidu channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_baidu_channel
method.
boto3 documentation
def delete_baidu_channel(
self,
*,
ApplicationId: str,
) -> DeleteBaiduChannelResponseTypeDef: # (1)
...
kwargs: DeleteBaiduChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_baidu_channel(**kwargs)
delete_campaign
Deletes a campaign from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_campaign
method.
boto3 documentation
def delete_campaign(
self,
*,
ApplicationId: str,
CampaignId: str,
) -> DeleteCampaignResponseTypeDef: # (1)
...
kwargs: DeleteCampaignRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
}
parent.delete_campaign(**kwargs)
delete_email_channel
Disables the email channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_email_channel
method.
boto3 documentation
def delete_email_channel(
self,
*,
ApplicationId: str,
) -> DeleteEmailChannelResponseTypeDef: # (1)
...
kwargs: DeleteEmailChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_email_channel(**kwargs)
delete_email_template
Deletes a message template for messages that were sent through the email channel.
Type annotations and code completion for boto3.client("pinpoint").delete_email_template
method.
boto3 documentation
def delete_email_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteEmailTemplateResponseTypeDef: # (1)
...
kwargs: DeleteEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_email_template(**kwargs)
delete_endpoint
Deletes an endpoint from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_endpoint
method.
boto3 documentation
def delete_endpoint(
self,
*,
ApplicationId: str,
EndpointId: str,
) -> DeleteEndpointResponseTypeDef: # (1)
...
kwargs: DeleteEndpointRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EndpointId": ...,
}
parent.delete_endpoint(**kwargs)
delete_event_stream
Deletes the event stream for an application.
Type annotations and code completion for boto3.client("pinpoint").delete_event_stream
method.
boto3 documentation
def delete_event_stream(
self,
*,
ApplicationId: str,
) -> DeleteEventStreamResponseTypeDef: # (1)
...
kwargs: DeleteEventStreamRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_event_stream(**kwargs)
delete_gcm_channel
Disables the GCM channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_gcm_channel
method.
boto3 documentation
def delete_gcm_channel(
self,
*,
ApplicationId: str,
) -> DeleteGcmChannelResponseTypeDef: # (1)
...
kwargs: DeleteGcmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_gcm_channel(**kwargs)
delete_in_app_template
Deletes a message template for messages sent using the in-app message channel.
Type annotations and code completion for boto3.client("pinpoint").delete_in_app_template
method.
boto3 documentation
def delete_in_app_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteInAppTemplateResponseTypeDef: # (1)
...
kwargs: DeleteInAppTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_in_app_template(**kwargs)
delete_journey
Deletes a journey from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_journey
method.
boto3 documentation
def delete_journey(
self,
*,
ApplicationId: str,
JourneyId: str,
) -> DeleteJourneyResponseTypeDef: # (1)
...
kwargs: DeleteJourneyRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
}
parent.delete_journey(**kwargs)
delete_push_template
Deletes a message template for messages that were sent through a push notification channel.
Type annotations and code completion for boto3.client("pinpoint").delete_push_template
method.
boto3 documentation
def delete_push_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeletePushTemplateResponseTypeDef: # (1)
...
kwargs: DeletePushTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_push_template(**kwargs)
delete_recommender_configuration
Deletes an Amazon Pinpoint configuration for a recommender model.
Type annotations and code completion for boto3.client("pinpoint").delete_recommender_configuration
method.
boto3 documentation
def delete_recommender_configuration(
self,
*,
RecommenderId: str,
) -> DeleteRecommenderConfigurationResponseTypeDef: # (1)
...
kwargs: DeleteRecommenderConfigurationRequestRequestTypeDef = { # (1)
"RecommenderId": ...,
}
parent.delete_recommender_configuration(**kwargs)
delete_segment
Deletes a segment from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_segment
method.
boto3 documentation
def delete_segment(
self,
*,
ApplicationId: str,
SegmentId: str,
) -> DeleteSegmentResponseTypeDef: # (1)
...
kwargs: DeleteSegmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
}
parent.delete_segment(**kwargs)
delete_sms_channel
Disables the SMS channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_sms_channel
method.
boto3 documentation
def delete_sms_channel(
self,
*,
ApplicationId: str,
) -> DeleteSmsChannelResponseTypeDef: # (1)
...
kwargs: DeleteSmsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_sms_channel(**kwargs)
delete_sms_template
Deletes a message template for messages that were sent through the SMS channel.
Type annotations and code completion for boto3.client("pinpoint").delete_sms_template
method.
boto3 documentation
def delete_sms_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteSmsTemplateResponseTypeDef: # (1)
...
kwargs: DeleteSmsTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_sms_template(**kwargs)
delete_user_endpoints
Deletes all the endpoints that are associated with a specific user ID.
Type annotations and code completion for boto3.client("pinpoint").delete_user_endpoints
method.
boto3 documentation
def delete_user_endpoints(
self,
*,
ApplicationId: str,
UserId: str,
) -> DeleteUserEndpointsResponseTypeDef: # (1)
...
kwargs: DeleteUserEndpointsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"UserId": ...,
}
parent.delete_user_endpoints(**kwargs)
delete_voice_channel
Disables the voice channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for boto3.client("pinpoint").delete_voice_channel
method.
boto3 documentation
def delete_voice_channel(
self,
*,
ApplicationId: str,
) -> DeleteVoiceChannelResponseTypeDef: # (1)
...
kwargs: DeleteVoiceChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_voice_channel(**kwargs)
delete_voice_template
Deletes a message template for messages that were sent through the voice channel.
Type annotations and code completion for boto3.client("pinpoint").delete_voice_template
method.
boto3 documentation
def delete_voice_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteVoiceTemplateResponseTypeDef: # (1)
...
kwargs: DeleteVoiceTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_voice_template(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("pinpoint").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_adm_channel
Retrieves information about the status and settings of the ADM channel for an application.
Type annotations and code completion for boto3.client("pinpoint").get_adm_channel
method.
boto3 documentation
def get_adm_channel(
self,
*,
ApplicationId: str,
) -> GetAdmChannelResponseTypeDef: # (1)
...
kwargs: GetAdmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_adm_channel(**kwargs)
get_apns_channel
Retrieves information about the status and settings of the APNs channel for an application.
Type annotations and code completion for boto3.client("pinpoint").get_apns_channel
method.
boto3 documentation
def get_apns_channel(
self,
*,
ApplicationId: str,
) -> GetApnsChannelResponseTypeDef: # (1)
...
kwargs: GetApnsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_channel(**kwargs)
get_apns_sandbox_channel
Retrieves information about the status and settings of the APNs sandbox channel for an application.
Type annotations and code completion for boto3.client("pinpoint").get_apns_sandbox_channel
method.
boto3 documentation
def get_apns_sandbox_channel(
self,
*,
ApplicationId: str,
) -> GetApnsSandboxChannelResponseTypeDef: # (1)
...
kwargs: GetApnsSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_sandbox_channel(**kwargs)
get_apns_voip_channel
Retrieves information about the status and settings of the APNs VoIP channel for an application.
Type annotations and code completion for boto3.client("pinpoint").get_apns_voip_channel
method.
boto3 documentation
def get_apns_voip_channel(
self,
*,
ApplicationId: str,
) -> GetApnsVoipChannelResponseTypeDef: # (1)
...
kwargs: GetApnsVoipChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_voip_channel(**kwargs)
get_apns_voip_sandbox_channel
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
Type annotations and code completion for boto3.client("pinpoint").get_apns_voip_sandbox_channel
method.
boto3 documentation
def get_apns_voip_sandbox_channel(
self,
*,
ApplicationId: str,
) -> GetApnsVoipSandboxChannelResponseTypeDef: # (1)
...
kwargs: GetApnsVoipSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_voip_sandbox_channel(**kwargs)
get_app
Retrieves information about an application.
Type annotations and code completion for boto3.client("pinpoint").get_app
method.
boto3 documentation
kwargs: GetAppRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_app(**kwargs)
get_application_date_range_kpi
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
Type annotations and code completion for boto3.client("pinpoint").get_application_date_range_kpi
method.
boto3 documentation
def get_application_date_range_kpi(
self,
*,
ApplicationId: str,
KpiName: str,
EndTime: Union[datetime, str] = ...,
NextToken: str = ...,
PageSize: str = ...,
StartTime: Union[datetime, str] = ...,
) -> GetApplicationDateRangeKpiResponseTypeDef: # (1)
...
kwargs: GetApplicationDateRangeKpiRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"KpiName": ...,
}
parent.get_application_date_range_kpi(**kwargs)
get_application_settings
Retrieves information about the settings for an application.
Type annotations and code completion for boto3.client("pinpoint").get_application_settings
method.
boto3 documentation