PinpointClient

Index > Pinpoint > PinpointClient

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

PinpointClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_pinpoint.client import PinpointClient

session = Session()
async with session.client("pinpoint") as client:
    client: PinpointClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("pinpoint").exceptions structure.

Usage example

async with session.client("pinpoint") as client:
    try:
        do_something(client)
    except (
            client.BadRequestException,
        client.ClientError,
        client.ConflictException,
        client.ForbiddenException,
        client.InternalServerErrorException,
        client.MethodNotAllowedException,
        client.NotFoundException,
        client.PayloadTooLargeException,
        client.TooManyRequestsException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("pinpoint").can_paginate method. boto3 documentation

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

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

create_app

Creates an application.

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

Method definition

await def create_app(
    self,
    *,
    CreateApplicationRequest: CreateApplicationRequestTypeDef,  # (1)
) -> CreateAppResponseTypeDef:  # (2)
    ...

1. See CreateApplicationRequestTypeDef
2. See CreateAppResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_campaign method. boto3 documentation

Method definition

await def create_campaign(
    self,
    *,
    ApplicationId: str,
    WriteCampaignRequest: WriteCampaignRequestTypeDef,  # (1)
) -> CreateCampaignResponseTypeDef:  # (2)
    ...

1. See WriteCampaignRequestTypeDef
2. See CreateCampaignResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_email_template method. boto3 documentation

Method definition

await def create_email_template(
    self,
    *,
    EmailTemplateRequest: EmailTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreateEmailTemplateResponseTypeDef:  # (2)
    ...

1. See EmailTemplateRequestTypeDef
2. See CreateEmailTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_export_job method. boto3 documentation

Method definition

await def create_export_job(
    self,
    *,
    ApplicationId: str,
    ExportJobRequest: ExportJobRequestTypeDef,  # (1)
) -> CreateExportJobResponseTypeDef:  # (2)
    ...

1. See ExportJobRequestTypeDef
2. See CreateExportJobResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_import_job method. boto3 documentation

Method definition

await def create_import_job(
    self,
    *,
    ApplicationId: str,
    ImportJobRequest: ImportJobRequestTypeDef,  # (1)
) -> CreateImportJobResponseTypeDef:  # (2)
    ...

1. See ImportJobRequestTypeDef
2. See CreateImportJobResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_in_app_template method. boto3 documentation

Method definition

await def create_in_app_template(
    self,
    *,
    InAppTemplateRequest: InAppTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreateInAppTemplateResponseTypeDef:  # (2)
    ...

1. See InAppTemplateRequestTypeDef
2. See CreateInAppTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_journey method. boto3 documentation

Method definition

await def create_journey(
    self,
    *,
    ApplicationId: str,
    WriteJourneyRequest: WriteJourneyRequestTypeDef,  # (1)
) -> CreateJourneyResponseTypeDef:  # (2)
    ...

1. See WriteJourneyRequestTypeDef
2. See CreateJourneyResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_push_template method. boto3 documentation

Method definition

await def create_push_template(
    self,
    *,
    PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreatePushTemplateResponseTypeDef:  # (2)
    ...

1. See PushNotificationTemplateRequestTypeDef
2. See CreatePushTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_recommender_configuration method. boto3 documentation

Method definition

await def create_recommender_configuration(
    self,
    *,
    CreateRecommenderConfiguration: CreateRecommenderConfigurationTypeDef,  # (1)
) -> CreateRecommenderConfigurationResponseTypeDef:  # (2)
    ...

1. See CreateRecommenderConfigurationTypeDef
2. See CreateRecommenderConfigurationResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_segment method. boto3 documentation

Method definition

await def create_segment(
    self,
    *,
    ApplicationId: str,
    WriteSegmentRequest: WriteSegmentRequestTypeDef,  # (1)
) -> CreateSegmentResponseTypeDef:  # (2)
    ...

1. See WriteSegmentRequestTypeDef
2. See CreateSegmentResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_sms_template method. boto3 documentation

Method definition

await def create_sms_template(
    self,
    *,
    SMSTemplateRequest: SMSTemplateRequestTypeDef,  # (1)
    TemplateName: str,
) -> CreateSmsTemplateResponseTypeDef:  # (2)
    ...

1. See SMSTemplateRequestTypeDef
2. See CreateSmsTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").create_voice_template method. boto3 documentation

Method definition

await def create_voice_template(
    self,
    *,
    TemplateName: str,
    VoiceTemplateRequest: VoiceTemplateRequestTypeDef,  # (1)
) -> CreateVoiceTemplateResponseTypeDef:  # (2)
    ...

1. See VoiceTemplateRequestTypeDef
2. See CreateVoiceTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_adm_channel method. boto3 documentation

Method definition

await def delete_adm_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteAdmChannelResponseTypeDef:  # (1)
    ...

1. See DeleteAdmChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_apns_channel method. boto3 documentation

Method definition

await def delete_apns_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsChannelResponseTypeDef:  # (1)
    ...

1. See DeleteApnsChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_apns_sandbox_channel method. boto3 documentation

Method definition

await def delete_apns_sandbox_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsSandboxChannelResponseTypeDef:  # (1)
    ...

1. See DeleteApnsSandboxChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_apns_voip_channel method. boto3 documentation

Method definition

await def delete_apns_voip_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsVoipChannelResponseTypeDef:  # (1)
    ...

1. See DeleteApnsVoipChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_apns_voip_sandbox_channel method. boto3 documentation

Method definition

await def delete_apns_voip_sandbox_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteApnsVoipSandboxChannelResponseTypeDef:  # (1)
    ...

1. See DeleteApnsVoipSandboxChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_app method. boto3 documentation

Method definition

await def delete_app(
    self,
    *,
    ApplicationId: str,
) -> DeleteAppResponseTypeDef:  # (1)
    ...

1. See DeleteAppResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_baidu_channel method. boto3 documentation

Method definition

await def delete_baidu_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteBaiduChannelResponseTypeDef:  # (1)
    ...

1. See DeleteBaiduChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_campaign method. boto3 documentation

Method definition

await def delete_campaign(
    self,
    *,
    ApplicationId: str,
    CampaignId: str,
) -> DeleteCampaignResponseTypeDef:  # (1)
    ...

1. See DeleteCampaignResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_email_channel method. boto3 documentation

Method definition

await def delete_email_channel(
    self,
    *,
    ApplicationId: str,
) -> DeleteEmailChannelResponseTypeDef:  # (1)
    ...

1. See DeleteEmailChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_email_template method. boto3 documentation

Method definition

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

1. See DeleteEmailTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_endpoint method. boto3 documentation

Method definition

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

1. See DeleteEndpointResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_event_stream method. boto3 documentation

Method definition

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

1. See DeleteEventStreamResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_gcm_channel method. boto3 documentation

Method definition

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

1. See DeleteGcmChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_in_app_template method. boto3 documentation

Method definition

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

1. See DeleteInAppTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_journey method. boto3 documentation

Method definition

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

1. See DeleteJourneyResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_push_template method. boto3 documentation

Method definition

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

1. See DeletePushTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_recommender_configuration method. boto3 documentation

Method definition

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

1. See DeleteRecommenderConfigurationResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_segment method. boto3 documentation

Method definition

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

1. See DeleteSegmentResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_sms_channel method. boto3 documentation

Method definition

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

1. See DeleteSmsChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_sms_template method. boto3 documentation

Method definition

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

1. See DeleteSmsTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_user_endpoints method. boto3 documentation

Method definition

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

1. See DeleteUserEndpointsResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_voice_channel method. boto3 documentation

Method definition

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

1. See DeleteVoiceChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").delete_voice_template method. boto3 documentation

Method definition

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

1. See DeleteVoiceTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("pinpoint").get_adm_channel method. boto3 documentation

Method definition

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

1. See GetAdmChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_apns_channel method. boto3 documentation

Method definition

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

1. See GetApnsChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_apns_sandbox_channel method. boto3 documentation

Method definition

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

1. See GetApnsSandboxChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_apns_voip_channel method. boto3 documentation

Method definition

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

1. See GetApnsVoipChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_apns_voip_sandbox_channel method. boto3 documentation

Method definition

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

1. See GetApnsVoipSandboxChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_app method. boto3 documentation

Method definition

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

1. See GetAppResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_application_date_range_kpi method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("pinpoint").get_application_settings method. boto3 documentation

Method definition

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

1. See GetApplicationSettingsResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_apps method. boto3 documentation

Method definition

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

1. See GetAppsResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_baidu_channel method. boto3 documentation

Method definition

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

1. See GetBaiduChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_campaign method. boto3 documentation

Method definition

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

1. See GetCampaignResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_campaign_activities method. boto3 documentation

Method definition

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

1. See GetCampaignActivitiesResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_campaign_date_range_kpi method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("pinpoint").get_campaign_version method. boto3 documentation

Method definition

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

1. See GetCampaignVersionResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_campaign_versions method. boto3 documentation

Method definition

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

1. See GetCampaignVersionsResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_campaigns method. boto3 documentation

Method definition

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

1. See GetCampaignsResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_channels method. boto3 documentation

Method definition

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

1. See GetChannelsResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_email_channel method. boto3 documentation

Method definition

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

1. See GetEmailChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_email_template method. boto3 documentation

Method definition

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

1. See GetEmailTemplateResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_endpoint method. boto3 documentation

Method definition

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

1. See GetEndpointResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_event_stream method. boto3 documentation

Method definition

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

1. See GetEventStreamResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_export_job method. boto3 documentation

Method definition

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

1. See GetExportJobResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_export_jobs method. boto3 documentation

Method definition

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

1. See GetExportJobsResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_gcm_channel method. boto3 documentation

Method definition

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

1. See GetGcmChannelResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_import_job method. boto3 documentation

Method definition

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

1. See GetImportJobResponseTypeDef

Usage example with kwargs

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 session.client("pinpoint").get_import_jobs method. boto3 documentation

Method definition

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

1. See GetImportJobsResponseTypeDef

Usage example with kwargs

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

parent.get_import_jobs(**kwargs)

1. See GetImportJobsRequestRequestTypeDef

get_in_app_messages

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

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

Method definition

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

1. See GetInAppMessagesResponseTypeDef

Usage example with kwargs

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

parent.get_in_app_messages(**kwargs)

1. See GetInAppMessagesRequestRequestTypeDef

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 session.client("pinpoint").get_in_app_template method. boto3 documentation

Method definition

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

1. See GetInAppTemplateResponseTypeDef

Usage example with kwargs

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

parent.get_in_app_template(**kwargs)

1. See GetInAppTemplateRequestRequestTypeDef

get_journey

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

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

Method definition

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

1. See GetJourneyResponseTypeDef

Usage example with kwargs

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

parent.get_journey(**kwargs)

1. See GetJourneyRequestRequestTypeDef

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 session.client("pinpoint").get_journey_date_range_kpi method. boto3 documentation

Method definition

await def get_journey_date_range_kpi(
    self,
    *,
    ApplicationId: str,
    JourneyId: str,
    KpiName: str,
    EndTime: Union[datetime, str] = ...,
    NextToken: str = ...,
    PageSize: str = ...,
    StartTime: Union[datetime, str] = ...,
) -> GetJourneyDateRangeKpiResponseTypeDef:  # (1)
    ...

1. See GetJourneyDateRangeKpiResponseTypeDef

Usage example with kwargs

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

parent.get_journey_date_range_kpi(**kwargs)

1. See GetJourneyDateRangeKpiRequestRequestTypeDef

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 session.client("pinpoint").get_journey_execution_activity_metrics method. boto3 documentation

Method definition

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

1. See GetJourneyExecutionActivityMetricsResponseTypeDef

Usage example with kwargs

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

parent.get_journey_execution_activity_metrics(**kwargs)

1. See GetJourneyExecutionActivityMetricsRequestRequestTypeDef

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 session.client("pinpoint").get_journey_execution_metrics method. boto3 documentation

Method definition

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

1. See GetJourneyExecutionMetricsResponseTypeDef

Usage example with kwargs

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

parent.get_journey_execution_metrics(**kwargs)

1. See GetJourneyExecutionMetricsRequestRequestTypeDef

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 session.client("pinpoint").get_push_template method. boto3 documentation

Method definition

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

1. See GetPushTemplateResponseTypeDef

Usage example with kwargs

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

parent.get_push_template(**kwargs)

1. See GetPushTemplateRequestRequestTypeDef

get_recommender_configuration

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

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

Method definition

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

1. See GetRecommenderConfigurationResponseTypeDef

Usage example with kwargs

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

parent.get_recommender_configuration(**kwargs)

1. See GetRecommenderConfigurationRequestRequestTypeDef

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 session.client("pinpoint").get_recommender_configurations method. boto3 documentation

Method definition

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

1. See GetRecommenderConfigurationsResponseTypeDef

Usage example with kwargs

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

parent.get_recommender_configurations(**kwargs)

1. See GetRecommenderConfigurationsRequestRequestTypeDef

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 session.client("pinpoint").get_segment method. boto3 documentation

Method definition

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

1. See GetSegmentResponseTypeDef

Usage example with kwargs

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

parent.get_segment(**kwargs)

1. See GetSegmentRequestRequestTypeDef

get_segment_export_jobs

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

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

Method definition

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

1. See GetSegmentExportJobsResponseTypeDef

Usage example with kwargs

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

parent.get_segment_export_jobs(**kwargs)

1. See GetSegmentExportJobsRequestRequestTypeDef

get_segment_import_jobs

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

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

Method definition

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

1. See GetSegmentImportJobsResponseTypeDef

Usage example with kwargs

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

parent.get_segment_import_jobs(**kwargs)

1. See GetSegmentImportJobsRequestRequestTypeDef

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 session.client("pinpoint").get_segment_version method. boto3 documentation

Method definition

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

1. See GetSegmentVersionResponseTypeDef

Usage example with kwargs

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

parent.get_segment_version(**kwargs)

1. See GetSegmentVersionRequestRequestTypeDef

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 session.client("pinpoint").get_segment_versions method. boto3 documentation

Method definition

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

1. See GetSegmentVersionsResponseTypeDef

Usage example with kwargs

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

parent.get_segment_versions(**kwargs)

1. See GetSegmentVersionsRequestRequestTypeDef

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 session.client("pinpoint").get_segments method. boto3 documentation

Method definition

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

1. See GetSegmentsResponseTypeDef

Usage example with kwargs

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

parent.get_segments(**kwargs)

1. See GetSegmentsRequestRequestTypeDef

get_sms_channel

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

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

Method definition

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

1. See GetSmsChannelResponseTypeDef

Usage example with kwargs

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

parent.get_sms_channel(**kwargs)

1. See GetSmsChannelRequestRequestTypeDef

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 session.client("pinpoint").get_sms_template method. boto3 documentation

Method definition

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

1. See GetSmsTemplateResponseTypeDef

Usage example with kwargs

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

parent.get_sms_template(**kwargs)

1. See GetSmsTemplateRequestRequestTypeDef

get_user_endpoints

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

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

Method definition

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

1. See GetUserEndpointsResponseTypeDef

Usage example with kwargs

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

parent.get_user_endpoints(**kwargs)

1. See GetUserEndpointsRequestRequestTypeDef

get_voice_channel

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

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

Method definition

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

1. See GetVoiceChannelResponseTypeDef

Usage example with kwargs

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

parent.get_voice_channel(**kwargs)

1. See GetVoiceChannelRequestRequestTypeDef

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 session.client("pinpoint").get_voice_template method. boto3 documentation

Method definition

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

1. See GetVoiceTemplateResponseTypeDef

Usage example with kwargs

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

parent.get_voice_template(**kwargs)

1. See GetVoiceTemplateRequestRequestTypeDef

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 session.client("pinpoint").list_journeys method. boto3 documentation

Method definition

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

1. See ListJourneysResponseTypeDef

Usage example with kwargs

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

parent.list_journeys(**kwargs)

1. See ListJourneysRequestRequestTypeDef

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 session.client("pinpoint").list_tags_for_resource method. boto3 documentation

Method definition

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

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_template_versions

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

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

Method definition

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

1. See ListTemplateVersionsResponseTypeDef

Usage example with kwargs

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

parent.list_template_versions(**kwargs)

1. See ListTemplateVersionsRequestRequestTypeDef

list_templates

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

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

Method definition

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

1. See ListTemplatesResponseTypeDef

Usage example with kwargs

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

parent.list_templates(**kwargs)

1. See ListTemplatesRequestRequestTypeDef

phone_number_validate

Retrieves information about a phone number.

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

Method definition

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

1. See NumberValidateRequestTypeDef
2. See PhoneNumberValidateResponseTypeDef

Usage example with kwargs

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

parent.phone_number_validate(**kwargs)

1. See PhoneNumberValidateRequestRequestTypeDef

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 session.client("pinpoint").put_event_stream method. boto3 documentation

Method definition

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

1. See WriteEventStreamTypeDef
2. See PutEventStreamResponseTypeDef

Usage example with kwargs

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

parent.put_event_stream(**kwargs)

1. See PutEventStreamRequestRequestTypeDef

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 session.client("pinpoint").put_events method. boto3 documentation

Method definition

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

1. See EventsRequestTypeDef
2. See PutEventsResponseTypeDef

Usage example with kwargs

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

parent.put_events(**kwargs)

1. See PutEventsRequestRequestTypeDef

remove_attributes

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

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

Method definition

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

1. See UpdateAttributesRequestTypeDef
2. See RemoveAttributesResponseTypeDef

Usage example with kwargs

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

parent.remove_attributes(**kwargs)

1. See RemoveAttributesRequestRequestTypeDef

send_messages

Creates and sends a direct message.

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

Method definition

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

1. See MessageRequestTypeDef
2. See SendMessagesResponseTypeDef

Usage example with kwargs

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

parent.send_messages(**kwargs)

1. See SendMessagesRequestRequestTypeDef

send_otp_message

Send an OTP message See also: AWS API Documentation.

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

Method definition

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

1. See SendOTPMessageRequestParametersTypeDef
2. See SendOTPMessageResponseTypeDef

Usage example with kwargs

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

parent.send_otp_message(**kwargs)

1. See SendOTPMessageRequestRequestTypeDef

send_users_messages

Creates and sends a message to a list of users.

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

Method definition

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

1. See SendUsersMessageRequestTypeDef
2. See SendUsersMessagesResponseTypeDef

Usage example with kwargs

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

parent.send_users_messages(**kwargs)

1. See SendUsersMessagesRequestRequestTypeDef

tag_resource

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

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

Method definition

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

1. See TagsModelTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

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

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

Method definition

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

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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 session.client("pinpoint").update_adm_channel method. boto3 documentation

Method definition

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

1. See ADMChannelRequestTypeDef
2. See UpdateAdmChannelResponseTypeDef

Usage example with kwargs

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

parent.update_adm_channel(**kwargs)

1. See UpdateAdmChannelRequestRequestTypeDef

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 session.client("pinpoint").update_apns_channel method. boto3 documentation

Method definition

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

1. See APNSChannelRequestTypeDef
2. See UpdateApnsChannelResponseTypeDef

Usage example with kwargs

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

parent.update_apns_channel(**kwargs)

1. See UpdateApnsChannelRequestRequestTypeDef

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 session.client("pinpoint").update_apns_sandbox_channel method. boto3 documentation

Method definition

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

1. See APNSSandboxChannelRequestTypeDef
2. See UpdateApnsSandboxChannelResponseTypeDef

Usage example with kwargs

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

parent.update_apns_sandbox_channel(**kwargs)

1. See UpdateApnsSandboxChannelRequestRequestTypeDef

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 session.client("pinpoint").update_apns_voip_channel method. boto3 documentation

Method definition

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

1. See APNSVoipChannelRequestTypeDef
2. See UpdateApnsVoipChannelResponseTypeDef

Usage example with kwargs

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

parent.update_apns_voip_channel(**kwargs)

1. See UpdateApnsVoipChannelRequestRequestTypeDef

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 session.client("pinpoint").update_apns_voip_sandbox_channel method. boto3 documentation

Method definition

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

1. See APNSVoipSandboxChannelRequestTypeDef
2. See UpdateApnsVoipSandboxChannelResponseTypeDef

Usage example with kwargs

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

parent.update_apns_voip_sandbox_channel(**kwargs)

1. See UpdateApnsVoipSandboxChannelRequestRequestTypeDef

update_application_settings

Updates the settings for an application.

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

Method definition

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

1. See WriteApplicationSettingsRequestTypeDef
2. See UpdateApplicationSettingsResponseTypeDef

Usage example with kwargs

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

parent.update_application_settings(**kwargs)

1. See UpdateApplicationSettingsRequestRequestTypeDef

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 session.client("pinpoint").update_baidu_channel method. boto3 documentation

Method definition

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

1. See BaiduChannelRequestTypeDef
2. See UpdateBaiduChannelResponseTypeDef

Usage example with kwargs

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

parent.update_baidu_channel(**kwargs)

1. See UpdateBaiduChannelRequestRequestTypeDef

update_campaign

Updates the configuration and other settings for a campaign.

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

Method definition

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

1. See WriteCampaignRequestTypeDef
2. See UpdateCampaignResponseTypeDef

Usage example with kwargs

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

parent.update_campaign(**kwargs)

1. See UpdateCampaignRequestRequestTypeDef

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 session.client("pinpoint").update_email_channel method. boto3 documentation

Method definition

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

1. See EmailChannelRequestTypeDef
2. See UpdateEmailChannelResponseTypeDef

Usage example with kwargs

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

parent.update_email_channel(**kwargs)

1. See UpdateEmailChannelRequestRequestTypeDef

update_email_template

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

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

Method definition

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

1. See EmailTemplateRequestTypeDef
2. See UpdateEmailTemplateResponseTypeDef

Usage example with kwargs

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

parent.update_email_template(**kwargs)

1. See UpdateEmailTemplateRequestRequestTypeDef

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 session.client("pinpoint").update_endpoint method. boto3 documentation

Method definition

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

1. See EndpointRequestTypeDef
2. See UpdateEndpointResponseTypeDef

Usage example with kwargs

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

parent.update_endpoint(**kwargs)

1. See UpdateEndpointRequestRequestTypeDef

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 session.client("pinpoint").update_endpoints_batch method. boto3 documentation

Method definition

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

1. See EndpointBatchRequestTypeDef
2. See UpdateEndpointsBatchResponseTypeDef

Usage example with kwargs

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

parent.update_endpoints_batch(**kwargs)

1. See UpdateEndpointsBatchRequestRequestTypeDef

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 session.client("pinpoint").update_gcm_channel method. boto3 documentation

Method definition

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

1. See GCMChannelRequestTypeDef
2. See UpdateGcmChannelResponseTypeDef

Usage example with kwargs

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

parent.update_gcm_channel(**kwargs)

1. See UpdateGcmChannelRequestRequestTypeDef

update_in_app_template

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

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

Method definition

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

1. See InAppTemplateRequestTypeDef
2. See UpdateInAppTemplateResponseTypeDef

Usage example with kwargs

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

parent.update_in_app_template(**kwargs)

1. See UpdateInAppTemplateRequestRequestTypeDef

update_journey

Updates the configuration and other settings for a journey.

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

Method definition

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

1. See WriteJourneyRequestTypeDef
2. See UpdateJourneyResponseTypeDef

Usage example with kwargs

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

parent.update_journey(**kwargs)

1. See UpdateJourneyRequestRequestTypeDef

update_journey_state

Cancels (stops) an active journey.

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

Method definition

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

1. See JourneyStateRequestTypeDef
2. See UpdateJourneyStateResponseTypeDef

Usage example with kwargs

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

parent.update_journey_state(**kwargs)

1. See UpdateJourneyStateRequestRequestTypeDef

update_push_template

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

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

Method definition

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

1. See PushNotificationTemplateRequestTypeDef
2. See UpdatePushTemplateResponseTypeDef

Usage example with kwargs

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

parent.update_push_template(**kwargs)

1. See UpdatePushTemplateRequestRequestTypeDef

update_recommender_configuration

Updates an Amazon Pinpoint configuration for a recommender model.

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

Method definition

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

1. See UpdateRecommenderConfigurationTypeDef
2. See UpdateRecommenderConfigurationResponseTypeDef

Usage example with kwargs

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

parent.update_recommender_configuration(**kwargs)

1. See UpdateRecommenderConfigurationRequestRequestTypeDef

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 session.client("pinpoint").update_segment method. boto3 documentation

Method definition

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

1. See WriteSegmentRequestTypeDef
2. See UpdateSegmentResponseTypeDef

Usage example with kwargs

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

parent.update_segment(**kwargs)

1. See UpdateSegmentRequestRequestTypeDef

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 session.client("pinpoint").update_sms_channel method. boto3 documentation

Method definition

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

1. See SMSChannelRequestTypeDef
2. See UpdateSmsChannelResponseTypeDef

Usage example with kwargs

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

parent.update_sms_channel(**kwargs)

1. See UpdateSmsChannelRequestRequestTypeDef

update_sms_template

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

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

Method definition

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

1. See SMSTemplateRequestTypeDef
2. See UpdateSmsTemplateResponseTypeDef

Usage example with kwargs

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

parent.update_sms_template(**kwargs)

1. See UpdateSmsTemplateRequestRequestTypeDef

update_template_active_version

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

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

Method definition

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

1. See TemplateActiveVersionRequestTypeDef
2. See UpdateTemplateActiveVersionResponseTypeDef

Usage example with kwargs

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

parent.update_template_active_version(**kwargs)

1. See UpdateTemplateActiveVersionRequestRequestTypeDef

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 session.client("pinpoint").update_voice_channel method. boto3 documentation

Method definition

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

1. See VoiceChannelRequestTypeDef
2. See UpdateVoiceChannelResponseTypeDef

Usage example with kwargs

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

parent.update_voice_channel(**kwargs)

1. See UpdateVoiceChannelRequestRequestTypeDef

update_voice_template

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

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

Method definition

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

1. See VoiceTemplateRequestTypeDef
2. See UpdateVoiceTemplateResponseTypeDef

Usage example with kwargs

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

parent.update_voice_template(**kwargs)

1. See UpdateVoiceTemplateRequestRequestTypeDef

verify_otp_message

Verify an OTP See also: AWS API Documentation.

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

Method definition

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

1. See VerifyOTPMessageRequestParametersTypeDef
2. See VerifyOTPMessageResponseTypeDef

Usage example with kwargs

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

parent.verify_otp_message(**kwargs)

1. See VerifyOTPMessageRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> PinpointClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...