PinpointClient#
Auto-generated documentation for Pinpoint type annotations stubs module types-aiobotocore-pinpoint.
PinpointClient#
Type annotations and code completion for session.create_client("pinpoint")
boto3 documentation
PinpointClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_pinpoint.client import PinpointClient
session = get_session()
async with session.create_client("pinpoint") as client:
client: PinpointClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("pinpoint").exceptions
structure.
PinpointClient.exceptions usage example
async with session.create_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)
PinpointClient usage 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.create_client("pinpoint").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("pinpoint").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_app#
Creates an application.
Type annotations and code completion for session.create_client("pinpoint").create_app
method.
boto3 documentation
# create_app method definition
await def create_app(
self,
*,
CreateApplicationRequest: CreateApplicationRequestTypeDef, # (1)
) -> CreateAppResponseTypeDef: # (2)
...
# create_app method usage example with argument unpacking
kwargs: CreateAppRequestRequestTypeDef = { # (1)
"CreateApplicationRequest": ...,
}
parent.create_app(**kwargs)
create_campaign#
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
Type annotations and code completion for session.create_client("pinpoint").create_campaign
method.
boto3 documentation
# create_campaign method definition
await def create_campaign(
self,
*,
ApplicationId: str,
WriteCampaignRequest: WriteCampaignRequestTypeDef, # (1)
) -> CreateCampaignResponseTypeDef: # (2)
...
# create_campaign method usage example with argument unpacking
kwargs: CreateCampaignRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteCampaignRequest": ...,
}
parent.create_campaign(**kwargs)
create_email_template#
Creates a message template for messages that are sent through the email channel.
Type annotations and code completion for session.create_client("pinpoint").create_email_template
method.
boto3 documentation
# create_email_template method definition
await def create_email_template(
self,
*,
EmailTemplateRequest: EmailTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateEmailTemplateResponseTypeDef: # (2)
...
# create_email_template method usage example with argument unpacking
kwargs: CreateEmailTemplateRequestRequestTypeDef = { # (1)
"EmailTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_email_template(**kwargs)
create_export_job#
Creates an export job for an application.
Type annotations and code completion for session.create_client("pinpoint").create_export_job
method.
boto3 documentation
# create_export_job method definition
await def create_export_job(
self,
*,
ApplicationId: str,
ExportJobRequest: ExportJobRequestTypeDef, # (1)
) -> CreateExportJobResponseTypeDef: # (2)
...
# create_export_job method usage example with argument unpacking
kwargs: CreateExportJobRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ExportJobRequest": ...,
}
parent.create_export_job(**kwargs)
create_import_job#
Creates an import job for an application.
Type annotations and code completion for session.create_client("pinpoint").create_import_job
method.
boto3 documentation
# create_import_job method definition
await def create_import_job(
self,
*,
ApplicationId: str,
ImportJobRequest: ImportJobRequestTypeDef, # (1)
) -> CreateImportJobResponseTypeDef: # (2)
...
# create_import_job method usage example with argument unpacking
kwargs: CreateImportJobRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"ImportJobRequest": ...,
}
parent.create_import_job(**kwargs)
create_in_app_template#
Creates a new message template for messages using the in-app message channel.
Type annotations and code completion for session.create_client("pinpoint").create_in_app_template
method.
boto3 documentation
# create_in_app_template method definition
await def create_in_app_template(
self,
*,
InAppTemplateRequest: InAppTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateInAppTemplateResponseTypeDef: # (2)
...
# create_in_app_template method usage example with argument unpacking
kwargs: CreateInAppTemplateRequestRequestTypeDef = { # (1)
"InAppTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_in_app_template(**kwargs)
create_journey#
Creates a journey for an application.
Type annotations and code completion for session.create_client("pinpoint").create_journey
method.
boto3 documentation
# create_journey method definition
await def create_journey(
self,
*,
ApplicationId: str,
WriteJourneyRequest: WriteJourneyRequestTypeDef, # (1)
) -> CreateJourneyResponseTypeDef: # (2)
...
# create_journey method usage example with argument unpacking
kwargs: CreateJourneyRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteJourneyRequest": ...,
}
parent.create_journey(**kwargs)
create_push_template#
Creates a message template for messages that are sent through a push notification channel.
Type annotations and code completion for session.create_client("pinpoint").create_push_template
method.
boto3 documentation
# create_push_template method definition
await def create_push_template(
self,
*,
PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreatePushTemplateResponseTypeDef: # (2)
...
# create_push_template method usage example with argument unpacking
kwargs: CreatePushTemplateRequestRequestTypeDef = { # (1)
"PushNotificationTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_push_template(**kwargs)
create_recommender_configuration#
Creates an Amazon Pinpoint configuration for a recommender model.
Type annotations and code completion for session.create_client("pinpoint").create_recommender_configuration
method.
boto3 documentation
# create_recommender_configuration method definition
await def create_recommender_configuration(
self,
*,
CreateRecommenderConfiguration: CreateRecommenderConfigurationTypeDef, # (1)
) -> CreateRecommenderConfigurationResponseTypeDef: # (2)
...
# create_recommender_configuration method usage example with argument unpacking
kwargs: CreateRecommenderConfigurationRequestRequestTypeDef = { # (1)
"CreateRecommenderConfiguration": ...,
}
parent.create_recommender_configuration(**kwargs)
create_segment#
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
Type annotations and code completion for session.create_client("pinpoint").create_segment
method.
boto3 documentation
# create_segment method definition
await def create_segment(
self,
*,
ApplicationId: str,
WriteSegmentRequest: WriteSegmentRequestTypeDef, # (1)
) -> CreateSegmentResponseTypeDef: # (2)
...
# create_segment method usage example with argument unpacking
kwargs: CreateSegmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteSegmentRequest": ...,
}
parent.create_segment(**kwargs)
create_sms_template#
Creates a message template for messages that are sent through the SMS channel.
Type annotations and code completion for session.create_client("pinpoint").create_sms_template
method.
boto3 documentation
# create_sms_template method definition
await def create_sms_template(
self,
*,
SMSTemplateRequest: SMSTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateSmsTemplateResponseTypeDef: # (2)
...
# create_sms_template method usage example with argument unpacking
kwargs: CreateSmsTemplateRequestRequestTypeDef = { # (1)
"SMSTemplateRequest": ...,
"TemplateName": ...,
}
parent.create_sms_template(**kwargs)
create_voice_template#
Creates a message template for messages that are sent through the voice channel.
Type annotations and code completion for session.create_client("pinpoint").create_voice_template
method.
boto3 documentation
# create_voice_template method definition
await def create_voice_template(
self,
*,
TemplateName: str,
VoiceTemplateRequest: VoiceTemplateRequestTypeDef, # (1)
) -> CreateVoiceTemplateResponseTypeDef: # (2)
...
# create_voice_template method usage example with argument unpacking
kwargs: CreateVoiceTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"VoiceTemplateRequest": ...,
}
parent.create_voice_template(**kwargs)
delete_adm_channel#
Disables the ADM channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_adm_channel
method.
boto3 documentation
# delete_adm_channel method definition
await def delete_adm_channel(
self,
*,
ApplicationId: str,
) -> DeleteAdmChannelResponseTypeDef: # (1)
...
# delete_adm_channel method usage example with argument unpacking
kwargs: DeleteAdmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_adm_channel(**kwargs)
delete_apns_channel#
Disables the APNs channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_apns_channel
method.
boto3 documentation
# delete_apns_channel method definition
await def delete_apns_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsChannelResponseTypeDef: # (1)
...
# delete_apns_channel method usage example with argument unpacking
kwargs: DeleteApnsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_channel(**kwargs)
delete_apns_sandbox_channel#
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_apns_sandbox_channel
method.
boto3 documentation
# delete_apns_sandbox_channel method definition
await def delete_apns_sandbox_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsSandboxChannelResponseTypeDef: # (1)
...
# delete_apns_sandbox_channel method usage example with argument unpacking
kwargs: DeleteApnsSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_sandbox_channel(**kwargs)
delete_apns_voip_channel#
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_apns_voip_channel
method.
boto3 documentation
# delete_apns_voip_channel method definition
await def delete_apns_voip_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsVoipChannelResponseTypeDef: # (1)
...
# delete_apns_voip_channel method usage example with argument unpacking
kwargs: DeleteApnsVoipChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_voip_channel(**kwargs)
delete_apns_voip_sandbox_channel#
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_apns_voip_sandbox_channel
method.
boto3 documentation
# delete_apns_voip_sandbox_channel method definition
await def delete_apns_voip_sandbox_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsVoipSandboxChannelResponseTypeDef: # (1)
...
# delete_apns_voip_sandbox_channel method usage example with argument unpacking
kwargs: DeleteApnsVoipSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_voip_sandbox_channel(**kwargs)
delete_app#
Deletes an application.
Type annotations and code completion for session.create_client("pinpoint").delete_app
method.
boto3 documentation
# delete_app method definition
await def delete_app(
self,
*,
ApplicationId: str,
) -> DeleteAppResponseTypeDef: # (1)
...
# delete_app method usage example with argument unpacking
kwargs: DeleteAppRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_app(**kwargs)
delete_baidu_channel#
Disables the Baidu channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_baidu_channel
method.
boto3 documentation
# delete_baidu_channel method definition
await def delete_baidu_channel(
self,
*,
ApplicationId: str,
) -> DeleteBaiduChannelResponseTypeDef: # (1)
...
# delete_baidu_channel method usage example with argument unpacking
kwargs: DeleteBaiduChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_baidu_channel(**kwargs)
delete_campaign#
Deletes a campaign from an application.
Type annotations and code completion for session.create_client("pinpoint").delete_campaign
method.
boto3 documentation
# delete_campaign method definition
await def delete_campaign(
self,
*,
ApplicationId: str,
CampaignId: str,
) -> DeleteCampaignResponseTypeDef: # (1)
...
# delete_campaign method usage example with argument unpacking
kwargs: DeleteCampaignRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
}
parent.delete_campaign(**kwargs)
delete_email_channel#
Disables the email channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_email_channel
method.
boto3 documentation
# delete_email_channel method definition
await def delete_email_channel(
self,
*,
ApplicationId: str,
) -> DeleteEmailChannelResponseTypeDef: # (1)
...
# delete_email_channel method usage example with argument unpacking
kwargs: DeleteEmailChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_email_channel(**kwargs)
delete_email_template#
Deletes a message template for messages that were sent through the email channel.
Type annotations and code completion for session.create_client("pinpoint").delete_email_template
method.
boto3 documentation
# delete_email_template method definition
await def delete_email_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteEmailTemplateResponseTypeDef: # (1)
...
# delete_email_template method usage example with argument unpacking
kwargs: DeleteEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_email_template(**kwargs)
delete_endpoint#
Deletes an endpoint from an application.
Type annotations and code completion for session.create_client("pinpoint").delete_endpoint
method.
boto3 documentation
# delete_endpoint method definition
await def delete_endpoint(
self,
*,
ApplicationId: str,
EndpointId: str,
) -> DeleteEndpointResponseTypeDef: # (1)
...
# delete_endpoint method usage example with argument unpacking
kwargs: DeleteEndpointRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EndpointId": ...,
}
parent.delete_endpoint(**kwargs)
delete_event_stream#
Deletes the event stream for an application.
Type annotations and code completion for session.create_client("pinpoint").delete_event_stream
method.
boto3 documentation
# delete_event_stream method definition
await def delete_event_stream(
self,
*,
ApplicationId: str,
) -> DeleteEventStreamResponseTypeDef: # (1)
...
# delete_event_stream method usage example with argument unpacking
kwargs: DeleteEventStreamRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_event_stream(**kwargs)
delete_gcm_channel#
Disables the GCM channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_gcm_channel
method.
boto3 documentation
# delete_gcm_channel method definition
await def delete_gcm_channel(
self,
*,
ApplicationId: str,
) -> DeleteGcmChannelResponseTypeDef: # (1)
...
# delete_gcm_channel method usage example with argument unpacking
kwargs: DeleteGcmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_gcm_channel(**kwargs)
delete_in_app_template#
Deletes a message template for messages sent using the in-app message channel.
Type annotations and code completion for session.create_client("pinpoint").delete_in_app_template
method.
boto3 documentation
# delete_in_app_template method definition
await def delete_in_app_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteInAppTemplateResponseTypeDef: # (1)
...
# delete_in_app_template method usage example with argument unpacking
kwargs: DeleteInAppTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_in_app_template(**kwargs)
delete_journey#
Deletes a journey from an application.
Type annotations and code completion for session.create_client("pinpoint").delete_journey
method.
boto3 documentation
# delete_journey method definition
await def delete_journey(
self,
*,
ApplicationId: str,
JourneyId: str,
) -> DeleteJourneyResponseTypeDef: # (1)
...
# delete_journey method usage example with argument unpacking
kwargs: DeleteJourneyRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
}
parent.delete_journey(**kwargs)
delete_push_template#
Deletes a message template for messages that were sent through a push notification channel.
Type annotations and code completion for session.create_client("pinpoint").delete_push_template
method.
boto3 documentation
# delete_push_template method definition
await def delete_push_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeletePushTemplateResponseTypeDef: # (1)
...
# delete_push_template method usage example with argument unpacking
kwargs: DeletePushTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_push_template(**kwargs)
delete_recommender_configuration#
Deletes an Amazon Pinpoint configuration for a recommender model.
Type annotations and code completion for session.create_client("pinpoint").delete_recommender_configuration
method.
boto3 documentation
# delete_recommender_configuration method definition
await def delete_recommender_configuration(
self,
*,
RecommenderId: str,
) -> DeleteRecommenderConfigurationResponseTypeDef: # (1)
...
# delete_recommender_configuration method usage example with argument unpacking
kwargs: DeleteRecommenderConfigurationRequestRequestTypeDef = { # (1)
"RecommenderId": ...,
}
parent.delete_recommender_configuration(**kwargs)
delete_segment#
Deletes a segment from an application.
Type annotations and code completion for session.create_client("pinpoint").delete_segment
method.
boto3 documentation
# delete_segment method definition
await def delete_segment(
self,
*,
ApplicationId: str,
SegmentId: str,
) -> DeleteSegmentResponseTypeDef: # (1)
...
# delete_segment method usage example with argument unpacking
kwargs: DeleteSegmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
}
parent.delete_segment(**kwargs)
delete_sms_channel#
Disables the SMS channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_sms_channel
method.
boto3 documentation
# delete_sms_channel method definition
await def delete_sms_channel(
self,
*,
ApplicationId: str,
) -> DeleteSmsChannelResponseTypeDef: # (1)
...
# delete_sms_channel method usage example with argument unpacking
kwargs: DeleteSmsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_sms_channel(**kwargs)
delete_sms_template#
Deletes a message template for messages that were sent through the SMS channel.
Type annotations and code completion for session.create_client("pinpoint").delete_sms_template
method.
boto3 documentation
# delete_sms_template method definition
await def delete_sms_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteSmsTemplateResponseTypeDef: # (1)
...
# delete_sms_template method usage example with argument unpacking
kwargs: DeleteSmsTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_sms_template(**kwargs)
delete_user_endpoints#
Deletes all the endpoints that are associated with a specific user ID.
Type annotations and code completion for session.create_client("pinpoint").delete_user_endpoints
method.
boto3 documentation
# delete_user_endpoints method definition
await def delete_user_endpoints(
self,
*,
ApplicationId: str,
UserId: str,
) -> DeleteUserEndpointsResponseTypeDef: # (1)
...
# delete_user_endpoints method usage example with argument unpacking
kwargs: DeleteUserEndpointsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"UserId": ...,
}
parent.delete_user_endpoints(**kwargs)
delete_voice_channel#
Disables the voice channel for an application and deletes any existing settings for the channel.
Type annotations and code completion for session.create_client("pinpoint").delete_voice_channel
method.
boto3 documentation
# delete_voice_channel method definition
await def delete_voice_channel(
self,
*,
ApplicationId: str,
) -> DeleteVoiceChannelResponseTypeDef: # (1)
...
# delete_voice_channel method usage example with argument unpacking
kwargs: DeleteVoiceChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_voice_channel(**kwargs)
delete_voice_template#
Deletes a message template for messages that were sent through the voice channel.
Type annotations and code completion for session.create_client("pinpoint").delete_voice_template
method.
boto3 documentation
# delete_voice_template method definition
await def delete_voice_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteVoiceTemplateResponseTypeDef: # (1)
...
# delete_voice_template method usage example with argument unpacking
kwargs: DeleteVoiceTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_voice_template(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("pinpoint").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url 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.create_client("pinpoint").get_adm_channel
method.
boto3 documentation
# get_adm_channel method definition
await def get_adm_channel(
self,
*,
ApplicationId: str,
) -> GetAdmChannelResponseTypeDef: # (1)
...
# get_adm_channel method usage example with argument unpacking
kwargs: GetAdmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_adm_channel(**kwargs)
get_apns_channel#
Retrieves information about the status and settings of the APNs channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_apns_channel
method.
boto3 documentation
# get_apns_channel method definition
await def get_apns_channel(
self,
*,
ApplicationId: str,
) -> GetApnsChannelResponseTypeDef: # (1)
...
# get_apns_channel method usage example with argument unpacking
kwargs: GetApnsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_channel(**kwargs)
get_apns_sandbox_channel#
Retrieves information about the status and settings of the APNs sandbox channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_apns_sandbox_channel
method.
boto3 documentation
# get_apns_sandbox_channel method definition
await def get_apns_sandbox_channel(
self,
*,
ApplicationId: str,
) -> GetApnsSandboxChannelResponseTypeDef: # (1)
...
# get_apns_sandbox_channel method usage example with argument unpacking
kwargs: GetApnsSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_sandbox_channel(**kwargs)
get_apns_voip_channel#
Retrieves information about the status and settings of the APNs VoIP channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_apns_voip_channel
method.
boto3 documentation
# get_apns_voip_channel method definition
await def get_apns_voip_channel(
self,
*,
ApplicationId: str,
) -> GetApnsVoipChannelResponseTypeDef: # (1)
...
# get_apns_voip_channel method usage example with argument unpacking
kwargs: GetApnsVoipChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_voip_channel(**kwargs)
get_apns_voip_sandbox_channel#
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_apns_voip_sandbox_channel
method.
boto3 documentation
# get_apns_voip_sandbox_channel method definition
await def get_apns_voip_sandbox_channel(
self,
*,
ApplicationId: str,
) -> GetApnsVoipSandboxChannelResponseTypeDef: # (1)
...
# get_apns_voip_sandbox_channel method usage example with argument unpacking
kwargs: GetApnsVoipSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_voip_sandbox_channel(**kwargs)
get_app#
Retrieves information about an application.
Type annotations and code completion for session.create_client("pinpoint").get_app
method.
boto3 documentation
# get_app method definition
await def get_app(
self,
*,
ApplicationId: str,
) -> GetAppResponseTypeDef: # (1)
...
# get_app method usage example with argument unpacking
kwargs: GetAppRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_app(**kwargs)
get_application_date_range_kpi#
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
Type annotations and code completion for session.create_client("pinpoint").get_application_date_range_kpi
method.
boto3 documentation
# get_application_date_range_kpi 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)
...
# get_application_date_range_kpi method usage example with argument unpacking
kwargs: GetApplicationDateRangeKpiRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"KpiName": ...,
}
parent.get_application_date_range_kpi(**kwargs)
get_application_settings#
Retrieves information about the settings for an application.
Type annotations and code completion for session.create_client("pinpoint").get_application_settings
method.
boto3 documentation
# get_application_settings method definition
await def get_application_settings(
self,
*,
ApplicationId: str,
) -> GetApplicationSettingsResponseTypeDef: # (1)
...
# get_application_settings method usage example with argument unpacking
kwargs: GetApplicationSettingsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_application_settings(**kwargs)
get_apps#
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
Type annotations and code completion for session.create_client("pinpoint").get_apps
method.
boto3 documentation
# get_apps method definition
await def get_apps(
self,
*,
PageSize: str = ...,
Token: str = ...,
) -> GetAppsResponseTypeDef: # (1)
...
# get_apps method usage example with argument unpacking
kwargs: GetAppsRequestRequestTypeDef = { # (1)
"PageSize": ...,
}
parent.get_apps(**kwargs)
get_baidu_channel#
Retrieves information about the status and settings of the Baidu channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_baidu_channel
method.
boto3 documentation
# get_baidu_channel method definition
await def get_baidu_channel(
self,
*,
ApplicationId: str,
) -> GetBaiduChannelResponseTypeDef: # (1)
...
# get_baidu_channel method usage example with argument unpacking
kwargs: GetBaiduChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_baidu_channel(**kwargs)
get_campaign#
Retrieves information about the status, configuration, and other settings for a campaign.
Type annotations and code completion for session.create_client("pinpoint").get_campaign
method.
boto3 documentation
# get_campaign method definition
await def get_campaign(
self,
*,
ApplicationId: str,
CampaignId: str,
) -> GetCampaignResponseTypeDef: # (1)
...
# get_campaign method usage example with argument unpacking
kwargs: GetCampaignRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
}
parent.get_campaign(**kwargs)
get_campaign_activities#
Retrieves information about all the activities for a campaign.
Type annotations and code completion for session.create_client("pinpoint").get_campaign_activities
method.
boto3 documentation
# get_campaign_activities method definition
await def get_campaign_activities(
self,
*,
ApplicationId: str,
CampaignId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetCampaignActivitiesResponseTypeDef: # (1)
...
# get_campaign_activities method usage example with argument unpacking
kwargs: GetCampaignActivitiesRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
}
parent.get_campaign_activities(**kwargs)
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.create_client("pinpoint").get_campaign_date_range_kpi
method.
boto3 documentation
# get_campaign_date_range_kpi 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)
...
# get_campaign_date_range_kpi method usage example with argument unpacking
kwargs: GetCampaignDateRangeKpiRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
"KpiName": ...,
}
parent.get_campaign_date_range_kpi(**kwargs)
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.create_client("pinpoint").get_campaign_version
method.
boto3 documentation
# get_campaign_version method definition
await def get_campaign_version(
self,
*,
ApplicationId: str,
CampaignId: str,
Version: str,
) -> GetCampaignVersionResponseTypeDef: # (1)
...
# get_campaign_version method usage example with argument unpacking
kwargs: GetCampaignVersionRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
"Version": ...,
}
parent.get_campaign_version(**kwargs)
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.create_client("pinpoint").get_campaign_versions
method.
boto3 documentation
# get_campaign_versions method definition
await def get_campaign_versions(
self,
*,
ApplicationId: str,
CampaignId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetCampaignVersionsResponseTypeDef: # (1)
...
# get_campaign_versions method usage example with argument unpacking
kwargs: GetCampaignVersionsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
}
parent.get_campaign_versions(**kwargs)
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.create_client("pinpoint").get_campaigns
method.
boto3 documentation
# get_campaigns method definition
await def get_campaigns(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetCampaignsResponseTypeDef: # (1)
...
# get_campaigns method usage example with argument unpacking
kwargs: GetCampaignsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_campaigns(**kwargs)
get_channels#
Retrieves information about the history and status of each channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_channels
method.
boto3 documentation
# get_channels method definition
await def get_channels(
self,
*,
ApplicationId: str,
) -> GetChannelsResponseTypeDef: # (1)
...
# get_channels method usage example with argument unpacking
kwargs: GetChannelsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_channels(**kwargs)
get_email_channel#
Retrieves information about the status and settings of the email channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_email_channel
method.
boto3 documentation
# get_email_channel method definition
await def get_email_channel(
self,
*,
ApplicationId: str,
) -> GetEmailChannelResponseTypeDef: # (1)
...
# get_email_channel method usage example with argument unpacking
kwargs: GetEmailChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_email_channel(**kwargs)
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.create_client("pinpoint").get_email_template
method.
boto3 documentation
# get_email_template method definition
await def get_email_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetEmailTemplateResponseTypeDef: # (1)
...
# get_email_template method usage example with argument unpacking
kwargs: GetEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.get_email_template(**kwargs)
get_endpoint#
Retrieves information about the settings and attributes of a specific endpoint for an application.
Type annotations and code completion for session.create_client("pinpoint").get_endpoint
method.
boto3 documentation
# get_endpoint method definition
await def get_endpoint(
self,
*,
ApplicationId: str,
EndpointId: str,
) -> GetEndpointResponseTypeDef: # (1)
...
# get_endpoint method usage example with argument unpacking
kwargs: GetEndpointRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EndpointId": ...,
}
parent.get_endpoint(**kwargs)
get_event_stream#
Retrieves information about the event stream settings for an application.
Type annotations and code completion for session.create_client("pinpoint").get_event_stream
method.
boto3 documentation
# get_event_stream method definition
await def get_event_stream(
self,
*,
ApplicationId: str,
) -> GetEventStreamResponseTypeDef: # (1)
...
# get_event_stream method usage example with argument unpacking
kwargs: GetEventStreamRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_event_stream(**kwargs)
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.create_client("pinpoint").get_export_job
method.
boto3 documentation
# get_export_job method definition
await def get_export_job(
self,
*,
ApplicationId: str,
JobId: str,
) -> GetExportJobResponseTypeDef: # (1)
...
# get_export_job method usage example with argument unpacking
kwargs: GetExportJobRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JobId": ...,
}
parent.get_export_job(**kwargs)
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.create_client("pinpoint").get_export_jobs
method.
boto3 documentation
# get_export_jobs method definition
await def get_export_jobs(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetExportJobsResponseTypeDef: # (1)
...
# get_export_jobs method usage example with argument unpacking
kwargs: GetExportJobsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_export_jobs(**kwargs)
get_gcm_channel#
Retrieves information about the status and settings of the GCM channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_gcm_channel
method.
boto3 documentation
# get_gcm_channel method definition
await def get_gcm_channel(
self,
*,
ApplicationId: str,
) -> GetGcmChannelResponseTypeDef: # (1)
...
# get_gcm_channel method usage example with argument unpacking
kwargs: GetGcmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_gcm_channel(**kwargs)
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.create_client("pinpoint").get_import_job
method.
boto3 documentation
# get_import_job method definition
await def get_import_job(
self,
*,
ApplicationId: str,
JobId: str,
) -> GetImportJobResponseTypeDef: # (1)
...
# get_import_job method usage example with argument unpacking
kwargs: GetImportJobRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JobId": ...,
}
parent.get_import_job(**kwargs)
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.create_client("pinpoint").get_import_jobs
method.
boto3 documentation
# get_import_jobs method definition
await def get_import_jobs(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetImportJobsResponseTypeDef: # (1)
...
# get_import_jobs method usage example with argument unpacking
kwargs: GetImportJobsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_import_jobs(**kwargs)
get_in_app_messages#
Retrieves the in-app messages targeted for the provided endpoint ID.
Type annotations and code completion for session.create_client("pinpoint").get_in_app_messages
method.
boto3 documentation
# get_in_app_messages method definition
await def get_in_app_messages(
self,
*,
ApplicationId: str,
EndpointId: str,
) -> GetInAppMessagesResponseTypeDef: # (1)
...
# get_in_app_messages method usage example with argument unpacking
kwargs: GetInAppMessagesRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EndpointId": ...,
}
parent.get_in_app_messages(**kwargs)
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.create_client("pinpoint").get_in_app_template
method.
boto3 documentation
# get_in_app_template method definition
await def get_in_app_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetInAppTemplateResponseTypeDef: # (1)
...
# get_in_app_template method usage example with argument unpacking
kwargs: GetInAppTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.get_in_app_template(**kwargs)
get_journey#
Retrieves information about the status, configuration, and other settings for a journey.
Type annotations and code completion for session.create_client("pinpoint").get_journey
method.
boto3 documentation
# get_journey method definition
await def get_journey(
self,
*,
ApplicationId: str,
JourneyId: str,
) -> GetJourneyResponseTypeDef: # (1)
...
# get_journey method usage example with argument unpacking
kwargs: GetJourneyRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
}
parent.get_journey(**kwargs)
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.create_client("pinpoint").get_journey_date_range_kpi
method.
boto3 documentation
# get_journey_date_range_kpi 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)
...
# get_journey_date_range_kpi method usage example with argument unpacking
kwargs: GetJourneyDateRangeKpiRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
"KpiName": ...,
}
parent.get_journey_date_range_kpi(**kwargs)
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.create_client("pinpoint").get_journey_execution_activity_metrics
method.
boto3 documentation
# get_journey_execution_activity_metrics method definition
await def get_journey_execution_activity_metrics(
self,
*,
ApplicationId: str,
JourneyActivityId: str,
JourneyId: str,
NextToken: str = ...,
PageSize: str = ...,
) -> GetJourneyExecutionActivityMetricsResponseTypeDef: # (1)
...
# get_journey_execution_activity_metrics method usage example with argument unpacking
kwargs: GetJourneyExecutionActivityMetricsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyActivityId": ...,
"JourneyId": ...,
}
parent.get_journey_execution_activity_metrics(**kwargs)
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.create_client("pinpoint").get_journey_execution_metrics
method.
boto3 documentation
# get_journey_execution_metrics method definition
await def get_journey_execution_metrics(
self,
*,
ApplicationId: str,
JourneyId: str,
NextToken: str = ...,
PageSize: str = ...,
) -> GetJourneyExecutionMetricsResponseTypeDef: # (1)
...
# get_journey_execution_metrics method usage example with argument unpacking
kwargs: GetJourneyExecutionMetricsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
}
parent.get_journey_execution_metrics(**kwargs)
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 session.create_client("pinpoint").get_journey_run_execution_activity_metrics
method.
boto3 documentation
# get_journey_run_execution_activity_metrics method definition
await def get_journey_run_execution_activity_metrics(
self,
*,
ApplicationId: str,
JourneyActivityId: str,
JourneyId: str,
RunId: str,
NextToken: str = ...,
PageSize: str = ...,
) -> GetJourneyRunExecutionActivityMetricsResponseTypeDef: # (1)
...
# get_journey_run_execution_activity_metrics method usage example with argument unpacking
kwargs: GetJourneyRunExecutionActivityMetricsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyActivityId": ...,
"JourneyId": ...,
"RunId": ...,
}
parent.get_journey_run_execution_activity_metrics(**kwargs)
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 session.create_client("pinpoint").get_journey_run_execution_metrics
method.
boto3 documentation
# get_journey_run_execution_metrics method definition
await def get_journey_run_execution_metrics(
self,
*,
ApplicationId: str,
JourneyId: str,
RunId: str,
NextToken: str = ...,
PageSize: str = ...,
) -> GetJourneyRunExecutionMetricsResponseTypeDef: # (1)
...
# get_journey_run_execution_metrics method usage example with argument unpacking
kwargs: GetJourneyRunExecutionMetricsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
"RunId": ...,
}
parent.get_journey_run_execution_metrics(**kwargs)
get_journey_runs#
Provides information about the runs of a journey.
Type annotations and code completion for session.create_client("pinpoint").get_journey_runs
method.
boto3 documentation
# get_journey_runs method definition
await def get_journey_runs(
self,
*,
ApplicationId: str,
JourneyId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetJourneyRunsResponseTypeDef: # (1)
...
# get_journey_runs method usage example with argument unpacking
kwargs: GetJourneyRunsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
}
parent.get_journey_runs(**kwargs)
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.create_client("pinpoint").get_push_template
method.
boto3 documentation
# get_push_template method definition
await def get_push_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetPushTemplateResponseTypeDef: # (1)
...
# get_push_template method usage example with argument unpacking
kwargs: GetPushTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.get_push_template(**kwargs)
get_recommender_configuration#
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
Type annotations and code completion for session.create_client("pinpoint").get_recommender_configuration
method.
boto3 documentation
# get_recommender_configuration method definition
await def get_recommender_configuration(
self,
*,
RecommenderId: str,
) -> GetRecommenderConfigurationResponseTypeDef: # (1)
...
# get_recommender_configuration method usage example with argument unpacking
kwargs: GetRecommenderConfigurationRequestRequestTypeDef = { # (1)
"RecommenderId": ...,
}
parent.get_recommender_configuration(**kwargs)
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.create_client("pinpoint").get_recommender_configurations
method.
boto3 documentation
# get_recommender_configurations method definition
await def get_recommender_configurations(
self,
*,
PageSize: str = ...,
Token: str = ...,
) -> GetRecommenderConfigurationsResponseTypeDef: # (1)
...
# get_recommender_configurations method usage example with argument unpacking
kwargs: GetRecommenderConfigurationsRequestRequestTypeDef = { # (1)
"PageSize": ...,
}
parent.get_recommender_configurations(**kwargs)
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.create_client("pinpoint").get_segment
method.
boto3 documentation
# get_segment method definition
await def get_segment(
self,
*,
ApplicationId: str,
SegmentId: str,
) -> GetSegmentResponseTypeDef: # (1)
...
# get_segment method usage example with argument unpacking
kwargs: GetSegmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
}
parent.get_segment(**kwargs)
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.create_client("pinpoint").get_segment_export_jobs
method.
boto3 documentation
# get_segment_export_jobs method definition
await def get_segment_export_jobs(
self,
*,
ApplicationId: str,
SegmentId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentExportJobsResponseTypeDef: # (1)
...
# get_segment_export_jobs method usage example with argument unpacking
kwargs: GetSegmentExportJobsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
}
parent.get_segment_export_jobs(**kwargs)
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.create_client("pinpoint").get_segment_import_jobs
method.
boto3 documentation
# get_segment_import_jobs method definition
await def get_segment_import_jobs(
self,
*,
ApplicationId: str,
SegmentId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentImportJobsResponseTypeDef: # (1)
...
# get_segment_import_jobs method usage example with argument unpacking
kwargs: GetSegmentImportJobsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
}
parent.get_segment_import_jobs(**kwargs)
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.create_client("pinpoint").get_segment_version
method.
boto3 documentation
# get_segment_version method definition
await def get_segment_version(
self,
*,
ApplicationId: str,
SegmentId: str,
Version: str,
) -> GetSegmentVersionResponseTypeDef: # (1)
...
# get_segment_version method usage example with argument unpacking
kwargs: GetSegmentVersionRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
"Version": ...,
}
parent.get_segment_version(**kwargs)
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.create_client("pinpoint").get_segment_versions
method.
boto3 documentation
# get_segment_versions method definition
await def get_segment_versions(
self,
*,
ApplicationId: str,
SegmentId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentVersionsResponseTypeDef: # (1)
...
# get_segment_versions method usage example with argument unpacking
kwargs: GetSegmentVersionsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
}
parent.get_segment_versions(**kwargs)
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.create_client("pinpoint").get_segments
method.
boto3 documentation
# get_segments method definition
await def get_segments(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentsResponseTypeDef: # (1)
...
# get_segments method usage example with argument unpacking
kwargs: GetSegmentsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_segments(**kwargs)
get_sms_channel#
Retrieves information about the status and settings of the SMS channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_sms_channel
method.
boto3 documentation
# get_sms_channel method definition
await def get_sms_channel(
self,
*,
ApplicationId: str,
) -> GetSmsChannelResponseTypeDef: # (1)
...
# get_sms_channel method usage example with argument unpacking
kwargs: GetSmsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_sms_channel(**kwargs)
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.create_client("pinpoint").get_sms_template
method.
boto3 documentation
# get_sms_template method definition
await def get_sms_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetSmsTemplateResponseTypeDef: # (1)
...
# get_sms_template method usage example with argument unpacking
kwargs: GetSmsTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.get_sms_template(**kwargs)
get_user_endpoints#
Retrieves information about all the endpoints that are associated with a specific user ID.
Type annotations and code completion for session.create_client("pinpoint").get_user_endpoints
method.
boto3 documentation
# get_user_endpoints method definition
await def get_user_endpoints(
self,
*,
ApplicationId: str,
UserId: str,
) -> GetUserEndpointsResponseTypeDef: # (1)
...
# get_user_endpoints method usage example with argument unpacking
kwargs: GetUserEndpointsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"UserId": ...,
}
parent.get_user_endpoints(**kwargs)
get_voice_channel#
Retrieves information about the status and settings of the voice channel for an application.
Type annotations and code completion for session.create_client("pinpoint").get_voice_channel
method.
boto3 documentation
# get_voice_channel method definition
await def get_voice_channel(
self,
*,
ApplicationId: str,
) -> GetVoiceChannelResponseTypeDef: # (1)
...
# get_voice_channel method usage example with argument unpacking
kwargs: GetVoiceChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_voice_channel(**kwargs)
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.create_client("pinpoint").get_voice_template
method.
boto3 documentation
# get_voice_template method definition
await def get_voice_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetVoiceTemplateResponseTypeDef: # (1)
...
# get_voice_template method usage example with argument unpacking
kwargs: GetVoiceTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.get_voice_template(**kwargs)
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.create_client("pinpoint").list_journeys
method.
boto3 documentation
# list_journeys method definition
await def list_journeys(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> ListJourneysResponseTypeDef: # (1)
...
# list_journeys method usage example with argument unpacking
kwargs: ListJourneysRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.list_journeys(**kwargs)
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.create_client("pinpoint").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_template_versions#
Retrieves information about all the versions of a specific message template.
Type annotations and code completion for session.create_client("pinpoint").list_template_versions
method.
boto3 documentation
# list_template_versions method definition
await def list_template_versions(
self,
*,
TemplateName: str,
TemplateType: str,
NextToken: str = ...,
PageSize: str = ...,
) -> ListTemplateVersionsResponseTypeDef: # (1)
...
# list_template_versions method usage example with argument unpacking
kwargs: ListTemplateVersionsRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"TemplateType": ...,
}
parent.list_template_versions(**kwargs)
list_templates#
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
Type annotations and code completion for session.create_client("pinpoint").list_templates
method.
boto3 documentation
# list_templates method definition
await def list_templates(
self,
*,
NextToken: str = ...,
PageSize: str = ...,
Prefix: str = ...,
TemplateType: str = ...,
) -> ListTemplatesResponseTypeDef: # (1)
...
# list_templates method usage example with argument unpacking
kwargs: ListTemplatesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_templates(**kwargs)
phone_number_validate#
Retrieves information about a phone number.
Type annotations and code completion for session.create_client("pinpoint").phone_number_validate
method.
boto3 documentation
# phone_number_validate method definition
await def phone_number_validate(
self,
*,
NumberValidateRequest: NumberValidateRequestTypeDef, # (1)
) -> PhoneNumberValidateResponseTypeDef: # (2)
...
# phone_number_validate method usage example with argument unpacking
kwargs: PhoneNumberValidateRequestRequestTypeDef = { # (1)
"NumberValidateRequest": ...,
}
parent.phone_number_validate(**kwargs)
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.create_client("pinpoint").put_event_stream
method.
boto3 documentation
# put_event_stream method definition
await def put_event_stream(
self,
*,
ApplicationId: str,
WriteEventStream: WriteEventStreamTypeDef, # (1)
) -> PutEventStreamResponseTypeDef: # (2)
...
# put_event_stream method usage example with argument unpacking
kwargs: PutEventStreamRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteEventStream": ...,
}
parent.put_event_stream(**kwargs)
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.create_client("pinpoint").put_events
method.
boto3 documentation
# put_events method definition
await def put_events(
self,
*,
ApplicationId: str,
EventsRequest: EventsRequestTypeDef, # (1)
) -> PutEventsResponseTypeDef: # (2)
...
# put_events method usage example with argument unpacking
kwargs: PutEventsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EventsRequest": ...,
}
parent.put_events(**kwargs)
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.create_client("pinpoint").remove_attributes
method.
boto3 documentation
# remove_attributes method definition
await def remove_attributes(
self,
*,
ApplicationId: str,
AttributeType: str,
UpdateAttributesRequest: UpdateAttributesRequestTypeDef, # (1)
) -> RemoveAttributesResponseTypeDef: # (2)
...
# remove_attributes method usage example with argument unpacking
kwargs: RemoveAttributesRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"AttributeType": ...,
"UpdateAttributesRequest": ...,
}
parent.remove_attributes(**kwargs)
send_messages#
Creates and sends a direct message.
Type annotations and code completion for session.create_client("pinpoint").send_messages
method.
boto3 documentation
# send_messages method definition
await def send_messages(
self,
*,
ApplicationId: str,
MessageRequest: MessageRequestTypeDef, # (1)
) -> SendMessagesResponseTypeDef: # (2)
...
# send_messages method usage example with argument unpacking
kwargs: SendMessagesRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"MessageRequest": ...,
}
parent.send_messages(**kwargs)
send_otp_message#
Send an OTP message See also: AWS API Documentation.
Type annotations and code completion for session.create_client("pinpoint").send_otp_message
method.
boto3 documentation
# send_otp_message method definition
await def send_otp_message(
self,
*,
ApplicationId: str,
SendOTPMessageRequestParameters: SendOTPMessageRequestParametersTypeDef, # (1)
) -> SendOTPMessageResponseTypeDef: # (2)
...
# send_otp_message method usage example with argument unpacking
kwargs: SendOTPMessageRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SendOTPMessageRequestParameters": ...,
}
parent.send_otp_message(**kwargs)
send_users_messages#
Creates and sends a message to a list of users.
Type annotations and code completion for session.create_client("pinpoint").send_users_messages
method.
boto3 documentation
# send_users_messages method definition
await def send_users_messages(
self,
*,
ApplicationId: str,
SendUsersMessageRequest: SendUsersMessageRequestTypeDef, # (1)
) -> SendUsersMessagesResponseTypeDef: # (2)
...
# send_users_messages method usage example with argument unpacking
kwargs: SendUsersMessagesRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SendUsersMessageRequest": ...,
}
parent.send_users_messages(**kwargs)
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.create_client("pinpoint").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceArn: str,
TagsModel: TagsModelTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagsModel": ...,
}
parent.tag_resource(**kwargs)
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.create_client("pinpoint").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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.create_client("pinpoint").update_adm_channel
method.
boto3 documentation
# update_adm_channel method definition
await def update_adm_channel(
self,
*,
ADMChannelRequest: ADMChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateAdmChannelResponseTypeDef: # (2)
...
# update_adm_channel method usage example with argument unpacking
kwargs: UpdateAdmChannelRequestRequestTypeDef = { # (1)
"ADMChannelRequest": ...,
"ApplicationId": ...,
}
parent.update_adm_channel(**kwargs)
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.create_client("pinpoint").update_apns_channel
method.
boto3 documentation
# update_apns_channel method definition
await def update_apns_channel(
self,
*,
APNSChannelRequest: APNSChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsChannelResponseTypeDef: # (2)
...
# update_apns_channel method usage example with argument unpacking
kwargs: UpdateApnsChannelRequestRequestTypeDef = { # (1)
"APNSChannelRequest": ...,
"ApplicationId": ...,
}
parent.update_apns_channel(**kwargs)
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.create_client("pinpoint").update_apns_sandbox_channel
method.
boto3 documentation
# update_apns_sandbox_channel method definition
await def update_apns_sandbox_channel(
self,
*,
APNSSandboxChannelRequest: APNSSandboxChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsSandboxChannelResponseTypeDef: # (2)
...
# update_apns_sandbox_channel method usage example with argument unpacking
kwargs: UpdateApnsSandboxChannelRequestRequestTypeDef = { # (1)
"APNSSandboxChannelRequest": ...,
"ApplicationId": ...,
}
parent.update_apns_sandbox_channel(**kwargs)
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.create_client("pinpoint").update_apns_voip_channel
method.
boto3 documentation
# update_apns_voip_channel method definition
await def update_apns_voip_channel(
self,
*,
APNSVoipChannelRequest: APNSVoipChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsVoipChannelResponseTypeDef: # (2)
...
# update_apns_voip_channel method usage example with argument unpacking
kwargs: UpdateApnsVoipChannelRequestRequestTypeDef = { # (1)
"APNSVoipChannelRequest": ...,
"ApplicationId": ...,
}
parent.update_apns_voip_channel(**kwargs)
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.create_client("pinpoint").update_apns_voip_sandbox_channel
method.
boto3 documentation
# update_apns_voip_sandbox_channel method definition
await def update_apns_voip_sandbox_channel(
self,
*,
APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsVoipSandboxChannelResponseTypeDef: # (2)
...
# update_apns_voip_sandbox_channel method usage example with argument unpacking
kwargs: UpdateApnsVoipSandboxChannelRequestRequestTypeDef = { # (1)
"APNSVoipSandboxChannelRequest": ...,
"ApplicationId": ...,
}
parent.update_apns_voip_sandbox_channel(**kwargs)
update_application_settings#
Updates the settings for an application.
Type annotations and code completion for session.create_client("pinpoint").update_application_settings
method.
boto3 documentation
# update_application_settings method definition
await def update_application_settings(
self,
*,
ApplicationId: str,
WriteApplicationSettingsRequest: WriteApplicationSettingsRequestTypeDef, # (1)
) -> UpdateApplicationSettingsResponseTypeDef: # (2)
...
# update_application_settings method usage example with argument unpacking
kwargs: UpdateApplicationSettingsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"WriteApplicationSettingsRequest": ...,
}
parent.update_application_settings(**kwargs)
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.create_client("pinpoint").update_baidu_channel
method.
boto3 documentation
# update_baidu_channel method definition
await def update_baidu_channel(
self,
*,
ApplicationId: str,
BaiduChannelRequest: BaiduChannelRequestTypeDef, # (1)
) -> UpdateBaiduChannelResponseTypeDef: # (2)
...
# update_baidu_channel method usage example with argument unpacking
kwargs: UpdateBaiduChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"BaiduChannelRequest": ...,
}
parent.update_baidu_channel(**kwargs)
update_campaign#
Updates the configuration and other settings for a campaign.
Type annotations and code completion for session.create_client("pinpoint").update_campaign
method.
boto3 documentation
# update_campaign method definition
await def update_campaign(
self,
*,
ApplicationId: str,
CampaignId: str,
WriteCampaignRequest: WriteCampaignRequestTypeDef, # (1)
) -> UpdateCampaignResponseTypeDef: # (2)
...
# update_campaign method usage example with argument unpacking
kwargs: UpdateCampaignRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"CampaignId": ...,
"WriteCampaignRequest": ...,
}
parent.update_campaign(**kwargs)
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.create_client("pinpoint").update_email_channel
method.
boto3 documentation
# update_email_channel method definition
await def update_email_channel(
self,
*,
ApplicationId: str,
EmailChannelRequest: EmailChannelRequestTypeDef, # (1)
) -> UpdateEmailChannelResponseTypeDef: # (2)
...
# update_email_channel method usage example with argument unpacking
kwargs: UpdateEmailChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EmailChannelRequest": ...,
}
parent.update_email_channel(**kwargs)
update_email_template#
Updates an existing message template for messages that are sent through the email channel.
Type annotations and code completion for session.create_client("pinpoint").update_email_template
method.
boto3 documentation
# update_email_template method definition
await def update_email_template(
self,
*,
EmailTemplateRequest: EmailTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateEmailTemplateResponseTypeDef: # (2)
...
# update_email_template method usage example with argument unpacking
kwargs: UpdateEmailTemplateRequestRequestTypeDef = { # (1)
"EmailTemplateRequest": ...,
"TemplateName": ...,
}
parent.update_email_template(**kwargs)
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.create_client("pinpoint").update_endpoint
method.
boto3 documentation
# update_endpoint method definition
await def update_endpoint(
self,
*,
ApplicationId: str,
EndpointId: str,
EndpointRequest: EndpointRequestTypeDef, # (1)
) -> UpdateEndpointResponseTypeDef: # (2)
...
# update_endpoint method usage example with argument unpacking
kwargs: UpdateEndpointRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EndpointId": ...,
"EndpointRequest": ...,
}
parent.update_endpoint(**kwargs)
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.create_client("pinpoint").update_endpoints_batch
method.
boto3 documentation
# update_endpoints_batch method definition
await def update_endpoints_batch(
self,
*,
ApplicationId: str,
EndpointBatchRequest: EndpointBatchRequestTypeDef, # (1)
) -> UpdateEndpointsBatchResponseTypeDef: # (2)
...
# update_endpoints_batch method usage example with argument unpacking
kwargs: UpdateEndpointsBatchRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"EndpointBatchRequest": ...,
}
parent.update_endpoints_batch(**kwargs)
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.create_client("pinpoint").update_gcm_channel
method.
boto3 documentation
# update_gcm_channel method definition
await def update_gcm_channel(
self,
*,
ApplicationId: str,
GCMChannelRequest: GCMChannelRequestTypeDef, # (1)
) -> UpdateGcmChannelResponseTypeDef: # (2)
...
# update_gcm_channel method usage example with argument unpacking
kwargs: UpdateGcmChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"GCMChannelRequest": ...,
}
parent.update_gcm_channel(**kwargs)
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.create_client("pinpoint").update_in_app_template
method.
boto3 documentation
# update_in_app_template method definition
await def update_in_app_template(
self,
*,
InAppTemplateRequest: InAppTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateInAppTemplateResponseTypeDef: # (2)
...
# update_in_app_template method usage example with argument unpacking
kwargs: UpdateInAppTemplateRequestRequestTypeDef = { # (1)
"InAppTemplateRequest": ...,
"TemplateName": ...,
}
parent.update_in_app_template(**kwargs)
update_journey#
Updates the configuration and other settings for a journey.
Type annotations and code completion for session.create_client("pinpoint").update_journey
method.
boto3 documentation
# update_journey method definition
await def update_journey(
self,
*,
ApplicationId: str,
JourneyId: str,
WriteJourneyRequest: WriteJourneyRequestTypeDef, # (1)
) -> UpdateJourneyResponseTypeDef: # (2)
...
# update_journey method usage example with argument unpacking
kwargs: UpdateJourneyRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
"WriteJourneyRequest": ...,
}
parent.update_journey(**kwargs)
update_journey_state#
Cancels (stops) an active journey.
Type annotations and code completion for session.create_client("pinpoint").update_journey_state
method.
boto3 documentation
# update_journey_state method definition
await def update_journey_state(
self,
*,
ApplicationId: str,
JourneyId: str,
JourneyStateRequest: JourneyStateRequestTypeDef, # (1)
) -> UpdateJourneyStateResponseTypeDef: # (2)
...
# update_journey_state method usage example with argument unpacking
kwargs: UpdateJourneyStateRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
"JourneyStateRequest": ...,
}
parent.update_journey_state(**kwargs)
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.create_client("pinpoint").update_push_template
method.
boto3 documentation
# update_push_template method definition
await def update_push_template(
self,
*,
PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdatePushTemplateResponseTypeDef: # (2)
...
# update_push_template method usage example with argument unpacking
kwargs: UpdatePushTemplateRequestRequestTypeDef = { # (1)
"PushNotificationTemplateRequest": ...,
"TemplateName": ...,
}
parent.update_push_template(**kwargs)
update_recommender_configuration#
Updates an Amazon Pinpoint configuration for a recommender model.
Type annotations and code completion for session.create_client("pinpoint").update_recommender_configuration
method.
boto3 documentation
# update_recommender_configuration method definition
await def update_recommender_configuration(
self,
*,
RecommenderId: str,
UpdateRecommenderConfiguration: UpdateRecommenderConfigurationTypeDef, # (1)
) -> UpdateRecommenderConfigurationResponseTypeDef: # (2)
...
# update_recommender_configuration method usage example with argument unpacking
kwargs: UpdateRecommenderConfigurationRequestRequestTypeDef = { # (1)
"RecommenderId": ...,
"UpdateRecommenderConfiguration": ...,
}
parent.update_recommender_configuration(**kwargs)
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.create_client("pinpoint").update_segment
method.
boto3 documentation
# update_segment method definition
await def update_segment(
self,
*,
ApplicationId: str,
SegmentId: str,
WriteSegmentRequest: WriteSegmentRequestTypeDef, # (1)
) -> UpdateSegmentResponseTypeDef: # (2)
...
# update_segment method usage example with argument unpacking
kwargs: UpdateSegmentRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SegmentId": ...,
"WriteSegmentRequest": ...,
}
parent.update_segment(**kwargs)
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.create_client("pinpoint").update_sms_channel
method.
boto3 documentation
# update_sms_channel method definition
await def update_sms_channel(
self,
*,
ApplicationId: str,
SMSChannelRequest: SMSChannelRequestTypeDef, # (1)
) -> UpdateSmsChannelResponseTypeDef: # (2)
...
# update_sms_channel method usage example with argument unpacking
kwargs: UpdateSmsChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"SMSChannelRequest": ...,
}
parent.update_sms_channel(**kwargs)
update_sms_template#
Updates an existing message template for messages that are sent through the SMS channel.
Type annotations and code completion for session.create_client("pinpoint").update_sms_template
method.
boto3 documentation
# update_sms_template method definition
await def update_sms_template(
self,
*,
SMSTemplateRequest: SMSTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateSmsTemplateResponseTypeDef: # (2)
...
# update_sms_template method usage example with argument unpacking
kwargs: UpdateSmsTemplateRequestRequestTypeDef = { # (1)
"SMSTemplateRequest": ...,
"TemplateName": ...,
}
parent.update_sms_template(**kwargs)
update_template_active_version#
Changes the status of a specific version of a message template to active.
Type annotations and code completion for session.create_client("pinpoint").update_template_active_version
method.
boto3 documentation
# update_template_active_version method definition
await def update_template_active_version(
self,
*,
TemplateActiveVersionRequest: TemplateActiveVersionRequestTypeDef, # (1)
TemplateName: str,
TemplateType: str,
) -> UpdateTemplateActiveVersionResponseTypeDef: # (2)
...
# update_template_active_version method usage example with argument unpacking
kwargs: UpdateTemplateActiveVersionRequestRequestTypeDef = { # (1)
"TemplateActiveVersionRequest": ...,
"TemplateName": ...,
"TemplateType": ...,
}
parent.update_template_active_version(**kwargs)
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.create_client("pinpoint").update_voice_channel
method.
boto3 documentation
# update_voice_channel method definition
await def update_voice_channel(
self,
*,
ApplicationId: str,
VoiceChannelRequest: VoiceChannelRequestTypeDef, # (1)
) -> UpdateVoiceChannelResponseTypeDef: # (2)
...
# update_voice_channel method usage example with argument unpacking
kwargs: UpdateVoiceChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"VoiceChannelRequest": ...,
}
parent.update_voice_channel(**kwargs)
update_voice_template#
Updates an existing message template for messages that are sent through the voice channel.
Type annotations and code completion for session.create_client("pinpoint").update_voice_template
method.
boto3 documentation
# update_voice_template method definition
await def update_voice_template(
self,
*,
TemplateName: str,
VoiceTemplateRequest: VoiceTemplateRequestTypeDef, # (1)
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateVoiceTemplateResponseTypeDef: # (2)
...
# update_voice_template method usage example with argument unpacking
kwargs: UpdateVoiceTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
"VoiceTemplateRequest": ...,
}
parent.update_voice_template(**kwargs)
verify_otp_message#
Verify an OTP See also: AWS API Documentation.
Type annotations and code completion for session.create_client("pinpoint").verify_otp_message
method.
boto3 documentation
# verify_otp_message method definition
await def verify_otp_message(
self,
*,
ApplicationId: str,
VerifyOTPMessageRequestParameters: VerifyOTPMessageRequestParametersTypeDef, # (1)
) -> VerifyOTPMessageResponseTypeDef: # (2)
...
# verify_otp_message method usage example with argument unpacking
kwargs: VerifyOTPMessageRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"VerifyOTPMessageRequestParameters": ...,
}
parent.verify_otp_message(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("pinpoint").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> PinpointClient:
...
__aexit__#
Type annotations and code completion for session.create_client("pinpoint").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...