PinpointClient

Index > Pinpoint > PinpointClient

Auto-generated documentation for Pinpoint type annotations stubs module types-boto3-pinpoint.

PinpointClient

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

# PinpointClient usage example

from boto3.session import Session
from types_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 types_boto3_pinpoint.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

can_paginate

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

generate_presigned_url

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

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: CreateAppRequestTypeDef = {  # (1)
    "CreateApplicationRequest": ...,
}

parent.create_app(**kwargs)

1. See CreateAppRequestTypeDef

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: CreateCampaignRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "WriteCampaignRequest": ...,
}

parent.create_campaign(**kwargs)

1. See CreateCampaignRequestTypeDef

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: CreateEmailTemplateRequestTypeDef = {  # (1)
    "EmailTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_email_template(**kwargs)

1. See CreateEmailTemplateRequestTypeDef

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: CreateExportJobRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "ExportJobRequest": ...,
}

parent.create_export_job(**kwargs)

1. See CreateExportJobRequestTypeDef

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: CreateImportJobRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "ImportJobRequest": ...,
}

parent.create_import_job(**kwargs)

1. See CreateImportJobRequestTypeDef

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: CreateInAppTemplateRequestTypeDef = {  # (1)
    "InAppTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_in_app_template(**kwargs)

1. See CreateInAppTemplateRequestTypeDef

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: CreateJourneyRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "WriteJourneyRequest": ...,
}

parent.create_journey(**kwargs)

1. See CreateJourneyRequestTypeDef

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: CreatePushTemplateRequestTypeDef = {  # (1)
    "PushNotificationTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_push_template(**kwargs)

1. See CreatePushTemplateRequestTypeDef

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: CreateRecommenderConfigurationRequestTypeDef = {  # (1)
    "CreateRecommenderConfiguration": ...,
}

parent.create_recommender_configuration(**kwargs)

1. See CreateRecommenderConfigurationRequestTypeDef

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: CreateSegmentRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "WriteSegmentRequest": ...,
}

parent.create_segment(**kwargs)

1. See CreateSegmentRequestTypeDef

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: CreateSmsTemplateRequestTypeDef = {  # (1)
    "SMSTemplateRequest": ...,
    "TemplateName": ...,
}

parent.create_sms_template(**kwargs)

1. See CreateSmsTemplateRequestTypeDef

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: CreateVoiceTemplateRequestTypeDef = {  # (1)
    "TemplateName": ...,
    "VoiceTemplateRequest": ...,
}

parent.create_voice_template(**kwargs)

1. See CreateVoiceTemplateRequestTypeDef

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: DeleteAdmChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_adm_channel(**kwargs)

1. See DeleteAdmChannelRequestTypeDef

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: DeleteApnsChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_channel(**kwargs)

1. See DeleteApnsChannelRequestTypeDef

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: DeleteApnsSandboxChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_sandbox_channel(**kwargs)

1. See DeleteApnsSandboxChannelRequestTypeDef

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: DeleteApnsVoipChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_voip_channel(**kwargs)

1. See DeleteApnsVoipChannelRequestTypeDef

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: DeleteApnsVoipSandboxChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_apns_voip_sandbox_channel(**kwargs)

1. See DeleteApnsVoipSandboxChannelRequestTypeDef

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: DeleteAppRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_app(**kwargs)

1. See DeleteAppRequestTypeDef

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: DeleteBaiduChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_baidu_channel(**kwargs)

1. See DeleteBaiduChannelRequestTypeDef

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: DeleteCampaignRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "CampaignId": ...,
}

parent.delete_campaign(**kwargs)

1. See DeleteCampaignRequestTypeDef

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: DeleteEmailChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_email_channel(**kwargs)

1. See DeleteEmailChannelRequestTypeDef

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: DeleteEmailTemplateRequestTypeDef = {  # (1)
    "TemplateName": ...,
}

parent.delete_email_template(**kwargs)

1. See DeleteEmailTemplateRequestTypeDef

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: DeleteEndpointRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "EndpointId": ...,
}

parent.delete_endpoint(**kwargs)

1. See DeleteEndpointRequestTypeDef

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: DeleteEventStreamRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_event_stream(**kwargs)

1. See DeleteEventStreamRequestTypeDef

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: DeleteGcmChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_gcm_channel(**kwargs)

1. See DeleteGcmChannelRequestTypeDef

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: DeleteInAppTemplateRequestTypeDef = {  # (1)
    "TemplateName": ...,
}

parent.delete_in_app_template(**kwargs)

1. See DeleteInAppTemplateRequestTypeDef

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: DeleteJourneyRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "JourneyId": ...,
}

parent.delete_journey(**kwargs)

1. See DeleteJourneyRequestTypeDef

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: DeletePushTemplateRequestTypeDef = {  # (1)
    "TemplateName": ...,
}

parent.delete_push_template(**kwargs)

1. See DeletePushTemplateRequestTypeDef

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: DeleteRecommenderConfigurationRequestTypeDef = {  # (1)
    "RecommenderId": ...,
}

parent.delete_recommender_configuration(**kwargs)

1. See DeleteRecommenderConfigurationRequestTypeDef

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: DeleteSegmentRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "SegmentId": ...,
}

parent.delete_segment(**kwargs)

1. See DeleteSegmentRequestTypeDef

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: DeleteSmsChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_sms_channel(**kwargs)

1. See DeleteSmsChannelRequestTypeDef

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: DeleteSmsTemplateRequestTypeDef = {  # (1)
    "TemplateName": ...,
}

parent.delete_sms_template(**kwargs)

1. See DeleteSmsTemplateRequestTypeDef

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: DeleteUserEndpointsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "UserId": ...,
}

parent.delete_user_endpoints(**kwargs)

1. See DeleteUserEndpointsRequestTypeDef

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: DeleteVoiceChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_voice_channel(**kwargs)

1. See DeleteVoiceChannelRequestTypeDef

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: DeleteVoiceTemplateRequestTypeDef = {  # (1)
    "TemplateName": ...,
}

parent.delete_voice_template(**kwargs)

1. See DeleteVoiceTemplateRequestTypeDef

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: GetAdmChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_adm_channel(**kwargs)

1. See GetAdmChannelRequestTypeDef

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: GetApnsChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_apns_channel(**kwargs)

1. See GetApnsChannelRequestTypeDef

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: GetApnsSandboxChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_apns_sandbox_channel(**kwargs)

1. See GetApnsSandboxChannelRequestTypeDef

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: GetApnsVoipChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_apns_voip_channel(**kwargs)

1. See GetApnsVoipChannelRequestTypeDef

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: GetApnsVoipSandboxChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_apns_voip_sandbox_channel(**kwargs)

1. See GetApnsVoipSandboxChannelRequestTypeDef

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: GetAppRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_app(**kwargs)

1. See GetAppRequestTypeDef

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: TimestampTypeDef = ...,
    NextToken: str = ...,
    PageSize: str = ...,
    StartTime: TimestampTypeDef = ...,
) -> GetApplicationDateRangeKpiResponseTypeDef:  # (1)
    ...

1. See GetApplicationDateRangeKpiResponseTypeDef

# get_application_date_range_kpi method usage example with argument unpacking

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

parent.get_application_date_range_kpi(**kwargs)

1. See GetApplicationDateRangeKpiRequestTypeDef

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: GetApplicationSettingsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_application_settings(**kwargs)

1. See GetApplicationSettingsRequestTypeDef

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: GetAppsRequestTypeDef = {  # (1)
    "PageSize": ...,
}

parent.get_apps(**kwargs)

1. See GetAppsRequestTypeDef

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: GetBaiduChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_baidu_channel(**kwargs)

1. See GetBaiduChannelRequestTypeDef

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: GetCampaignRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "CampaignId": ...,
}

parent.get_campaign(**kwargs)

1. See GetCampaignRequestTypeDef

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: GetCampaignActivitiesRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "CampaignId": ...,
}

parent.get_campaign_activities(**kwargs)

1. See GetCampaignActivitiesRequestTypeDef

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: TimestampTypeDef = ...,
    NextToken: str = ...,
    PageSize: str = ...,
    StartTime: TimestampTypeDef = ...,
) -> GetCampaignDateRangeKpiResponseTypeDef:  # (1)
    ...

1. See GetCampaignDateRangeKpiResponseTypeDef

# get_campaign_date_range_kpi method usage example with argument unpacking

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

parent.get_campaign_date_range_kpi(**kwargs)

1. See GetCampaignDateRangeKpiRequestTypeDef

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: GetCampaignVersionRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "CampaignId": ...,
    "Version": ...,
}

parent.get_campaign_version(**kwargs)

1. See GetCampaignVersionRequestTypeDef

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: GetCampaignVersionsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "CampaignId": ...,
}

parent.get_campaign_versions(**kwargs)

1. See GetCampaignVersionsRequestTypeDef

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: GetCampaignsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_campaigns(**kwargs)

1. See GetCampaignsRequestTypeDef

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: GetChannelsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_channels(**kwargs)

1. See GetChannelsRequestTypeDef

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: GetEmailChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_email_channel(**kwargs)

1. See GetEmailChannelRequestTypeDef

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: GetEmailTemplateRequestTypeDef = {  # (1)
    "TemplateName": ...,
}

parent.get_email_template(**kwargs)

1. See GetEmailTemplateRequestTypeDef

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: GetEndpointRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "EndpointId": ...,
}

parent.get_endpoint(**kwargs)

1. See GetEndpointRequestTypeDef

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: GetEventStreamRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_event_stream(**kwargs)

1. See GetEventStreamRequestTypeDef

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: GetExportJobRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "JobId": ...,
}

parent.get_export_job(**kwargs)

1. See GetExportJobRequestTypeDef

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: GetExportJobsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_export_jobs(**kwargs)

1. See GetExportJobsRequestTypeDef

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: GetGcmChannelRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_gcm_channel(**kwargs)

1. See GetGcmChannelRequestTypeDef

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: GetImportJobRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "JobId": ...,
}

parent.get_import_job(**kwargs)

1. See GetImportJobRequestTypeDef

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. boto3 documentation

# get_import_jobs method definition

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

1. See GetImportJobsResponseTypeDef

# get_import_jobs method usage example with argument unpacking

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

parent.get_import_jobs(**kwargs)

1. See GetImportJobsRequestTypeDef

get_in_app_messages

Retrieves the in-app messages targeted for the provided endpoint ID.

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

# get_in_app_messages method definition

def get_in_app_messages(
    self,
    *,
    ApplicationId: str,
    EndpointId: str,
) -> GetInAppMessagesResponseTypeDef:  # (1)
    ...

1. See GetInAppMessagesResponseTypeDef

# get_in_app_messages method usage example with argument unpacking

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

parent.get_in_app_messages(**kwargs)

1. See GetInAppMessagesRequestTypeDef

get_in_app_template

Retrieves the content and settings of a message template for messages sent through the in-app channel.

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

# get_in_app_template method definition

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

1. See GetInAppTemplateResponseTypeDef

# get_in_app_template method usage example with argument unpacking

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

parent.get_in_app_template(**kwargs)

1. See GetInAppTemplateRequestTypeDef

get_journey

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

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

# get_journey method definition

def get_journey(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
) -> GetJourneyResponseTypeDef:  # (1)
    ...

1. See GetJourneyResponseTypeDef

# get_journey method usage example with argument unpacking

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

parent.get_journey(**kwargs)

1. See GetJourneyRequestTypeDef

get_journey_date_range_kpi

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

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

# get_journey_date_range_kpi method definition

def get_journey_date_range_kpi(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
    KpiName: str,
    EndTime: TimestampTypeDef = ...,
    NextToken: str = ...,
    PageSize: str = ...,
    StartTime: TimestampTypeDef = ...,
) -> GetJourneyDateRangeKpiResponseTypeDef:  # (1)
    ...

1. See GetJourneyDateRangeKpiResponseTypeDef

# get_journey_date_range_kpi method usage example with argument unpacking

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

parent.get_journey_date_range_kpi(**kwargs)

1. See GetJourneyDateRangeKpiRequestTypeDef

get_journey_execution_activity_metrics

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

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

# get_journey_execution_activity_metrics method definition

def get_journey_execution_activity_metrics(
    self,
    *,
    ApplicationId: str,
    JourneyActivityId: str,
    JourneyId: str,
    NextToken: str = ...,
    PageSize: str = ...,
) -> GetJourneyExecutionActivityMetricsResponseTypeDef:  # (1)
    ...

1. See GetJourneyExecutionActivityMetricsResponseTypeDef

# get_journey_execution_activity_metrics method usage example with argument unpacking

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

parent.get_journey_execution_activity_metrics(**kwargs)

1. See GetJourneyExecutionActivityMetricsRequestTypeDef

get_journey_execution_metrics

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

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

# get_journey_execution_metrics method definition

def get_journey_execution_metrics(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
    NextToken: str = ...,
    PageSize: str = ...,
) -> GetJourneyExecutionMetricsResponseTypeDef:  # (1)
    ...

1. See GetJourneyExecutionMetricsResponseTypeDef

# get_journey_execution_metrics method usage example with argument unpacking

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

parent.get_journey_execution_metrics(**kwargs)

1. See GetJourneyExecutionMetricsRequestTypeDef

get_journey_run_execution_activity_metrics

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.

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

# get_journey_run_execution_activity_metrics method definition

def get_journey_run_execution_activity_metrics(
    self,
    *,
    ApplicationId: str,
    JourneyActivityId: str,
    JourneyId: str,
    RunId: str,
    NextToken: str = ...,
    PageSize: str = ...,
) -> GetJourneyRunExecutionActivityMetricsResponseTypeDef:  # (1)
    ...

1. See GetJourneyRunExecutionActivityMetricsResponseTypeDef

# get_journey_run_execution_activity_metrics method usage example with argument unpacking

kwargs: GetJourneyRunExecutionActivityMetricsRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "JourneyActivityId": ...,
    "JourneyId": ...,
    "RunId": ...,
}

parent.get_journey_run_execution_activity_metrics(**kwargs)

1. See GetJourneyRunExecutionActivityMetricsRequestTypeDef

get_journey_run_execution_metrics

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

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

# get_journey_run_execution_metrics method definition

def get_journey_run_execution_metrics(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
    RunId: str,
    NextToken: str = ...,
    PageSize: str = ...,
) -> GetJourneyRunExecutionMetricsResponseTypeDef:  # (1)
    ...

1. See GetJourneyRunExecutionMetricsResponseTypeDef

# get_journey_run_execution_metrics method usage example with argument unpacking

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

parent.get_journey_run_execution_metrics(**kwargs)

1. See GetJourneyRunExecutionMetricsRequestTypeDef

get_journey_runs

Provides information about the runs of a journey.

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

# get_journey_runs method definition

def get_journey_runs(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetJourneyRunsResponseTypeDef:  # (1)
    ...

1. See GetJourneyRunsResponseTypeDef

# get_journey_runs method usage example with argument unpacking

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

parent.get_journey_runs(**kwargs)

1. See GetJourneyRunsRequestTypeDef

get_push_template

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

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

# get_push_template method definition

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

1. See GetPushTemplateResponseTypeDef

# get_push_template method usage example with argument unpacking

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

parent.get_push_template(**kwargs)

1. See GetPushTemplateRequestTypeDef

get_recommender_configuration

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

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

# get_recommender_configuration method definition

def get_recommender_configuration(
    self,
    *,
    RecommenderId: str,
) -> GetRecommenderConfigurationResponseTypeDef:  # (1)
    ...

1. See GetRecommenderConfigurationResponseTypeDef

# get_recommender_configuration method usage example with argument unpacking

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

parent.get_recommender_configuration(**kwargs)

1. See GetRecommenderConfigurationRequestTypeDef

get_recommender_configurations

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

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

# get_recommender_configurations method definition

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

1. See GetRecommenderConfigurationsResponseTypeDef

# get_recommender_configurations method usage example with argument unpacking

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

parent.get_recommender_configurations(**kwargs)

1. See GetRecommenderConfigurationsRequestTypeDef

get_segment

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

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

# get_segment method definition

def get_segment(
    self,
    *,
    ApplicationId: str,
    SegmentId: str,
) -> GetSegmentResponseTypeDef:  # (1)
    ...

1. See GetSegmentResponseTypeDef

# get_segment method usage example with argument unpacking

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

parent.get_segment(**kwargs)

1. See GetSegmentRequestTypeDef

get_segment_export_jobs

Retrieves information about the status and settings of the export jobs for a segment.

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

# get_segment_export_jobs method definition

def get_segment_export_jobs(
    self,
    *,
    ApplicationId: str,
    SegmentId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetSegmentExportJobsResponseTypeDef:  # (1)
    ...

1. See GetSegmentExportJobsResponseTypeDef

# get_segment_export_jobs method usage example with argument unpacking

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

parent.get_segment_export_jobs(**kwargs)

1. See GetSegmentExportJobsRequestTypeDef

get_segment_import_jobs

Retrieves information about the status and settings of the import jobs for a segment.

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

# get_segment_import_jobs method definition

def get_segment_import_jobs(
    self,
    *,
    ApplicationId: str,
    SegmentId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetSegmentImportJobsResponseTypeDef:  # (1)
    ...

1. See GetSegmentImportJobsResponseTypeDef

# get_segment_import_jobs method usage example with argument unpacking

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

parent.get_segment_import_jobs(**kwargs)

1. See GetSegmentImportJobsRequestTypeDef

get_segment_version

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

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

# get_segment_version method definition

def get_segment_version(
    self,
    *,
    ApplicationId: str,
    SegmentId: str,
    Version: str,
) -> GetSegmentVersionResponseTypeDef:  # (1)
    ...

1. See GetSegmentVersionResponseTypeDef

# get_segment_version method usage example with argument unpacking

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

parent.get_segment_version(**kwargs)

1. See GetSegmentVersionRequestTypeDef

get_segment_versions

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

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

# get_segment_versions method definition

def get_segment_versions(
    self,
    *,
    ApplicationId: str,
    SegmentId: str,
    PageSize: str = ...,
    Token: str = ...,
) -> GetSegmentVersionsResponseTypeDef:  # (1)
    ...

1. See GetSegmentVersionsResponseTypeDef

# get_segment_versions method usage example with argument unpacking

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

parent.get_segment_versions(**kwargs)

1. See GetSegmentVersionsRequestTypeDef

get_segments

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

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

# get_segments method definition

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

1. See GetSegmentsResponseTypeDef

# get_segments method usage example with argument unpacking

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

parent.get_segments(**kwargs)

1. See GetSegmentsRequestTypeDef

get_sms_channel

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

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

# get_sms_channel method definition

def get_sms_channel(
    self,
    *,
    ApplicationId: str,
) -> GetSmsChannelResponseTypeDef:  # (1)
    ...

1. See GetSmsChannelResponseTypeDef

# get_sms_channel method usage example with argument unpacking

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

parent.get_sms_channel(**kwargs)

1. See GetSmsChannelRequestTypeDef

get_sms_template

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

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

# get_sms_template method definition

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

1. See GetSmsTemplateResponseTypeDef

# get_sms_template method usage example with argument unpacking

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

parent.get_sms_template(**kwargs)

1. See GetSmsTemplateRequestTypeDef

get_user_endpoints

Retrieves information about all the endpoints that are associated with a specific user ID.

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

# get_user_endpoints method definition

def get_user_endpoints(
    self,
    *,
    ApplicationId: str,
    UserId: str,
) -> GetUserEndpointsResponseTypeDef:  # (1)
    ...

1. See GetUserEndpointsResponseTypeDef

# get_user_endpoints method usage example with argument unpacking

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

parent.get_user_endpoints(**kwargs)

1. See GetUserEndpointsRequestTypeDef

get_voice_channel

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

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

# get_voice_channel method definition

def get_voice_channel(
    self,
    *,
    ApplicationId: str,
) -> GetVoiceChannelResponseTypeDef:  # (1)
    ...

1. See GetVoiceChannelResponseTypeDef

# get_voice_channel method usage example with argument unpacking

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

parent.get_voice_channel(**kwargs)

1. See GetVoiceChannelRequestTypeDef

get_voice_template

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

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

# get_voice_template method definition

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

1. See GetVoiceTemplateResponseTypeDef

# get_voice_template method usage example with argument unpacking

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

parent.get_voice_template(**kwargs)

1. See GetVoiceTemplateRequestTypeDef

list_journeys

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

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

# list_journeys method definition

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

1. See ListJourneysResponseTypeDef

# list_journeys method usage example with argument unpacking

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

parent.list_journeys(**kwargs)

1. See ListJourneysRequestTypeDef

list_tags_for_resource

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_template_versions

Retrieves information about all the versions of a specific message template.

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

# list_template_versions method definition

def list_template_versions(
    self,
    *,
    TemplateName: str,
    TemplateType: str,
    NextToken: str = ...,
    PageSize: str = ...,
) -> ListTemplateVersionsResponseTypeDef:  # (1)
    ...

1. See ListTemplateVersionsResponseTypeDef

# list_template_versions method usage example with argument unpacking

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

parent.list_template_versions(**kwargs)

1. See ListTemplateVersionsRequestTypeDef

list_templates

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

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

# list_templates method definition

def list_templates(
    self,
    *,
    NextToken: str = ...,
    PageSize: str = ...,
    Prefix: str = ...,
    TemplateType: str = ...,
) -> ListTemplatesResponseTypeDef:  # (1)
    ...

1. See ListTemplatesResponseTypeDef

# list_templates method usage example with argument unpacking

kwargs: ListTemplatesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_templates(**kwargs)

1. See ListTemplatesRequestTypeDef

phone_number_validate

Retrieves information about a phone number.

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

# phone_number_validate method definition

def phone_number_validate(
    self,
    *,
    NumberValidateRequest: NumberValidateRequestTypeDef,  # (1)
) -> PhoneNumberValidateResponseTypeDef:  # (2)
    ...

1. See NumberValidateRequestTypeDef
2. See PhoneNumberValidateResponseTypeDef

# phone_number_validate method usage example with argument unpacking

kwargs: PhoneNumberValidateRequestTypeDef = {  # (1)
    "NumberValidateRequest": ...,
}

parent.phone_number_validate(**kwargs)

1. See PhoneNumberValidateRequestTypeDef

put_event_stream

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

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

# put_event_stream method definition

def put_event_stream(
    self,
    *,
    ApplicationId: str,
    WriteEventStream: WriteEventStreamTypeDef,  # (1)
) -> PutEventStreamResponseTypeDef:  # (2)
    ...

1. See WriteEventStreamTypeDef
2. See PutEventStreamResponseTypeDef

# put_event_stream method usage example with argument unpacking

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

parent.put_event_stream(**kwargs)

1. See PutEventStreamRequestTypeDef

put_events

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

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

# put_events method definition

def put_events(
    self,
    *,
    ApplicationId: str,
    EventsRequest: EventsRequestTypeDef,  # (1)
) -> PutEventsResponseTypeDef:  # (2)
    ...

1. See EventsRequestTypeDef
2. See PutEventsResponseTypeDef

# put_events method usage example with argument unpacking

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

parent.put_events(**kwargs)

1. See PutEventsRequestTypeDef

remove_attributes

Removes one or more custom attributes, of the same attribute type, from the application.

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

# remove_attributes method definition

def remove_attributes(
    self,
    *,
    ApplicationId: str,
    AttributeType: str,
    UpdateAttributesRequest: UpdateAttributesRequestTypeDef,  # (1)
) -> RemoveAttributesResponseTypeDef:  # (2)
    ...

1. See UpdateAttributesRequestTypeDef
2. See RemoveAttributesResponseTypeDef

# remove_attributes method usage example with argument unpacking

kwargs: RemoveAttributesRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "AttributeType": ...,
    "UpdateAttributesRequest": ...,
}

parent.remove_attributes(**kwargs)

1. See RemoveAttributesRequestTypeDef

send_messages

Creates and sends a direct message.

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

# send_messages method definition

def send_messages(
    self,
    *,
    ApplicationId: str,
    MessageRequest: MessageRequestTypeDef,  # (1)
) -> SendMessagesResponseTypeDef:  # (2)
    ...

1. See MessageRequestTypeDef
2. See SendMessagesResponseTypeDef

# send_messages method usage example with argument unpacking

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

parent.send_messages(**kwargs)

1. See SendMessagesRequestTypeDef

send_otp_message

Send an OTP message.

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

# send_otp_message method definition

def send_otp_message(
    self,
    *,
    ApplicationId: str,
    SendOTPMessageRequestParameters: SendOTPMessageRequestParametersTypeDef,  # (1)
) -> SendOTPMessageResponseTypeDef:  # (2)
    ...

1. See SendOTPMessageRequestParametersTypeDef
2. See SendOTPMessageResponseTypeDef

# send_otp_message method usage example with argument unpacking

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

parent.send_otp_message(**kwargs)

1. See SendOTPMessageRequestTypeDef

send_users_messages

Creates and sends a message to a list of users.

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

# send_users_messages method definition

def send_users_messages(
    self,
    *,
    ApplicationId: str,
    SendUsersMessageRequest: SendUsersMessageRequestTypeDef,  # (1)
) -> SendUsersMessagesResponseTypeDef:  # (2)
    ...

1. See SendUsersMessageRequestTypeDef
2. See SendUsersMessagesResponseTypeDef

# send_users_messages method usage example with argument unpacking

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

parent.send_users_messages(**kwargs)

1. See SendUsersMessagesRequestTypeDef

tag_resource

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    TagsModel: TagsModelUnionTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See TagsModelTypeDef TagsModelOutputTypeDef
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagsModel": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_adm_channel

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

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

# update_adm_channel method definition

def update_adm_channel(
    self,
    *,
    ADMChannelRequest: ADMChannelRequestTypeDef,  # (1)
    ApplicationId: str,
) -> UpdateAdmChannelResponseTypeDef:  # (2)
    ...

1. See ADMChannelRequestTypeDef
2. See UpdateAdmChannelResponseTypeDef

# update_adm_channel method usage example with argument unpacking

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

parent.update_adm_channel(**kwargs)

1. See UpdateAdmChannelRequestTypeDef

update_apns_channel

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

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

# update_apns_channel method definition

def update_apns_channel(
    self,
    *,
    APNSChannelRequest: APNSChannelRequestTypeDef,  # (1)
    ApplicationId: str,
) -> UpdateApnsChannelResponseTypeDef:  # (2)
    ...

1. See APNSChannelRequestTypeDef
2. See UpdateApnsChannelResponseTypeDef

# update_apns_channel method usage example with argument unpacking

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

parent.update_apns_channel(**kwargs)

1. See UpdateApnsChannelRequestTypeDef

update_apns_sandbox_channel

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

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

# update_apns_sandbox_channel method definition

def update_apns_sandbox_channel(
    self,
    *,
    APNSSandboxChannelRequest: APNSSandboxChannelRequestTypeDef,  # (1)
    ApplicationId: str,
) -> UpdateApnsSandboxChannelResponseTypeDef:  # (2)
    ...

1. See APNSSandboxChannelRequestTypeDef
2. See UpdateApnsSandboxChannelResponseTypeDef

# update_apns_sandbox_channel method usage example with argument unpacking

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

parent.update_apns_sandbox_channel(**kwargs)

1. See UpdateApnsSandboxChannelRequestTypeDef

update_apns_voip_channel

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

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

# update_apns_voip_channel method definition

def update_apns_voip_channel(
    self,
    *,
    APNSVoipChannelRequest: APNSVoipChannelRequestTypeDef,  # (1)
    ApplicationId: str,
) -> UpdateApnsVoipChannelResponseTypeDef:  # (2)
    ...

1. See APNSVoipChannelRequestTypeDef
2. See UpdateApnsVoipChannelResponseTypeDef

# update_apns_voip_channel method usage example with argument unpacking

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

parent.update_apns_voip_channel(**kwargs)

1. See UpdateApnsVoipChannelRequestTypeDef

update_apns_voip_sandbox_channel

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

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

# update_apns_voip_sandbox_channel method definition

def update_apns_voip_sandbox_channel(
    self,
    *,
    APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequestTypeDef,  # (1)
    ApplicationId: str,
) -> UpdateApnsVoipSandboxChannelResponseTypeDef:  # (2)
    ...

1. See APNSVoipSandboxChannelRequestTypeDef
2. See UpdateApnsVoipSandboxChannelResponseTypeDef

# update_apns_voip_sandbox_channel method usage example with argument unpacking

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

parent.update_apns_voip_sandbox_channel(**kwargs)

1. See UpdateApnsVoipSandboxChannelRequestTypeDef

update_application_settings

Updates the settings for an application.

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

# update_application_settings method definition

def update_application_settings(
    self,
    *,
    ApplicationId: str,
    WriteApplicationSettingsRequest: WriteApplicationSettingsRequestTypeDef,  # (1)
) -> UpdateApplicationSettingsResponseTypeDef:  # (2)
    ...

1. See WriteApplicationSettingsRequestTypeDef
2. See UpdateApplicationSettingsResponseTypeDef

# update_application_settings method usage example with argument unpacking

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

parent.update_application_settings(**kwargs)

1. See UpdateApplicationSettingsRequestTypeDef

update_baidu_channel

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

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

# update_baidu_channel method definition

def update_baidu_channel(
    self,
    *,
    ApplicationId: str,
    BaiduChannelRequest: BaiduChannelRequestTypeDef,  # (1)
) -> UpdateBaiduChannelResponseTypeDef:  # (2)
    ...

1. See BaiduChannelRequestTypeDef
2. See UpdateBaiduChannelResponseTypeDef

# update_baidu_channel method usage example with argument unpacking

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

parent.update_baidu_channel(**kwargs)

1. See UpdateBaiduChannelRequestTypeDef

update_campaign

Updates the configuration and other settings for a campaign.

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

# update_campaign method definition

def update_campaign(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
    WriteCampaignRequest: WriteCampaignRequestTypeDef,  # (1)
) -> UpdateCampaignResponseTypeDef:  # (2)
    ...

1. See WriteCampaignRequestTypeDef
2. See UpdateCampaignResponseTypeDef

# update_campaign method usage example with argument unpacking

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

parent.update_campaign(**kwargs)

1. See UpdateCampaignRequestTypeDef

update_email_channel

Enables the email channel for an application or updates the status and settings of the email channel for an application.

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

# update_email_channel method definition

def update_email_channel(
    self,
    *,
    ApplicationId: str,
    EmailChannelRequest: EmailChannelRequestTypeDef,  # (1)
) -> UpdateEmailChannelResponseTypeDef:  # (2)
    ...

1. See EmailChannelRequestTypeDef
2. See UpdateEmailChannelResponseTypeDef

# update_email_channel method usage example with argument unpacking

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

parent.update_email_channel(**kwargs)

1. See UpdateEmailChannelRequestTypeDef

update_email_template

Updates an existing message template for messages that are sent through the email channel.

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

# update_email_template method definition

def update_email_template(
    self,
    *,
    EmailTemplateRequest: EmailTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: bool = ...,
    Version: str = ...,
) -> UpdateEmailTemplateResponseTypeDef:  # (2)
    ...

1. See EmailTemplateRequestTypeDef
2. See UpdateEmailTemplateResponseTypeDef

# update_email_template method usage example with argument unpacking

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

parent.update_email_template(**kwargs)

1. See UpdateEmailTemplateRequestTypeDef

update_endpoint

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application.

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

# update_endpoint method definition

def update_endpoint(
    self,
    *,
    ApplicationId: str,
    EndpointId: str,
    EndpointRequest: EndpointRequestTypeDef,  # (1)
) -> UpdateEndpointResponseTypeDef:  # (2)
    ...

1. See EndpointRequestTypeDef
2. See UpdateEndpointResponseTypeDef

# update_endpoint method usage example with argument unpacking

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

parent.update_endpoint(**kwargs)

1. See UpdateEndpointRequestTypeDef

update_endpoints_batch

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application.

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

# update_endpoints_batch method definition

def update_endpoints_batch(
    self,
    *,
    ApplicationId: str,
    EndpointBatchRequest: EndpointBatchRequestTypeDef,  # (1)
) -> UpdateEndpointsBatchResponseTypeDef:  # (2)
    ...

1. See EndpointBatchRequestTypeDef
2. See UpdateEndpointsBatchResponseTypeDef

# update_endpoints_batch method usage example with argument unpacking

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

parent.update_endpoints_batch(**kwargs)

1. See UpdateEndpointsBatchRequestTypeDef

update_gcm_channel

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

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

# update_gcm_channel method definition

def update_gcm_channel(
    self,
    *,
    ApplicationId: str,
    GCMChannelRequest: GCMChannelRequestTypeDef,  # (1)
) -> UpdateGcmChannelResponseTypeDef:  # (2)
    ...

1. See GCMChannelRequestTypeDef
2. See UpdateGcmChannelResponseTypeDef

# update_gcm_channel method usage example with argument unpacking

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

parent.update_gcm_channel(**kwargs)

1. See UpdateGcmChannelRequestTypeDef

update_in_app_template

Updates an existing message template for messages sent through the in-app message channel.

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

# update_in_app_template method definition

def update_in_app_template(
    self,
    *,
    InAppTemplateRequest: InAppTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: bool = ...,
    Version: str = ...,
) -> UpdateInAppTemplateResponseTypeDef:  # (2)
    ...

1. See InAppTemplateRequestTypeDef
2. See UpdateInAppTemplateResponseTypeDef

# update_in_app_template method usage example with argument unpacking

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

parent.update_in_app_template(**kwargs)

1. See UpdateInAppTemplateRequestTypeDef

update_journey

Updates the configuration and other settings for a journey.

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

# update_journey method definition

def update_journey(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
    WriteJourneyRequest: WriteJourneyRequestTypeDef,  # (1)
) -> UpdateJourneyResponseTypeDef:  # (2)
    ...

1. See WriteJourneyRequestTypeDef
2. See UpdateJourneyResponseTypeDef

# update_journey method usage example with argument unpacking

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

parent.update_journey(**kwargs)

1. See UpdateJourneyRequestTypeDef

update_journey_state

Cancels (stops) an active journey.

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

# update_journey_state method definition

def update_journey_state(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
    JourneyStateRequest: JourneyStateRequestTypeDef,  # (1)
) -> UpdateJourneyStateResponseTypeDef:  # (2)
    ...

1. See JourneyStateRequestTypeDef
2. See UpdateJourneyStateResponseTypeDef

# update_journey_state method usage example with argument unpacking

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

parent.update_journey_state(**kwargs)

1. See UpdateJourneyStateRequestTypeDef

update_push_template

Updates an existing message template for messages that are sent through a push notification channel.

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

# update_push_template method definition

def update_push_template(
    self,
    *,
    PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: bool = ...,
    Version: str = ...,
) -> UpdatePushTemplateResponseTypeDef:  # (2)
    ...

1. See PushNotificationTemplateRequestTypeDef
2. See UpdatePushTemplateResponseTypeDef

# update_push_template method usage example with argument unpacking

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

parent.update_push_template(**kwargs)

1. See UpdatePushTemplateRequestTypeDef

update_recommender_configuration

Updates an Amazon Pinpoint configuration for a recommender model.

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

# update_recommender_configuration method definition

def update_recommender_configuration(
    self,
    *,
    RecommenderId: str,
    UpdateRecommenderConfiguration: UpdateRecommenderConfigurationTypeDef,  # (1)
) -> UpdateRecommenderConfigurationResponseTypeDef:  # (2)
    ...

1. See UpdateRecommenderConfigurationTypeDef
2. See UpdateRecommenderConfigurationResponseTypeDef

# update_recommender_configuration method usage example with argument unpacking

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

parent.update_recommender_configuration(**kwargs)

1. See UpdateRecommenderConfigurationRequestTypeDef

update_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").update_segment method. boto3 documentation

# update_segment method definition

def update_segment(
    self,
    *,
    ApplicationId: str,
    SegmentId: str,
    WriteSegmentRequest: WriteSegmentRequestTypeDef,  # (1)
) -> UpdateSegmentResponseTypeDef:  # (2)
    ...

1. See WriteSegmentRequestTypeDef
2. See UpdateSegmentResponseTypeDef

# update_segment method usage example with argument unpacking

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

parent.update_segment(**kwargs)

1. See UpdateSegmentRequestTypeDef

update_sms_channel

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

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

# update_sms_channel method definition

def update_sms_channel(
    self,
    *,
    ApplicationId: str,
    SMSChannelRequest: SMSChannelRequestTypeDef,  # (1)
) -> UpdateSmsChannelResponseTypeDef:  # (2)
    ...

1. See SMSChannelRequestTypeDef
2. See UpdateSmsChannelResponseTypeDef

# update_sms_channel method usage example with argument unpacking

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

parent.update_sms_channel(**kwargs)

1. See UpdateSmsChannelRequestTypeDef

update_sms_template

Updates an existing message template for messages that are sent through the SMS channel.

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

# update_sms_template method definition

def update_sms_template(
    self,
    *,
    SMSTemplateRequest: SMSTemplateRequestTypeDef,  # (1)
    TemplateName: str,
    CreateNewVersion: bool = ...,
    Version: str = ...,
) -> UpdateSmsTemplateResponseTypeDef:  # (2)
    ...

1. See SMSTemplateRequestTypeDef
2. See UpdateSmsTemplateResponseTypeDef

# update_sms_template method usage example with argument unpacking

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

parent.update_sms_template(**kwargs)

1. See UpdateSmsTemplateRequestTypeDef

update_template_active_version

Changes the status of a specific version of a message template to active.

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

# update_template_active_version method definition

def update_template_active_version(
    self,
    *,
    TemplateActiveVersionRequest: TemplateActiveVersionRequestTypeDef,  # (1)
    TemplateName: str,
    TemplateType: str,
) -> UpdateTemplateActiveVersionResponseTypeDef:  # (2)
    ...

1. See TemplateActiveVersionRequestTypeDef
2. See UpdateTemplateActiveVersionResponseTypeDef

# update_template_active_version method usage example with argument unpacking

kwargs: UpdateTemplateActiveVersionRequestTypeDef = {  # (1)
    "TemplateActiveVersionRequest": ...,
    "TemplateName": ...,
    "TemplateType": ...,
}

parent.update_template_active_version(**kwargs)

1. See UpdateTemplateActiveVersionRequestTypeDef

update_voice_channel

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

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

# update_voice_channel method definition

def update_voice_channel(
    self,
    *,
    ApplicationId: str,
    VoiceChannelRequest: VoiceChannelRequestTypeDef,  # (1)
) -> UpdateVoiceChannelResponseTypeDef:  # (2)
    ...

1. See VoiceChannelRequestTypeDef
2. See UpdateVoiceChannelResponseTypeDef

# update_voice_channel method usage example with argument unpacking

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

parent.update_voice_channel(**kwargs)

1. See UpdateVoiceChannelRequestTypeDef

update_voice_template

Updates an existing message template for messages that are sent through the voice channel.

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

# update_voice_template method definition

def update_voice_template(
    self,
    *,
    TemplateName: str,
    VoiceTemplateRequest: VoiceTemplateRequestTypeDef,  # (1)
    CreateNewVersion: bool = ...,
    Version: str = ...,
) -> UpdateVoiceTemplateResponseTypeDef:  # (2)
    ...

1. See VoiceTemplateRequestTypeDef
2. See UpdateVoiceTemplateResponseTypeDef

# update_voice_template method usage example with argument unpacking

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

parent.update_voice_template(**kwargs)

1. See UpdateVoiceTemplateRequestTypeDef

verify_otp_message

Verify an OTP.

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

# verify_otp_message method definition

def verify_otp_message(
    self,
    *,
    ApplicationId: str,
    VerifyOTPMessageRequestParameters: VerifyOTPMessageRequestParametersTypeDef,  # (1)
) -> VerifyOTPMessageResponseTypeDef:  # (2)
    ...

1. See VerifyOTPMessageRequestParametersTypeDef
2. See VerifyOTPMessageResponseTypeDef

# verify_otp_message method usage example with argument unpacking

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

parent.verify_otp_message(**kwargs)

1. See VerifyOTPMessageRequestTypeDef