View Source aws_pinpoint (aws v1.0.4)

Doc Engage API - Amazon Pinpoint API

Summary

Functions

Creates an application.
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
Creates a message template for messages that are sent through the email channel.
Creates an export job for an application.
Creates an import job for an application.
Creates a new message template for messages using the in-app message channel.
Creates a journey for an application.
Creates a message template for messages that are sent through a push notification channel.
Creates an Amazon Pinpoint configuration for a recommender model.
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.
Creates a message template for messages that are sent through the SMS channel.
Creates a message template for messages that are sent through the voice channel.
Disables the ADM channel for an application and deletes any existing settings for the channel.
Disables the APNs channel for an application and deletes any existing settings for the channel.
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
Disables the Baidu channel for an application and deletes any existing settings for the channel.
Deletes a campaign from an application.
Disables the email channel for an application and deletes any existing settings for the channel.
Deletes a message template for messages that were sent through the email channel.
Deletes an endpoint from an application.
Deletes the event stream for an application.
Disables the GCM channel for an application and deletes any existing settings for the channel.
Deletes a message template for messages sent using the in-app message channel.
Deletes a journey from an application.
Deletes a message template for messages that were sent through a push notification channel.
Deletes an Amazon Pinpoint configuration for a recommender model.
Deletes a segment from an application.
Disables the SMS channel for an application and deletes any existing settings for the channel.
Deletes a message template for messages that were sent through the SMS channel.
Deletes all the endpoints that are associated with a specific user ID.
Disables the voice channel for an application and deletes any existing settings for the channel.
Deletes a message template for messages that were sent through the voice channel.
Retrieves information about the status and settings of the ADM channel for an application.
Retrieves information about the status and settings of the APNs channel for an application.
Retrieves information about the status and settings of the APNs sandbox channel for an application.
Retrieves information about the status and settings of the APNs VoIP channel for an application.
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
Retrieves information about an application.
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
Retrieves information about the settings for an application.
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
Retrieves information about the status and settings of the Baidu channel for an application.
Retrieves information about the status, configuration, and other settings for a campaign.
Retrieves information about all the activities for a campaign.
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
Retrieves information about the history and status of each channel for an application.
Retrieves information about the status and settings of the email channel for an application.
Retrieves the content and settings of a message template for messages that are sent through the email channel.
Retrieves information about the settings and attributes of a specific endpoint for an application.
Retrieves information about the event stream settings for an application.
Retrieves information about the status and settings of a specific export job for an application.
Retrieves information about the status and settings of all the export jobs for an application.
Retrieves information about the status and settings of the GCM channel for an application.
Retrieves information about the status and settings of a specific import job for an application.
Retrieves information about the status and settings of all the import jobs for an application.
Retrieves the in-app messages targeted for the provided endpoint ID.
Retrieves the content and settings of a message template for messages sent through the in-app channel.
Retrieves information about the status, configuration, and other settings for a journey.
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
Provides information about the runs of a journey.
Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
Retrieves information about the status and settings of the export jobs for a segment.
Retrieves information about the status and settings of the import jobs for a segment.
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
Retrieves information about the status and settings of the SMS channel for an application.
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
Retrieves information about all the endpoints that are associated with a specific user ID.
Retrieves information about the status and settings of the voice channel for an application.
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
Retrieves information about all the versions of a specific message template.
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
Retrieves information about a phone number.
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

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

Creates and sends a direct message.
Creates and sends a message to a list of users.
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
Updates the settings for an application.
Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
Updates the configuration and other settings for a campaign.
Enables the email channel for an application or updates the status and settings of the email channel for an application.
Updates an existing message template for messages that are sent through the email channel.

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

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

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
Updates an existing message template for messages sent through the in-app message channel.
Updates the configuration and other settings for a journey.
Pause, resume or cancels (stops) a journey.
Updates an existing message template for messages that are sent through a push notification channel.
Updates an Amazon Pinpoint configuration for a recommender model.
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.
Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
Updates an existing message template for messages that are sent through the SMS channel.
Changes the status of a specific version of a message template to active.
Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
Updates an existing message template for messages that are sent through the voice channel.

Functions

Link to this function

create_app(Client, Input)

View Source
Creates an application.
Link to this function

create_app(Client, Input0, Options0)

View Source
Link to this function

create_campaign(Client, ApplicationId, Input)

View Source
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
Link to this function

create_campaign(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

create_email_template(Client, TemplateName, Input)

View Source
Creates a message template for messages that are sent through the email channel.
Link to this function

create_email_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

create_export_job(Client, ApplicationId, Input)

View Source
Creates an export job for an application.
Link to this function

create_export_job(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

create_import_job(Client, ApplicationId, Input)

View Source
Creates an import job for an application.
Link to this function

create_import_job(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

create_in_app_template(Client, TemplateName, Input)

View Source
Creates a new message template for messages using the in-app message channel.
Link to this function

create_in_app_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

create_journey(Client, ApplicationId, Input)

View Source
Creates a journey for an application.
Link to this function

create_journey(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

create_push_template(Client, TemplateName, Input)

View Source
Creates a message template for messages that are sent through a push notification channel.
Link to this function

create_push_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

create_recommender_configuration(Client, Input)

View Source
Creates an Amazon Pinpoint configuration for a recommender model.
Link to this function

create_recommender_configuration(Client, Input0, Options0)

View Source
Link to this function

create_segment(Client, ApplicationId, Input)

View Source
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.
Link to this function

create_segment(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

create_sms_template(Client, TemplateName, Input)

View Source
Creates a message template for messages that are sent through the SMS channel.
Link to this function

create_sms_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

create_voice_template(Client, TemplateName, Input)

View Source
Creates a message template for messages that are sent through the voice channel.
Link to this function

create_voice_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

delete_adm_channel(Client, ApplicationId, Input)

View Source
Disables the ADM channel for an application and deletes any existing settings for the channel.
Link to this function

delete_adm_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_apns_channel(Client, ApplicationId, Input)

View Source
Disables the APNs channel for an application and deletes any existing settings for the channel.
Link to this function

delete_apns_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_apns_sandbox_channel(Client, ApplicationId, Input)

View Source
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
Link to this function

delete_apns_sandbox_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_apns_voip_channel(Client, ApplicationId, Input)

View Source
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
Link to this function

delete_apns_voip_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_apns_voip_sandbox_channel(Client, ApplicationId, Input)

View Source
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
Link to this function

delete_apns_voip_sandbox_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_app(Client, ApplicationId, Input)

View Source
Deletes an application.
Link to this function

delete_app(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_baidu_channel(Client, ApplicationId, Input)

View Source
Disables the Baidu channel for an application and deletes any existing settings for the channel.
Link to this function

delete_baidu_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_campaign(Client, ApplicationId, CampaignId, Input)

View Source
Deletes a campaign from an application.
Link to this function

delete_campaign(Client, ApplicationId, CampaignId, Input0, Options0)

View Source
Link to this function

delete_email_channel(Client, ApplicationId, Input)

View Source
Disables the email channel for an application and deletes any existing settings for the channel.
Link to this function

delete_email_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_email_template(Client, TemplateName, Input)

View Source
Deletes a message template for messages that were sent through the email channel.
Link to this function

delete_email_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

delete_endpoint(Client, ApplicationId, EndpointId, Input)

View Source
Deletes an endpoint from an application.
Link to this function

delete_endpoint(Client, ApplicationId, EndpointId, Input0, Options0)

View Source
Link to this function

delete_event_stream(Client, ApplicationId, Input)

View Source
Deletes the event stream for an application.
Link to this function

delete_event_stream(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_gcm_channel(Client, ApplicationId, Input)

View Source
Disables the GCM channel for an application and deletes any existing settings for the channel.
Link to this function

delete_gcm_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_in_app_template(Client, TemplateName, Input)

View Source
Deletes a message template for messages sent using the in-app message channel.
Link to this function

delete_in_app_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

delete_journey(Client, ApplicationId, JourneyId, Input)

View Source
Deletes a journey from an application.
Link to this function

delete_journey(Client, ApplicationId, JourneyId, Input0, Options0)

View Source
Link to this function

delete_push_template(Client, TemplateName, Input)

View Source
Deletes a message template for messages that were sent through a push notification channel.
Link to this function

delete_push_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

delete_recommender_configuration(Client, RecommenderId, Input)

View Source
Deletes an Amazon Pinpoint configuration for a recommender model.
Link to this function

delete_recommender_configuration(Client, RecommenderId, Input0, Options0)

View Source
Link to this function

delete_segment(Client, ApplicationId, SegmentId, Input)

View Source
Deletes a segment from an application.
Link to this function

delete_segment(Client, ApplicationId, SegmentId, Input0, Options0)

View Source
Link to this function

delete_sms_channel(Client, ApplicationId, Input)

View Source
Disables the SMS channel for an application and deletes any existing settings for the channel.
Link to this function

delete_sms_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_sms_template(Client, TemplateName, Input)

View Source
Deletes a message template for messages that were sent through the SMS channel.
Link to this function

delete_sms_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

delete_user_endpoints(Client, ApplicationId, UserId, Input)

View Source
Deletes all the endpoints that are associated with a specific user ID.
Link to this function

delete_user_endpoints(Client, ApplicationId, UserId, Input0, Options0)

View Source
Link to this function

delete_voice_channel(Client, ApplicationId, Input)

View Source
Disables the voice channel for an application and deletes any existing settings for the channel.
Link to this function

delete_voice_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_voice_template(Client, TemplateName, Input)

View Source
Deletes a message template for messages that were sent through the voice channel.
Link to this function

delete_voice_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

get_adm_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the ADM channel for an application.
Link to this function

get_adm_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_adm_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_apns_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the APNs channel for an application.
Link to this function

get_apns_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_apns_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_apns_sandbox_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the APNs sandbox channel for an application.
Link to this function

get_apns_sandbox_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_apns_sandbox_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_apns_voip_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the APNs VoIP channel for an application.
Link to this function

get_apns_voip_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_apns_voip_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_apns_voip_sandbox_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
Link to this function

get_apns_voip_sandbox_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_apns_voip_sandbox_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_app(Client, ApplicationId)

View Source
Retrieves information about an application.
Link to this function

get_app(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_app(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_application_date_range_kpi(Client, ApplicationId, KpiName)

View Source
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
Link to this function

get_application_date_range_kpi(Client, ApplicationId, KpiName, QueryMap, HeadersMap)

View Source
Link to this function

get_application_date_range_kpi(Client, ApplicationId, KpiName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_application_settings(Client, ApplicationId)

View Source
Retrieves information about the settings for an application.
Link to this function

get_application_settings(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_application_settings(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
Link to this function

get_apps(Client, QueryMap, HeadersMap)

View Source
Link to this function

get_apps(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_baidu_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the Baidu channel for an application.
Link to this function

get_baidu_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_baidu_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_campaign(Client, ApplicationId, CampaignId)

View Source
Retrieves information about the status, configuration, and other settings for a campaign.
Link to this function

get_campaign(Client, ApplicationId, CampaignId, QueryMap, HeadersMap)

View Source
Link to this function

get_campaign(Client, ApplicationId, CampaignId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_campaign_activities(Client, ApplicationId, CampaignId)

View Source
Retrieves information about all the activities for a campaign.
Link to this function

get_campaign_activities(Client, ApplicationId, CampaignId, QueryMap, HeadersMap)

View Source
Link to this function

get_campaign_activities(Client, ApplicationId, CampaignId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_campaign_date_range_kpi(Client, ApplicationId, CampaignId, KpiName)

View Source
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
Link to this function

get_campaign_date_range_kpi(Client, ApplicationId, CampaignId, KpiName, QueryMap, HeadersMap)

View Source
Link to this function

get_campaign_date_range_kpi(Client, ApplicationId, CampaignId, KpiName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_campaign_version(Client, ApplicationId, CampaignId, Version)

View Source
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
Link to this function

get_campaign_version(Client, ApplicationId, CampaignId, Version, QueryMap, HeadersMap)

View Source
Link to this function

get_campaign_version(Client, ApplicationId, CampaignId, Version, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_campaign_versions(Client, ApplicationId, CampaignId)

View Source
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
Link to this function

get_campaign_versions(Client, ApplicationId, CampaignId, QueryMap, HeadersMap)

View Source
Link to this function

get_campaign_versions(Client, ApplicationId, CampaignId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_campaigns(Client, ApplicationId)

View Source
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
Link to this function

get_campaigns(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_campaigns(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_channels(Client, ApplicationId)

View Source
Retrieves information about the history and status of each channel for an application.
Link to this function

get_channels(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_channels(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_email_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the email channel for an application.
Link to this function

get_email_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_email_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_email_template(Client, TemplateName)

View Source
Retrieves the content and settings of a message template for messages that are sent through the email channel.
Link to this function

get_email_template(Client, TemplateName, QueryMap, HeadersMap)

View Source
Link to this function

get_email_template(Client, TemplateName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_endpoint(Client, ApplicationId, EndpointId)

View Source
Retrieves information about the settings and attributes of a specific endpoint for an application.
Link to this function

get_endpoint(Client, ApplicationId, EndpointId, QueryMap, HeadersMap)

View Source
Link to this function

get_endpoint(Client, ApplicationId, EndpointId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_event_stream(Client, ApplicationId)

View Source
Retrieves information about the event stream settings for an application.
Link to this function

get_event_stream(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_event_stream(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_export_job(Client, ApplicationId, JobId)

View Source
Retrieves information about the status and settings of a specific export job for an application.
Link to this function

get_export_job(Client, ApplicationId, JobId, QueryMap, HeadersMap)

View Source
Link to this function

get_export_job(Client, ApplicationId, JobId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_export_jobs(Client, ApplicationId)

View Source
Retrieves information about the status and settings of all the export jobs for an application.
Link to this function

get_export_jobs(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_export_jobs(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_gcm_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the GCM channel for an application.
Link to this function

get_gcm_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_gcm_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_import_job(Client, ApplicationId, JobId)

View Source
Retrieves information about the status and settings of a specific import job for an application.
Link to this function

get_import_job(Client, ApplicationId, JobId, QueryMap, HeadersMap)

View Source
Link to this function

get_import_job(Client, ApplicationId, JobId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_import_jobs(Client, ApplicationId)

View Source
Retrieves information about the status and settings of all the import jobs for an application.
Link to this function

get_import_jobs(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_import_jobs(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_in_app_messages(Client, ApplicationId, EndpointId)

View Source
Retrieves the in-app messages targeted for the provided endpoint ID.
Link to this function

get_in_app_messages(Client, ApplicationId, EndpointId, QueryMap, HeadersMap)

View Source
Link to this function

get_in_app_messages(Client, ApplicationId, EndpointId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_in_app_template(Client, TemplateName)

View Source
Retrieves the content and settings of a message template for messages sent through the in-app channel.
Link to this function

get_in_app_template(Client, TemplateName, QueryMap, HeadersMap)

View Source
Link to this function

get_in_app_template(Client, TemplateName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_journey(Client, ApplicationId, JourneyId)

View Source
Retrieves information about the status, configuration, and other settings for a journey.
Link to this function

get_journey(Client, ApplicationId, JourneyId, QueryMap, HeadersMap)

View Source
Link to this function

get_journey(Client, ApplicationId, JourneyId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_journey_date_range_kpi(Client, ApplicationId, JourneyId, KpiName)

View Source
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
Link to this function

get_journey_date_range_kpi(Client, ApplicationId, JourneyId, KpiName, QueryMap, HeadersMap)

View Source
Link to this function

get_journey_date_range_kpi(Client, ApplicationId, JourneyId, KpiName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_journey_execution_activity_metrics(Client, ApplicationId, JourneyActivityId, JourneyId)

View Source
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
Link to this function

get_journey_execution_activity_metrics(Client, ApplicationId, JourneyActivityId, JourneyId, QueryMap, HeadersMap)

View Source
Link to this function

get_journey_execution_activity_metrics(Client, ApplicationId, JourneyActivityId, JourneyId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_journey_execution_metrics(Client, ApplicationId, JourneyId)

View Source
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
Link to this function

get_journey_execution_metrics(Client, ApplicationId, JourneyId, QueryMap, HeadersMap)

View Source
Link to this function

get_journey_execution_metrics(Client, ApplicationId, JourneyId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_journey_run_execution_activity_metrics(Client, ApplicationId, JourneyActivityId, JourneyId, RunId)

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

get_journey_run_execution_activity_metrics(Client, ApplicationId, JourneyActivityId, JourneyId, RunId, QueryMap, HeadersMap)

View Source
Link to this function

get_journey_run_execution_activity_metrics(Client, ApplicationId, JourneyActivityId, JourneyId, RunId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_journey_run_execution_metrics(Client, ApplicationId, JourneyId, RunId)

View Source
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
Link to this function

get_journey_run_execution_metrics(Client, ApplicationId, JourneyId, RunId, QueryMap, HeadersMap)

View Source
Link to this function

get_journey_run_execution_metrics(Client, ApplicationId, JourneyId, RunId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_journey_runs(Client, ApplicationId, JourneyId)

View Source
Provides information about the runs of a journey.
Link to this function

get_journey_runs(Client, ApplicationId, JourneyId, QueryMap, HeadersMap)

View Source
Link to this function

get_journey_runs(Client, ApplicationId, JourneyId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_push_template(Client, TemplateName)

View Source
Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
Link to this function

get_push_template(Client, TemplateName, QueryMap, HeadersMap)

View Source
Link to this function

get_push_template(Client, TemplateName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_recommender_configuration(Client, RecommenderId)

View Source
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
Link to this function

get_recommender_configuration(Client, RecommenderId, QueryMap, HeadersMap)

View Source
Link to this function

get_recommender_configuration(Client, RecommenderId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_recommender_configurations(Client)

View Source
Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
Link to this function

get_recommender_configurations(Client, QueryMap, HeadersMap)

View Source
Link to this function

get_recommender_configurations(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_segment(Client, ApplicationId, SegmentId)

View Source
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
Link to this function

get_segment(Client, ApplicationId, SegmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_segment(Client, ApplicationId, SegmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_segment_export_jobs(Client, ApplicationId, SegmentId)

View Source
Retrieves information about the status and settings of the export jobs for a segment.
Link to this function

get_segment_export_jobs(Client, ApplicationId, SegmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_segment_export_jobs(Client, ApplicationId, SegmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_segment_import_jobs(Client, ApplicationId, SegmentId)

View Source
Retrieves information about the status and settings of the import jobs for a segment.
Link to this function

get_segment_import_jobs(Client, ApplicationId, SegmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_segment_import_jobs(Client, ApplicationId, SegmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_segment_version(Client, ApplicationId, SegmentId, Version)

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

get_segment_version(Client, ApplicationId, SegmentId, Version, QueryMap, HeadersMap)

View Source
Link to this function

get_segment_version(Client, ApplicationId, SegmentId, Version, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_segment_versions(Client, ApplicationId, SegmentId)

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

get_segment_versions(Client, ApplicationId, SegmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_segment_versions(Client, ApplicationId, SegmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_segments(Client, ApplicationId)

View Source
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
Link to this function

get_segments(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_segments(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_sms_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the SMS channel for an application.
Link to this function

get_sms_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_sms_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_sms_template(Client, TemplateName)

View Source
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
Link to this function

get_sms_template(Client, TemplateName, QueryMap, HeadersMap)

View Source
Link to this function

get_sms_template(Client, TemplateName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_user_endpoints(Client, ApplicationId, UserId)

View Source
Retrieves information about all the endpoints that are associated with a specific user ID.
Link to this function

get_user_endpoints(Client, ApplicationId, UserId, QueryMap, HeadersMap)

View Source
Link to this function

get_user_endpoints(Client, ApplicationId, UserId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_voice_channel(Client, ApplicationId)

View Source
Retrieves information about the status and settings of the voice channel for an application.
Link to this function

get_voice_channel(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_voice_channel(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_voice_template(Client, TemplateName)

View Source
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
Link to this function

get_voice_template(Client, TemplateName, QueryMap, HeadersMap)

View Source
Link to this function

get_voice_template(Client, TemplateName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_journeys(Client, ApplicationId)

View Source
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
Link to this function

list_journeys(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

list_journeys(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_template_versions(Client, TemplateName, TemplateType)

View Source
Retrieves information about all the versions of a specific message template.
Link to this function

list_template_versions(Client, TemplateName, TemplateType, QueryMap, HeadersMap)

View Source
Link to this function

list_template_versions(Client, TemplateName, TemplateType, QueryMap, HeadersMap, Options0)

View Source
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
Link to this function

list_templates(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_templates(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

phone_number_validate(Client, Input)

View Source
Retrieves information about a phone number.
Link to this function

phone_number_validate(Client, Input0, Options0)

View Source
Link to this function

put_event_stream(Client, ApplicationId, Input)

View Source
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
Link to this function

put_event_stream(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

put_events(Client, ApplicationId, Input)

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

put_events(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

remove_attributes(Client, ApplicationId, AttributeType, Input)

View Source

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

Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.
Link to this function

remove_attributes(Client, ApplicationId, AttributeType, Input0, Options0)

View Source
Link to this function

send_messages(Client, ApplicationId, Input)

View Source
Creates and sends a direct message.
Link to this function

send_messages(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

send_o_t_p_message(Client, ApplicationId, Input)

View Source
Send an OTP message
Link to this function

send_o_t_p_message(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

send_users_messages(Client, ApplicationId, Input)

View Source
Creates and sends a message to a list of users.
Link to this function

send_users_messages(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source
Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_adm_channel(Client, ApplicationId, Input)

View Source
Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
Link to this function

update_adm_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_apns_channel(Client, ApplicationId, Input)

View Source
Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
Link to this function

update_apns_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_apns_sandbox_channel(Client, ApplicationId, Input)

View Source
Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
Link to this function

update_apns_sandbox_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_apns_voip_channel(Client, ApplicationId, Input)

View Source
Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
Link to this function

update_apns_voip_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_apns_voip_sandbox_channel(Client, ApplicationId, Input)

View Source
Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
Link to this function

update_apns_voip_sandbox_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_application_settings(Client, ApplicationId, Input)

View Source
Updates the settings for an application.
Link to this function

update_application_settings(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_baidu_channel(Client, ApplicationId, Input)

View Source
Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
Link to this function

update_baidu_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_campaign(Client, ApplicationId, CampaignId, Input)

View Source
Updates the configuration and other settings for a campaign.
Link to this function

update_campaign(Client, ApplicationId, CampaignId, Input0, Options0)

View Source
Link to this function

update_email_channel(Client, ApplicationId, Input)

View Source
Enables the email channel for an application or updates the status and settings of the email channel for an application.
Link to this function

update_email_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_email_template(Client, TemplateName, Input)

View Source
Updates an existing message template for messages that are sent through the email channel.
Link to this function

update_email_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

update_endpoint(Client, ApplicationId, EndpointId, Input)

View Source

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

You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
Link to this function

update_endpoint(Client, ApplicationId, EndpointId, Input0, Options0)

View Source
Link to this function

update_endpoints_batch(Client, ApplicationId, Input)

View Source

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

You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
Link to this function

update_endpoints_batch(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_gcm_channel(Client, ApplicationId, Input)

View Source
Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
Link to this function

update_gcm_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_in_app_template(Client, TemplateName, Input)

View Source
Updates an existing message template for messages sent through the in-app message channel.
Link to this function

update_in_app_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

update_journey(Client, ApplicationId, JourneyId, Input)

View Source
Updates the configuration and other settings for a journey.
Link to this function

update_journey(Client, ApplicationId, JourneyId, Input0, Options0)

View Source
Link to this function

update_journey_state(Client, ApplicationId, JourneyId, Input)

View Source
Pause, resume or cancels (stops) a journey.
Link to this function

update_journey_state(Client, ApplicationId, JourneyId, Input0, Options0)

View Source
Link to this function

update_push_template(Client, TemplateName, Input)

View Source
Updates an existing message template for messages that are sent through a push notification channel.
Link to this function

update_push_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

update_recommender_configuration(Client, RecommenderId, Input)

View Source
Updates an Amazon Pinpoint configuration for a recommender model.
Link to this function

update_recommender_configuration(Client, RecommenderId, Input0, Options0)

View Source
Link to this function

update_segment(Client, ApplicationId, SegmentId, Input)

View Source
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.
Link to this function

update_segment(Client, ApplicationId, SegmentId, Input0, Options0)

View Source
Link to this function

update_sms_channel(Client, ApplicationId, Input)

View Source
Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
Link to this function

update_sms_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_sms_template(Client, TemplateName, Input)

View Source
Updates an existing message template for messages that are sent through the SMS channel.
Link to this function

update_sms_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

update_template_active_version(Client, TemplateName, TemplateType, Input)

View Source
Changes the status of a specific version of a message template to active.
Link to this function

update_template_active_version(Client, TemplateName, TemplateType, Input0, Options0)

View Source
Link to this function

update_voice_channel(Client, ApplicationId, Input)

View Source
Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
Link to this function

update_voice_channel(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_voice_template(Client, TemplateName, Input)

View Source
Updates an existing message template for messages that are sent through the voice channel.
Link to this function

update_voice_template(Client, TemplateName, Input0, Options0)

View Source
Link to this function

verify_o_t_p_message(Client, ApplicationId, Input)

View Source
Verify an OTP
Link to this function

verify_o_t_p_message(Client, ApplicationId, Input0, Options0)

View Source