PinpointClient
Auto-generated documentation for Pinpoint type annotations stubs module mypy-boto3-pinpoint.
PinpointClient
Type annotations and code completion for boto3.client("pinpoint")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_pinpoint.client import PinpointClient
def get_pinpoint_client() -> PinpointClient:
return Session().client("pinpoint")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("pinpoint").exceptions
structure.
client = boto3.client("pinpoint")
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)
from mypy_boto3_pinpoint.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("pinpoint").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("pinpoint").close
method.
boto3 documentation
create_app
Creates an application.
Type annotations and code completion for boto3.client("pinpoint").create_app
method.
boto3 documentation
def create_app(
self,
*,
CreateApplicationRequest: CreateApplicationRequestTypeDef, # (1)
) -> CreateAppResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_campaign
method.
boto3 documentation
def create_campaign(
self,
*,
ApplicationId: str,
WriteCampaignRequest: WriteCampaignRequestTypeDef, # (1)
) -> CreateCampaignResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_email_template
method.
boto3 documentation
def create_email_template(
self,
*,
EmailTemplateRequest: EmailTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateEmailTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_export_job
method.
boto3 documentation
def create_export_job(
self,
*,
ApplicationId: str,
ExportJobRequest: ExportJobRequestTypeDef, # (1)
) -> CreateExportJobResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_import_job
method.
boto3 documentation
def create_import_job(
self,
*,
ApplicationId: str,
ImportJobRequest: ImportJobRequestTypeDef, # (1)
) -> CreateImportJobResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_in_app_template
method.
boto3 documentation
def create_in_app_template(
self,
*,
InAppTemplateRequest: InAppTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateInAppTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_journey
method.
boto3 documentation
def create_journey(
self,
*,
ApplicationId: str,
WriteJourneyRequest: WriteJourneyRequestTypeDef, # (1)
) -> CreateJourneyResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_push_template
method.
boto3 documentation
def create_push_template(
self,
*,
PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreatePushTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_recommender_configuration
method.
boto3 documentation
def create_recommender_configuration(
self,
*,
CreateRecommenderConfiguration: CreateRecommenderConfigurationTypeDef, # (1)
) -> CreateRecommenderConfigurationResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_segment
method.
boto3 documentation
def create_segment(
self,
*,
ApplicationId: str,
WriteSegmentRequest: WriteSegmentRequestTypeDef, # (1)
) -> CreateSegmentResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_sms_template
method.
boto3 documentation
def create_sms_template(
self,
*,
SMSTemplateRequest: SMSTemplateRequestTypeDef, # (1)
TemplateName: str,
) -> CreateSmsTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").create_voice_template
method.
boto3 documentation
def create_voice_template(
self,
*,
TemplateName: str,
VoiceTemplateRequest: VoiceTemplateRequestTypeDef, # (1)
) -> CreateVoiceTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").delete_adm_channel
method.
boto3 documentation
def delete_adm_channel(
self,
*,
ApplicationId: str,
) -> DeleteAdmChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_apns_channel
method.
boto3 documentation
def delete_apns_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_apns_sandbox_channel
method.
boto3 documentation
def delete_apns_sandbox_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsSandboxChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_apns_voip_channel
method.
boto3 documentation
def delete_apns_voip_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsVoipChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_apns_voip_sandbox_channel
method.
boto3 documentation
def delete_apns_voip_sandbox_channel(
self,
*,
ApplicationId: str,
) -> DeleteApnsVoipSandboxChannelResponseTypeDef: # (1)
...
kwargs: DeleteApnsVoipSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_apns_voip_sandbox_channel(**kwargs)
delete_app
Deletes an application.
Type annotations and code completion for boto3.client("pinpoint").delete_app
method.
boto3 documentation
def delete_app(
self,
*,
ApplicationId: str,
) -> DeleteAppResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_baidu_channel
method.
boto3 documentation
def delete_baidu_channel(
self,
*,
ApplicationId: str,
) -> DeleteBaiduChannelResponseTypeDef: # (1)
...
kwargs: DeleteBaiduChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.delete_baidu_channel(**kwargs)
delete_campaign
Deletes a campaign from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_campaign
method.
boto3 documentation
def delete_campaign(
self,
*,
ApplicationId: str,
CampaignId: str,
) -> DeleteCampaignResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_email_channel
method.
boto3 documentation
def delete_email_channel(
self,
*,
ApplicationId: str,
) -> DeleteEmailChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_email_template
method.
boto3 documentation
def delete_email_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteEmailTemplateResponseTypeDef: # (1)
...
kwargs: DeleteEmailTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_email_template(**kwargs)
delete_endpoint
Deletes an endpoint from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_endpoint
method.
boto3 documentation
def delete_endpoint(
self,
*,
ApplicationId: str,
EndpointId: str,
) -> DeleteEndpointResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_event_stream
method.
boto3 documentation
def delete_event_stream(
self,
*,
ApplicationId: str,
) -> DeleteEventStreamResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_gcm_channel
method.
boto3 documentation
def delete_gcm_channel(
self,
*,
ApplicationId: str,
) -> DeleteGcmChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_in_app_template
method.
boto3 documentation
def delete_in_app_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteInAppTemplateResponseTypeDef: # (1)
...
kwargs: DeleteInAppTemplateRequestRequestTypeDef = { # (1)
"TemplateName": ...,
}
parent.delete_in_app_template(**kwargs)
delete_journey
Deletes a journey from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_journey
method.
boto3 documentation
def delete_journey(
self,
*,
ApplicationId: str,
JourneyId: str,
) -> DeleteJourneyResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_push_template
method.
boto3 documentation
def delete_push_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeletePushTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_recommender_configuration
method.
boto3 documentation
def delete_recommender_configuration(
self,
*,
RecommenderId: str,
) -> DeleteRecommenderConfigurationResponseTypeDef: # (1)
...
kwargs: DeleteRecommenderConfigurationRequestRequestTypeDef = { # (1)
"RecommenderId": ...,
}
parent.delete_recommender_configuration(**kwargs)
delete_segment
Deletes a segment from an application.
Type annotations and code completion for boto3.client("pinpoint").delete_segment
method.
boto3 documentation
def delete_segment(
self,
*,
ApplicationId: str,
SegmentId: str,
) -> DeleteSegmentResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_sms_channel
method.
boto3 documentation
def delete_sms_channel(
self,
*,
ApplicationId: str,
) -> DeleteSmsChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_sms_template
method.
boto3 documentation
def delete_sms_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteSmsTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_user_endpoints
method.
boto3 documentation
def delete_user_endpoints(
self,
*,
ApplicationId: str,
UserId: str,
) -> DeleteUserEndpointsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_voice_channel
method.
boto3 documentation
def delete_voice_channel(
self,
*,
ApplicationId: str,
) -> DeleteVoiceChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").delete_voice_template
method.
boto3 documentation
def delete_voice_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> DeleteVoiceTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_adm_channel
Retrieves information about the status and settings of the ADM channel for an application.
Type annotations and code completion for boto3.client("pinpoint").get_adm_channel
method.
boto3 documentation
def get_adm_channel(
self,
*,
ApplicationId: str,
) -> GetAdmChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_apns_channel
method.
boto3 documentation
def get_apns_channel(
self,
*,
ApplicationId: str,
) -> GetApnsChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_apns_sandbox_channel
method.
boto3 documentation
def get_apns_sandbox_channel(
self,
*,
ApplicationId: str,
) -> GetApnsSandboxChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_apns_voip_channel
method.
boto3 documentation
def get_apns_voip_channel(
self,
*,
ApplicationId: str,
) -> GetApnsVoipChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_apns_voip_sandbox_channel
method.
boto3 documentation
def get_apns_voip_sandbox_channel(
self,
*,
ApplicationId: str,
) -> GetApnsVoipSandboxChannelResponseTypeDef: # (1)
...
kwargs: GetApnsVoipSandboxChannelRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
}
parent.get_apns_voip_sandbox_channel(**kwargs)
get_app
Retrieves information about an application.
Type annotations and code completion for boto3.client("pinpoint").get_app
method.
boto3 documentation
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 boto3.client("pinpoint").get_application_date_range_kpi
method.
boto3 documentation
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)
...
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 boto3.client("pinpoint").get_application_settings
method.
boto3 documentation
def get_application_settings(
self,
*,
ApplicationId: str,
) -> GetApplicationSettingsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_apps
method.
boto3 documentation
def get_apps(
self,
*,
PageSize: str = ...,
Token: str = ...,
) -> GetAppsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_baidu_channel
method.
boto3 documentation
def get_baidu_channel(
self,
*,
ApplicationId: str,
) -> GetBaiduChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_campaign
method.
boto3 documentation
def get_campaign(
self,
*,
ApplicationId: str,
CampaignId: str,
) -> GetCampaignResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_campaign_activities
method.
boto3 documentation
def get_campaign_activities(
self,
*,
ApplicationId: str,
CampaignId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetCampaignActivitiesResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_campaign_date_range_kpi
method.
boto3 documentation
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)
...
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 boto3.client("pinpoint").get_campaign_version
method.
boto3 documentation
def get_campaign_version(
self,
*,
ApplicationId: str,
CampaignId: str,
Version: str,
) -> GetCampaignVersionResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_campaign_versions
method.
boto3 documentation
def get_campaign_versions(
self,
*,
ApplicationId: str,
CampaignId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetCampaignVersionsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_campaigns
method.
boto3 documentation
def get_campaigns(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetCampaignsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_channels
method.
boto3 documentation
def get_channels(
self,
*,
ApplicationId: str,
) -> GetChannelsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_email_channel
method.
boto3 documentation
def get_email_channel(
self,
*,
ApplicationId: str,
) -> GetEmailChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_email_template
method.
boto3 documentation
def get_email_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetEmailTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_endpoint
method.
boto3 documentation
def get_endpoint(
self,
*,
ApplicationId: str,
EndpointId: str,
) -> GetEndpointResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_event_stream
method.
boto3 documentation
def get_event_stream(
self,
*,
ApplicationId: str,
) -> GetEventStreamResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_export_job
method.
boto3 documentation
def get_export_job(
self,
*,
ApplicationId: str,
JobId: str,
) -> GetExportJobResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_export_jobs
method.
boto3 documentation
def get_export_jobs(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetExportJobsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_gcm_channel
method.
boto3 documentation
def get_gcm_channel(
self,
*,
ApplicationId: str,
) -> GetGcmChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_import_job
method.
boto3 documentation
def get_import_job(
self,
*,
ApplicationId: str,
JobId: str,
) -> GetImportJobResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_import_jobs
method.
boto3 documentation
def get_import_jobs(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetImportJobsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_in_app_messages
method.
boto3 documentation
def get_in_app_messages(
self,
*,
ApplicationId: str,
EndpointId: str,
) -> GetInAppMessagesResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_in_app_template
method.
boto3 documentation
def get_in_app_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetInAppTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_journey
method.
boto3 documentation
def get_journey(
self,
*,
ApplicationId: str,
JourneyId: str,
) -> GetJourneyResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_journey_date_range_kpi
method.
boto3 documentation
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)
...
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 boto3.client("pinpoint").get_journey_execution_activity_metrics
method.
boto3 documentation
def get_journey_execution_activity_metrics(
self,
*,
ApplicationId: str,
JourneyActivityId: str,
JourneyId: str,
NextToken: str = ...,
PageSize: str = ...,
) -> GetJourneyExecutionActivityMetricsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_journey_execution_metrics
method.
boto3 documentation
def get_journey_execution_metrics(
self,
*,
ApplicationId: str,
JourneyId: str,
NextToken: str = ...,
PageSize: str = ...,
) -> GetJourneyExecutionMetricsResponseTypeDef: # (1)
...
kwargs: GetJourneyExecutionMetricsRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
}
parent.get_journey_execution_metrics(**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 boto3.client("pinpoint").get_push_template
method.
boto3 documentation
def get_push_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetPushTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_recommender_configuration
method.
boto3 documentation
def get_recommender_configuration(
self,
*,
RecommenderId: str,
) -> GetRecommenderConfigurationResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_recommender_configurations
method.
boto3 documentation
def get_recommender_configurations(
self,
*,
PageSize: str = ...,
Token: str = ...,
) -> GetRecommenderConfigurationsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_segment
method.
boto3 documentation
def get_segment(
self,
*,
ApplicationId: str,
SegmentId: str,
) -> GetSegmentResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_segment_export_jobs
method.
boto3 documentation
def get_segment_export_jobs(
self,
*,
ApplicationId: str,
SegmentId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentExportJobsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_segment_import_jobs
method.
boto3 documentation
def get_segment_import_jobs(
self,
*,
ApplicationId: str,
SegmentId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentImportJobsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_segment_version
method.
boto3 documentation
def get_segment_version(
self,
*,
ApplicationId: str,
SegmentId: str,
Version: str,
) -> GetSegmentVersionResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_segment_versions
method.
boto3 documentation
def get_segment_versions(
self,
*,
ApplicationId: str,
SegmentId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentVersionsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_segments
method.
boto3 documentation
def get_segments(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> GetSegmentsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_sms_channel
method.
boto3 documentation
def get_sms_channel(
self,
*,
ApplicationId: str,
) -> GetSmsChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_sms_template
method.
boto3 documentation
def get_sms_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetSmsTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_user_endpoints
method.
boto3 documentation
def get_user_endpoints(
self,
*,
ApplicationId: str,
UserId: str,
) -> GetUserEndpointsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_voice_channel
method.
boto3 documentation
def get_voice_channel(
self,
*,
ApplicationId: str,
) -> GetVoiceChannelResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").get_voice_template
method.
boto3 documentation
def get_voice_template(
self,
*,
TemplateName: str,
Version: str = ...,
) -> GetVoiceTemplateResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").list_journeys
method.
boto3 documentation
def list_journeys(
self,
*,
ApplicationId: str,
PageSize: str = ...,
Token: str = ...,
) -> ListJourneysResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").list_template_versions
method.
boto3 documentation
def list_template_versions(
self,
*,
TemplateName: str,
TemplateType: str,
NextToken: str = ...,
PageSize: str = ...,
) -> ListTemplateVersionsResponseTypeDef: # (1)
...
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 boto3.client("pinpoint").list_templates
method.
boto3 documentation
def list_templates(
self,
*,
NextToken: str = ...,
PageSize: str = ...,
Prefix: str = ...,
TemplateType: str = ...,
) -> ListTemplatesResponseTypeDef: # (1)
...
kwargs: ListTemplatesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_templates(**kwargs)
phone_number_validate
Retrieves information about a phone number.
Type annotations and code completion for boto3.client("pinpoint").phone_number_validate
method.
boto3 documentation
def phone_number_validate(
self,
*,
NumberValidateRequest: NumberValidateRequestTypeDef, # (1)
) -> PhoneNumberValidateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").put_event_stream
method.
boto3 documentation
def put_event_stream(
self,
*,
ApplicationId: str,
WriteEventStream: WriteEventStreamTypeDef, # (1)
) -> PutEventStreamResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").put_events
method.
boto3 documentation
def put_events(
self,
*,
ApplicationId: str,
EventsRequest: EventsRequestTypeDef, # (1)
) -> PutEventsResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").remove_attributes
method.
boto3 documentation
def remove_attributes(
self,
*,
ApplicationId: str,
AttributeType: str,
UpdateAttributesRequest: UpdateAttributesRequestTypeDef, # (1)
) -> RemoveAttributesResponseTypeDef: # (2)
...
kwargs: RemoveAttributesRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"AttributeType": ...,
"UpdateAttributesRequest": ...,
}
parent.remove_attributes(**kwargs)
send_messages
Creates and sends a direct message.
Type annotations and code completion for boto3.client("pinpoint").send_messages
method.
boto3 documentation
def send_messages(
self,
*,
ApplicationId: str,
MessageRequest: MessageRequestTypeDef, # (1)
) -> SendMessagesResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").send_otp_message
method.
boto3 documentation
def send_otp_message(
self,
*,
ApplicationId: str,
SendOTPMessageRequestParameters: SendOTPMessageRequestParametersTypeDef, # (1)
) -> SendOTPMessageResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").send_users_messages
method.
boto3 documentation
def send_users_messages(
self,
*,
ApplicationId: str,
SendUsersMessageRequest: SendUsersMessageRequestTypeDef, # (1)
) -> SendUsersMessagesResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
TagsModel: TagsModelTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
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 boto3.client("pinpoint").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 boto3.client("pinpoint").update_adm_channel
method.
boto3 documentation
def update_adm_channel(
self,
*,
ADMChannelRequest: ADMChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateAdmChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_apns_channel
method.
boto3 documentation
def update_apns_channel(
self,
*,
APNSChannelRequest: APNSChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_apns_sandbox_channel
method.
boto3 documentation
def update_apns_sandbox_channel(
self,
*,
APNSSandboxChannelRequest: APNSSandboxChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsSandboxChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_apns_voip_channel
method.
boto3 documentation
def update_apns_voip_channel(
self,
*,
APNSVoipChannelRequest: APNSVoipChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsVoipChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_apns_voip_sandbox_channel
method.
boto3 documentation
def update_apns_voip_sandbox_channel(
self,
*,
APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequestTypeDef, # (1)
ApplicationId: str,
) -> UpdateApnsVoipSandboxChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_application_settings
method.
boto3 documentation
def update_application_settings(
self,
*,
ApplicationId: str,
WriteApplicationSettingsRequest: WriteApplicationSettingsRequestTypeDef, # (1)
) -> UpdateApplicationSettingsResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_baidu_channel
method.
boto3 documentation
def update_baidu_channel(
self,
*,
ApplicationId: str,
BaiduChannelRequest: BaiduChannelRequestTypeDef, # (1)
) -> UpdateBaiduChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_campaign
method.
boto3 documentation
def update_campaign(
self,
*,
ApplicationId: str,
CampaignId: str,
WriteCampaignRequest: WriteCampaignRequestTypeDef, # (1)
) -> UpdateCampaignResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_email_channel
method.
boto3 documentation
def update_email_channel(
self,
*,
ApplicationId: str,
EmailChannelRequest: EmailChannelRequestTypeDef, # (1)
) -> UpdateEmailChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_email_template
method.
boto3 documentation
def update_email_template(
self,
*,
EmailTemplateRequest: EmailTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateEmailTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_endpoint
method.
boto3 documentation
def update_endpoint(
self,
*,
ApplicationId: str,
EndpointId: str,
EndpointRequest: EndpointRequestTypeDef, # (1)
) -> UpdateEndpointResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_endpoints_batch
method.
boto3 documentation
def update_endpoints_batch(
self,
*,
ApplicationId: str,
EndpointBatchRequest: EndpointBatchRequestTypeDef, # (1)
) -> UpdateEndpointsBatchResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_gcm_channel
method.
boto3 documentation
def update_gcm_channel(
self,
*,
ApplicationId: str,
GCMChannelRequest: GCMChannelRequestTypeDef, # (1)
) -> UpdateGcmChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_in_app_template
method.
boto3 documentation
def update_in_app_template(
self,
*,
InAppTemplateRequest: InAppTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateInAppTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_journey
method.
boto3 documentation
def update_journey(
self,
*,
ApplicationId: str,
JourneyId: str,
WriteJourneyRequest: WriteJourneyRequestTypeDef, # (1)
) -> UpdateJourneyResponseTypeDef: # (2)
...
kwargs: UpdateJourneyRequestRequestTypeDef = { # (1)
"ApplicationId": ...,
"JourneyId": ...,
"WriteJourneyRequest": ...,
}
parent.update_journey(**kwargs)
update_journey_state
Cancels (stops) an active journey.
Type annotations and code completion for boto3.client("pinpoint").update_journey_state
method.
boto3 documentation
def update_journey_state(
self,
*,
ApplicationId: str,
JourneyId: str,
JourneyStateRequest: JourneyStateRequestTypeDef, # (1)
) -> UpdateJourneyStateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_push_template
method.
boto3 documentation
def update_push_template(
self,
*,
PushNotificationTemplateRequest: PushNotificationTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdatePushTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_recommender_configuration
method.
boto3 documentation
def update_recommender_configuration(
self,
*,
RecommenderId: str,
UpdateRecommenderConfiguration: UpdateRecommenderConfigurationTypeDef, # (1)
) -> UpdateRecommenderConfigurationResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_segment
method.
boto3 documentation
def update_segment(
self,
*,
ApplicationId: str,
SegmentId: str,
WriteSegmentRequest: WriteSegmentRequestTypeDef, # (1)
) -> UpdateSegmentResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_sms_channel
method.
boto3 documentation
def update_sms_channel(
self,
*,
ApplicationId: str,
SMSChannelRequest: SMSChannelRequestTypeDef, # (1)
) -> UpdateSmsChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_sms_template
method.
boto3 documentation
def update_sms_template(
self,
*,
SMSTemplateRequest: SMSTemplateRequestTypeDef, # (1)
TemplateName: str,
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateSmsTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_template_active_version
method.
boto3 documentation
def update_template_active_version(
self,
*,
TemplateActiveVersionRequest: TemplateActiveVersionRequestTypeDef, # (1)
TemplateName: str,
TemplateType: str,
) -> UpdateTemplateActiveVersionResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_voice_channel
method.
boto3 documentation
def update_voice_channel(
self,
*,
ApplicationId: str,
VoiceChannelRequest: VoiceChannelRequestTypeDef, # (1)
) -> UpdateVoiceChannelResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").update_voice_template
method.
boto3 documentation
def update_voice_template(
self,
*,
TemplateName: str,
VoiceTemplateRequest: VoiceTemplateRequestTypeDef, # (1)
CreateNewVersion: bool = ...,
Version: str = ...,
) -> UpdateVoiceTemplateResponseTypeDef: # (2)
...
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 boto3.client("pinpoint").verify_otp_message
method.
boto3 documentation
def verify_otp_message(
self,
*,
ApplicationId: str,
VerifyOTPMessageRequestParameters: VerifyOTPMessageRequestParametersTypeDef, # (1)
) -> VerifyOTPMessageResponseTypeDef: # (2)
...