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 DeleteEmailChannelRequestRequestTypeDef

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

# delete_email_template method definition

def delete_email_template(
    self,
    *,
    TemplateName: str,
    Version: str = ...,
) -> DeleteEmailTemplateResponseTypeDef:  # (1)
    ...

1. See DeleteEmailTemplateResponseTypeDef

# delete_email_template method usage example with argument unpacking

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

parent.delete_email_template(**kwargs)

1. See DeleteEmailTemplateRequestRequestTypeDef

delete_endpoint

Deletes an endpoint from an application.

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

# delete_endpoint method definition

def delete_endpoint(
    self,
    *,
    ApplicationId: str,
    EndpointId: str,
) -> DeleteEndpointResponseTypeDef:  # (1)
    ...

1. See DeleteEndpointResponseTypeDef

# delete_endpoint method usage example with argument unpacking

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

parent.delete_endpoint(**kwargs)

1. See DeleteEndpointRequestRequestTypeDef

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

# delete_event_stream method definition

def delete_event_stream(
    self,
    *,
    ApplicationId: str,
) -> DeleteEventStreamResponseTypeDef:  # (1)
    ...

1. See DeleteEventStreamResponseTypeDef

# delete_event_stream method usage example with argument unpacking

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

parent.delete_event_stream(**kwargs)

1. See DeleteEventStreamRequestRequestTypeDef

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

# delete_gcm_channel method definition

def delete_gcm_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteGcmChannelResponseTypeDef:  # (1)
    ...

1. See DeleteGcmChannelResponseTypeDef

# delete_gcm_channel method usage example with argument unpacking

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

parent.delete_gcm_channel(**kwargs)

1. See DeleteGcmChannelRequestRequestTypeDef

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

# delete_in_app_template method definition

def delete_in_app_template(
    self,
    *,
    TemplateName: str,
    Version: str = ...,
) -> DeleteInAppTemplateResponseTypeDef:  # (1)
    ...

1. See DeleteInAppTemplateResponseTypeDef

# delete_in_app_template method usage example with argument unpacking

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

parent.delete_in_app_template(**kwargs)

1. See DeleteInAppTemplateRequestRequestTypeDef

delete_journey

Deletes a journey from an application.

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

# delete_journey method definition

def delete_journey(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
) -> DeleteJourneyResponseTypeDef:  # (1)
    ...

1. See DeleteJourneyResponseTypeDef

# delete_journey method usage example with argument unpacking

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

parent.delete_journey(**kwargs)

1. See DeleteJourneyRequestRequestTypeDef

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

# delete_push_template method definition

def delete_push_template(
    self,
    *,
    TemplateName: str,
    Version: str = ...,
) -> DeletePushTemplateResponseTypeDef:  # (1)
    ...

1. See DeletePushTemplateResponseTypeDef

# delete_push_template method usage example with argument unpacking

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

parent.delete_push_template(**kwargs)

1. See DeletePushTemplateRequestRequestTypeDef

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

# delete_recommender_configuration method definition

def delete_recommender_configuration(
    self,
    *,
    RecommenderId: str,
) -> DeleteRecommenderConfigurationResponseTypeDef:  # (1)
    ...

1. See DeleteRecommenderConfigurationResponseTypeDef

# delete_recommender_configuration method usage example with argument unpacking

kwargs: DeleteRecommenderConfigurationRequestRequestTypeDef = {  # (1)
    "RecommenderId": ...,
}

parent.delete_recommender_configuration(**kwargs)

1. See DeleteRecommenderConfigurationRequestRequestTypeDef

delete_segment

Deletes a segment from an application.

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

# delete_segment method definition

def delete_segment(
    self,
    *,
    ApplicationId: str,
    SegmentId: str,
) -> DeleteSegmentResponseTypeDef:  # (1)
    ...

1. See DeleteSegmentResponseTypeDef

# delete_segment method usage example with argument unpacking

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

parent.delete_segment(**kwargs)

1. See DeleteSegmentRequestRequestTypeDef

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

# delete_sms_channel method definition

def delete_sms_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteSmsChannelResponseTypeDef:  # (1)
    ...

1. See DeleteSmsChannelResponseTypeDef

# delete_sms_channel method usage example with argument unpacking

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

parent.delete_sms_channel(**kwargs)

1. See DeleteSmsChannelRequestRequestTypeDef

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

# delete_sms_template method definition

def delete_sms_template(
    self,
    *,
    TemplateName: str,
    Version: str = ...,
) -> DeleteSmsTemplateResponseTypeDef:  # (1)
    ...

1. See DeleteSmsTemplateResponseTypeDef

# delete_sms_template method usage example with argument unpacking

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

parent.delete_sms_template(**kwargs)

1. See DeleteSmsTemplateRequestRequestTypeDef

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

# delete_user_endpoints method definition

def delete_user_endpoints(
    self,
    *,
    ApplicationId: str,
    UserId: str,
) -> DeleteUserEndpointsResponseTypeDef:  # (1)
    ...

1. See DeleteUserEndpointsResponseTypeDef

# delete_user_endpoints method usage example with argument unpacking

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

parent.delete_user_endpoints(**kwargs)

1. See DeleteUserEndpointsRequestRequestTypeDef

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

# delete_voice_channel method definition

def delete_voice_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteVoiceChannelResponseTypeDef:  # (1)
    ...

1. See DeleteVoiceChannelResponseTypeDef

# delete_voice_channel method usage example with argument unpacking

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

parent.delete_voice_channel(**kwargs)

1. See DeleteVoiceChannelRequestRequestTypeDef

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

# delete_voice_template method definition

def delete_voice_template(
    self,
    *,
    TemplateName: str,
    Version: str = ...,
) -> DeleteVoiceTemplateResponseTypeDef:  # (1)
    ...

1. See DeleteVoiceTemplateResponseTypeDef

# delete_voice_template method usage example with argument unpacking

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

parent.delete_voice_template(**kwargs)

1. See DeleteVoiceTemplateRequestRequestTypeDef

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

# generate_presigned_url method definition

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

# get_adm_channel method definition

def get_adm_channel(
    self,
    *,
    ApplicationId: str,
) -> GetAdmChannelResponseTypeDef:  # (1)
    ...

1. See GetAdmChannelResponseTypeDef

# get_adm_channel method usage example with argument unpacking

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

parent.get_adm_channel(**kwargs)

1. See GetAdmChannelRequestRequestTypeDef

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

# get_apns_channel method definition

def get_apns_channel(
    self,
    *,
    ApplicationId: str,
) -> GetApnsChannelResponseTypeDef:  # (1)
    ...

1. See GetApnsChannelResponseTypeDef

# get_apns_channel method usage example with argument unpacking

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

parent.get_apns_channel(**kwargs)

1. See GetApnsChannelRequestRequestTypeDef

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

# get_apns_sandbox_channel method definition

def get_apns_sandbox_channel(
    self,
    *,
    ApplicationId: str,
) -> GetApnsSandboxChannelResponseTypeDef:  # (1)
    ...

1. See GetApnsSandboxChannelResponseTypeDef

# get_apns_sandbox_channel method usage example with argument unpacking

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

parent.get_apns_sandbox_channel(**kwargs)

1. See GetApnsSandboxChannelRequestRequestTypeDef

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

# get_apns_voip_channel method definition

def get_apns_voip_channel(
    self,
    *,
    ApplicationId: str,
) -> GetApnsVoipChannelResponseTypeDef:  # (1)
    ...

1. See GetApnsVoipChannelResponseTypeDef

# get_apns_voip_channel method usage example with argument unpacking

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

parent.get_apns_voip_channel(**kwargs)

1. See GetApnsVoipChannelRequestRequestTypeDef

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

# get_apns_voip_sandbox_channel method definition

def get_apns_voip_sandbox_channel(
    self,
    *,
    ApplicationId: str,
) -> GetApnsVoipSandboxChannelResponseTypeDef:  # (1)
    ...

1. See GetApnsVoipSandboxChannelResponseTypeDef

# get_apns_voip_sandbox_channel method usage example with argument unpacking

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

parent.get_apns_voip_sandbox_channel(**kwargs)

1. See GetApnsVoipSandboxChannelRequestRequestTypeDef

get_app

Retrieves information about an application.

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

# get_app method definition

def get_app(
    self,
    *,
    ApplicationId: str,
) -> GetAppResponseTypeDef:  # (1)
    ...

1. See GetAppResponseTypeDef

# get_app method usage example with argument unpacking

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

parent.get_app(**kwargs)

1. See GetAppRequestRequestTypeDef

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

# get_application_date_range_kpi method definition

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

1. See GetApplicationDateRangeKpiResponseTypeDef

# get_application_date_range_kpi method usage example with argument unpacking

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

parent.get_application_date_range_kpi(**kwargs)

1. See GetApplicationDateRangeKpiRequestRequestTypeDef

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

# get_application_settings method definition

def get_application_settings(
    self,
    *,
    ApplicationId: str,
) -> GetApplicationSettingsResponseTypeDef:  # (1)
    ...

1. See GetApplicationSettingsResponseTypeDef

# get_application_settings method usage example with argument unpacking

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

parent.get_application_settings(**kwargs)

1. See GetApplicationSettingsRequestRequestTypeDef

get_apps

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

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

# get_apps method definition

def get_apps(
    self,
    *,
    PageSize: str = ...,
    Token: str = ...,
) -> GetAppsResponseTypeDef:  # (1)
    ...

1. See GetAppsResponseTypeDef

# get_apps method usage example with argument unpacking

kwargs: GetAppsRequestRequestTypeDef = {  # (1)
    "PageSize": ...,
}

parent.get_apps(**kwargs)

1. See GetAppsRequestRequestTypeDef

get_baidu_channel

Retrieves information about the status and settings of the Baidu channel for an application.

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

# get_baidu_channel method definition

def get_baidu_channel(
    self,
    *,
    ApplicationId: str,
) -> GetBaiduChannelResponseTypeDef:  # (1)
    ...

1. See GetBaiduChannelResponseTypeDef

# get_baidu_channel method usage example with argument unpacking

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

parent.get_baidu_channel(**kwargs)

1. See GetBaiduChannelRequestRequestTypeDef

get_campaign

Retrieves information about the status, configuration, and other settings for a campaign.

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

# get_campaign method definition

def get_campaign(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
) -> GetCampaignResponseTypeDef:  # (1)
    ...

1. See GetCampaignResponseTypeDef

# get_campaign method usage example with argument unpacking

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

parent.get_campaign(**kwargs)

1. See GetCampaignRequestRequestTypeDef

get_campaign_activities

Retrieves information about all the activities for a campaign.

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

# get_campaign_activities method definition

def get_campaign_activities(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetCampaignActivitiesResponseTypeDef:  # (1)
    ...

1. See GetCampaignActivitiesResponseTypeDef

# get_campaign_activities method usage example with argument unpacking

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

parent.get_campaign_activities(**kwargs)

1. See GetCampaignActivitiesRequestRequestTypeDef

get_campaign_date_range_kpi

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

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

# get_campaign_date_range_kpi method definition

def get_campaign_date_range_kpi(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
    KpiName: str,
    EndTime: Union[datetime, str] = ...,
    NextToken: str = ...,
    PageSize: str = ...,
    StartTime: Union[datetime, str] = ...,
) -> GetCampaignDateRangeKpiResponseTypeDef:  # (1)
    ...

1. See GetCampaignDateRangeKpiResponseTypeDef

# get_campaign_date_range_kpi method usage example with argument unpacking

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

parent.get_campaign_date_range_kpi(**kwargs)

1. See GetCampaignDateRangeKpiRequestRequestTypeDef

get_campaign_version

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

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

# get_campaign_version method definition

def get_campaign_version(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
    Version: str,
) -> GetCampaignVersionResponseTypeDef:  # (1)
    ...

1. See GetCampaignVersionResponseTypeDef

# get_campaign_version method usage example with argument unpacking

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

parent.get_campaign_version(**kwargs)

1. See GetCampaignVersionRequestRequestTypeDef

get_campaign_versions

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

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

# get_campaign_versions method definition

def get_campaign_versions(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetCampaignVersionsResponseTypeDef:  # (1)
    ...

1. See GetCampaignVersionsResponseTypeDef

# get_campaign_versions method usage example with argument unpacking

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

parent.get_campaign_versions(**kwargs)

1. See GetCampaignVersionsRequestRequestTypeDef

get_campaigns

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

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

# get_campaigns method definition

def get_campaigns(
    self,
    *,
    ApplicationId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetCampaignsResponseTypeDef:  # (1)
    ...

1. See GetCampaignsResponseTypeDef

# get_campaigns method usage example with argument unpacking

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

parent.get_campaigns(**kwargs)

1. See GetCampaignsRequestRequestTypeDef

get_channels

Retrieves information about the history and status of each channel for an application.

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

# get_channels method definition

def get_channels(
    self,
    *,
    ApplicationId: str,
) -> GetChannelsResponseTypeDef:  # (1)
    ...

1. See GetChannelsResponseTypeDef

# get_channels method usage example with argument unpacking

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

parent.get_channels(**kwargs)

1. See GetChannelsRequestRequestTypeDef

get_email_channel

Retrieves information about the status and settings of the email channel for an application.

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

# get_email_channel method definition

def get_email_channel(
    self,
    *,
    ApplicationId: str,
) -> GetEmailChannelResponseTypeDef:  # (1)
    ...

1. See GetEmailChannelResponseTypeDef

# get_email_channel method usage example with argument unpacking

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

parent.get_email_channel(**kwargs)

1. See GetEmailChannelRequestRequestTypeDef

get_email_template

Retrieves the content and settings of a message template for messages that are sent through the email channel.

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

# get_email_template method definition

def get_email_template(
    self,
    *,
    TemplateName: str,
    Version: str = ...,
) -> GetEmailTemplateResponseTypeDef:  # (1)
    ...

1. See GetEmailTemplateResponseTypeDef

# get_email_template method usage example with argument unpacking

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

parent.get_email_template(**kwargs)

1. See GetEmailTemplateRequestRequestTypeDef

get_endpoint

Retrieves information about the settings and attributes of a specific endpoint for an application.

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

# get_endpoint method definition

def get_endpoint(
    self,
    *,
    ApplicationId: str,
    EndpointId: str,
) -> GetEndpointResponseTypeDef:  # (1)
    ...

1. See GetEndpointResponseTypeDef

# get_endpoint method usage example with argument unpacking

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

parent.get_endpoint(**kwargs)

1. See GetEndpointRequestRequestTypeDef

get_event_stream

Retrieves information about the event stream settings for an application.

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

# get_event_stream method definition

def get_event_stream(
    self,
    *,
    ApplicationId: str,
) -> GetEventStreamResponseTypeDef:  # (1)
    ...

1. See GetEventStreamResponseTypeDef

# get_event_stream method usage example with argument unpacking

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

parent.get_event_stream(**kwargs)

1. See GetEventStreamRequestRequestTypeDef

get_export_job

Retrieves information about the status and settings of a specific export job for an application.

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

# get_export_job method definition

def get_export_job(
    self,
    *,
    ApplicationId: str,
    JobId: str,
) -> GetExportJobResponseTypeDef:  # (1)
    ...

1. See GetExportJobResponseTypeDef

# get_export_job method usage example with argument unpacking

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

parent.get_export_job(**kwargs)

1. See GetExportJobRequestRequestTypeDef

get_export_jobs

Retrieves information about the status and settings of all the export jobs for an application.

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

# get_export_jobs method definition

def get_export_jobs(
    self,
    *,
    ApplicationId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetExportJobsResponseTypeDef:  # (1)
    ...

1. See GetExportJobsResponseTypeDef

# get_export_jobs method usage example with argument unpacking

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

parent.get_export_jobs(**kwargs)

1. See GetExportJobsRequestRequestTypeDef

get_gcm_channel

Retrieves information about the status and settings of the GCM channel for an application.

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

# get_gcm_channel method definition

def get_gcm_channel(
    self,
    *,
    ApplicationId: str,
) -> GetGcmChannelResponseTypeDef:  # (1)
    ...

1. See GetGcmChannelResponseTypeDef

# get_gcm_channel method usage example with argument unpacking

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

parent.get_gcm_channel(**kwargs)

1. See GetGcmChannelRequestRequestTypeDef

get_import_job

Retrieves information about the status and settings of a specific import job for an application.

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

# get_import_job method definition

def get_import_job(
    self,
    *,
    ApplicationId: str,
    JobId: str,
) -> GetImportJobResponseTypeDef:  # (1)
    ...

1. See GetImportJobResponseTypeDef

# get_import_job method usage example with argument unpacking

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

parent.get_import_job(**kwargs)

1. See GetImportJobRequestRequestTypeDef

get_import_jobs

Retrieves information about the status and settings of all the import jobs for an application.

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