Skip to content

PinpointClient#

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

# PinpointClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("pinpoint")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.MethodNotAllowedException,
    client.exceptions.NotFoundException,
    client.exceptions.PayloadTooLargeException,
    client.exceptions.TooManyRequestsException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("pinpoint").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_app#

Creates an application.

Type annotations and code completion for boto3.client("pinpoint").create_app method. boto3 documentation

# create_app method definition

def create_app(
    self,
    *,
    CreateApplicationRequest: CreateApplicationRequestTypeDef,  # (1)
) -> CreateAppResponseTypeDef:  # (2)
    ...
  1. See CreateApplicationRequestTypeDef
  2. See CreateAppResponseTypeDef 
# create_app method usage example with argument unpacking

kwargs: CreateAppRequestRequestTypeDef = {  # (1)
    "CreateApplicationRequest": ...,
}

parent.create_app(**kwargs)
  1. See CreateAppRequestRequestTypeDef

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

# create_campaign method definition

def create_campaign(
    self,
    *,
    ApplicationId: str,
    WriteCampaignRequest: WriteCampaignRequestTypeDef,  # (1)
) -> CreateCampaignResponseTypeDef:  # (2)
    ...
  1. See WriteCampaignRequestTypeDef
  2. See CreateCampaignResponseTypeDef 
# create_campaign method usage example with argument unpacking

kwargs: CreateCampaignRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "WriteCampaignRequest": ...,
}

parent.create_campaign(**kwargs)
  1. See CreateCampaignRequestRequestTypeDef

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

# create_email_template method definition

def create_email_template(
    self,
    *,
    EmailTemplateRequest: EmailTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreateEmailTemplateResponseTypeDef:  # (2)
    ...
  1. See EmailTemplateRequestTypeDef
  2. See CreateEmailTemplateResponseTypeDef 
# create_email_template method usage example with argument unpacking

kwargs: CreateEmailTemplateRequestRequestTypeDef = {  # (1)
    "EmailTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_email_template(**kwargs)
  1. See CreateEmailTemplateRequestRequestTypeDef

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

# create_export_job method definition

def create_export_job(
    self,
    *,
    ApplicationId: str,
    ExportJobRequest: ExportJobRequestTypeDef,  # (1)
) -> CreateExportJobResponseTypeDef:  # (2)
    ...
  1. See ExportJobRequestTypeDef
  2. See CreateExportJobResponseTypeDef 
# create_export_job method usage example with argument unpacking

kwargs: CreateExportJobRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "ExportJobRequest": ...,
}

parent.create_export_job(**kwargs)
  1. See CreateExportJobRequestRequestTypeDef

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

# create_import_job method definition

def create_import_job(
    self,
    *,
    ApplicationId: str,
    ImportJobRequest: ImportJobRequestTypeDef,  # (1)
) -> CreateImportJobResponseTypeDef:  # (2)
    ...
  1. See ImportJobRequestTypeDef
  2. See CreateImportJobResponseTypeDef 
# create_import_job method usage example with argument unpacking

kwargs: CreateImportJobRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "ImportJobRequest": ...,
}

parent.create_import_job(**kwargs)
  1. See CreateImportJobRequestRequestTypeDef

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

# create_in_app_template method definition

def create_in_app_template(
    self,
    *,
    InAppTemplateRequest: InAppTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreateInAppTemplateResponseTypeDef:  # (2)
    ...
  1. See InAppTemplateRequestTypeDef
  2. See CreateInAppTemplateResponseTypeDef 
# create_in_app_template method usage example with argument unpacking

kwargs: CreateInAppTemplateRequestRequestTypeDef = {  # (1)
    "InAppTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_in_app_template(**kwargs)
  1. See CreateInAppTemplateRequestRequestTypeDef

create_journey#

Creates a journey for an application.

Type annotations and code completion for boto3.client("pinpoint").create_journey method. boto3 documentation

# create_journey method definition

def create_journey(
    self,
    *,
    ApplicationId: str,
    WriteJourneyRequest: WriteJourneyRequestTypeDef,  # (1)
) -> CreateJourneyResponseTypeDef:  # (2)
    ...
  1. See WriteJourneyRequestTypeDef
  2. See CreateJourneyResponseTypeDef 
# create_journey method usage example with argument unpacking

kwargs: CreateJourneyRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "WriteJourneyRequest": ...,
}

parent.create_journey(**kwargs)
  1. See CreateJourneyRequestRequestTypeDef

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

# create_push_template method definition

def create_push_template(
    self,
    *,
    PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreatePushTemplateResponseTypeDef:  # (2)
    ...
  1. See PushNotificationTemplateRequestTypeDef
  2. See CreatePushTemplateResponseTypeDef 
# create_push_template method usage example with argument unpacking

kwargs: CreatePushTemplateRequestRequestTypeDef = {  # (1)
    "PushNotificationTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_push_template(**kwargs)
  1. See CreatePushTemplateRequestRequestTypeDef

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

# create_recommender_configuration method definition

def create_recommender_configuration(
    self,
    *,
    CreateRecommenderConfiguration: CreateRecommenderConfigurationTypeDef,  # (1)
) -> CreateRecommenderConfigurationResponseTypeDef:  # (2)
    ...
  1. See CreateRecommenderConfigurationTypeDef
  2. See CreateRecommenderConfigurationResponseTypeDef 
# create_recommender_configuration method usage example with argument unpacking

kwargs: CreateRecommenderConfigurationRequestRequestTypeDef = {  # (1)
    "CreateRecommenderConfiguration": ...,
}

parent.create_recommender_configuration(**kwargs)
  1. See CreateRecommenderConfigurationRequestRequestTypeDef

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

# create_segment method definition

def create_segment(
    self,
    *,
    ApplicationId: str,
    WriteSegmentRequest: WriteSegmentRequestTypeDef,  # (1)
) -> CreateSegmentResponseTypeDef:  # (2)
    ...
  1. See WriteSegmentRequestTypeDef
  2. See CreateSegmentResponseTypeDef 
# create_segment method usage example with argument unpacking

kwargs: CreateSegmentRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "WriteSegmentRequest": ...,
}

parent.create_segment(**kwargs)
  1. See CreateSegmentRequestRequestTypeDef

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

# create_sms_template method definition

def create_sms_template(
    self,
    *,
    SMSTemplateRequest: SMSTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreateSmsTemplateResponseTypeDef:  # (2)
    ...
  1. See SMSTemplateRequestTypeDef
  2. See CreateSmsTemplateResponseTypeDef 
# create_sms_template method usage example with argument unpacking

kwargs: CreateSmsTemplateRequestRequestTypeDef = {  # (1)
    "SMSTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_sms_template(**kwargs)
  1. See CreateSmsTemplateRequestRequestTypeDef

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

# create_voice_template method definition

def create_voice_template(
    self,
    *,
    TemplateName: str,
    VoiceTemplateRequest: VoiceTemplateRequestTypeDef,  # (1)
) -> CreateVoiceTemplateResponseTypeDef:  # (2)
    ...
  1. See VoiceTemplateRequestTypeDef
  2. See CreateVoiceTemplateResponseTypeDef 
# create_voice_template method usage example with argument unpacking

kwargs: CreateVoiceTemplateRequestRequestTypeDef = {  # (1)
    "TemplateName": ...,
    "VoiceTemplateRequest": ...,
}

parent.create_voice_template(**kwargs)
  1. See CreateVoiceTemplateRequestRequestTypeDef

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

# delete_adm_channel method definition

def delete_adm_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteAdmChannelResponseTypeDef:  # (1)
    ...
  1. See DeleteAdmChannelResponseTypeDef 
# delete_adm_channel method usage example with argument unpacking

kwargs: DeleteAdmChannelRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_adm_channel(**kwargs)
  1. See DeleteAdmChannelRequestRequestTypeDef

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

# delete_apns_channel method definition

def delete_apns_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsChannelResponseTypeDef:  # (1)
    ...
  1. See DeleteApnsChannelResponseTypeDef 
# delete_apns_channel method usage example with argument unpacking

kwargs: DeleteApnsChannelRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_channel(**kwargs)
  1. See DeleteApnsChannelRequestRequestTypeDef

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

# delete_apns_sandbox_channel method definition

def delete_apns_sandbox_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsSandboxChannelResponseTypeDef:  # (1)
    ...
  1. See DeleteApnsSandboxChannelResponseTypeDef 
# delete_apns_sandbox_channel method usage example with argument unpacking

kwargs: DeleteApnsSandboxChannelRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_sandbox_channel(**kwargs)
  1. See DeleteApnsSandboxChannelRequestRequestTypeDef

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

# delete_apns_voip_channel method definition

def delete_apns_voip_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsVoipChannelResponseTypeDef:  # (1)
    ...
  1. See DeleteApnsVoipChannelResponseTypeDef 
# delete_apns_voip_channel method usage example with argument unpacking

kwargs: DeleteApnsVoipChannelRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_voip_channel(**kwargs)
  1. See DeleteApnsVoipChannelRequestRequestTypeDef

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

# delete_apns_voip_sandbox_channel method definition

def delete_apns_voip_sandbox_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsVoipSandboxChannelResponseTypeDef:  # (1)
    ...
  1. See DeleteApnsVoipSandboxChannelResponseTypeDef 
# delete_apns_voip_sandbox_channel method usage example with argument unpacking

kwargs: DeleteApnsVoipSandboxChannelRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_voip_sandbox_channel(**kwargs)
  1. See DeleteApnsVoipSandboxChannelRequestRequestTypeDef

delete_app#

Deletes an application.

Type annotations and code completion for boto3.client("pinpoint").delete_app method. boto3 documentation

# delete_app method definition

def delete_app(
    self,
    *,
    ApplicationId: str,
) -> DeleteAppResponseTypeDef:  # (1)
    ...
  1. See DeleteAppResponseTypeDef 
# delete_app method usage example with argument unpacking

kwargs: DeleteAppRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_app(**kwargs)
  1. See DeleteAppRequestRequestTypeDef

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

# delete_baidu_channel method definition

def delete_baidu_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteBaiduChannelResponseTypeDef:  # (1)
    ...
  1. See DeleteBaiduChannelResponseTypeDef 
# delete_baidu_channel method usage example with argument unpacking

kwargs: DeleteBaiduChannelRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_baidu_channel(**kwargs)
  1. See DeleteBaiduChannelRequestRequestTypeDef

delete_campaign#

Deletes a campaign from an application.

Type annotations and code completion for boto3.client("pinpoint").delete_campaign method. boto3 documentation

# delete_campaign method definition

def delete_campaign(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
) -> DeleteCampaignResponseTypeDef:  # (1)
    ...
  1. See DeleteCampaignResponseTypeDef 
# delete_campaign method usage example with argument unpacking

kwargs: DeleteCampaignRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "CampaignId": ...,
}

parent.delete_campaign(**kwargs)
  1. See DeleteCampaignRequestRequestTypeDef

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

# delete_email_channel method definition

def delete_email_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteEmailChannelResponseTypeDef:  # (1)
    ...
  1. See DeleteEmailChannelResponseTypeDef 
# delete_email_channel method usage example with argument unpacking

kwargs: DeleteEmailChannelRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_email_channel(**kwargs)
  1. See