AWS.Pinpoint (aws-elixir v0.8.0) View Source

Doc Engage API - Amazon Pinpoint API

Link to this section Summary

Functions

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

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 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 that were sent through a push notification channel.

Deletes an Amazon Pinpoint configuration for a recommender model.

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 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 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 information about the status, configuration, and other settings for 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 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 attributes, of the same attribute type, from all the endpoints that are associated with an application.

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.

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 the configuration and other settings for 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.

Link to this section Functions

Link to this function

create_app(client, input, options \\ [])

View Source

Creates an application.

Link to this function

create_campaign(client, application_id, input, options \\ [])

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_email_template(client, template_name, input, options \\ [])

View Source

Creates a message template for messages that are sent through the email channel.

Link to this function

create_export_job(client, application_id, input, options \\ [])

View Source

Creates an export job for an application.

Link to this function

create_import_job(client, application_id, input, options \\ [])

View Source

Creates an import job for an application.

Link to this function

create_journey(client, application_id, input, options \\ [])

View Source

Creates a journey for an application.

Link to this function

create_push_template(client, template_name, input, options \\ [])

View Source

Creates a message template for messages that are sent through a push notification channel.

Link to this function

create_recommender_configuration(client, input, options \\ [])

View Source

Creates an Amazon Pinpoint configuration for a recommender model.

Link to this function

create_segment(client, application_id, input, options \\ [])

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_sms_template(client, template_name, input, options \\ [])

View Source

Creates a message template for messages that are sent through the SMS channel.

Link to this function

create_voice_template(client, template_name, input, options \\ [])

View Source

Creates a message template for messages that are sent through the voice channel.

Link to this function

delete_adm_channel(client, application_id, input, options \\ [])

View Source

Disables the ADM channel for an application and deletes any existing settings for the channel.

Link to this function

delete_apns_channel(client, application_id, input, options \\ [])

View Source

Disables the APNs channel for an application and deletes any existing settings for the channel.

Link to this function

delete_apns_sandbox_channel(client, application_id, input, options \\ [])

View Source

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

Link to this function

delete_apns_voip_channel(client, application_id, input, options \\ [])

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_sandbox_channel(client, application_id, input, options \\ [])

View Source

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

Link to this function

delete_app(client, application_id, input, options \\ [])

View Source

Deletes an application.

Link to this function

delete_baidu_channel(client, application_id, input, options \\ [])

View Source

Disables the Baidu channel for an application and deletes any existing settings for the channel.

Link to this function

delete_campaign(client, application_id, campaign_id, input, options \\ [])

View Source

Deletes a campaign from an application.

Link to this function

delete_email_channel(client, application_id, input, options \\ [])

View Source

Disables the email channel for an application and deletes any existing settings for the channel.

Link to this function

delete_email_template(client, template_name, input, options \\ [])

View Source

Deletes a message template for messages that were sent through the email channel.

Link to this function

delete_endpoint(client, application_id, endpoint_id, input, options \\ [])

View Source

Deletes an endpoint from an application.

Link to this function

delete_event_stream(client, application_id, input, options \\ [])

View Source

Deletes the event stream for an application.

Link to this function

delete_gcm_channel(client, application_id, input, options \\ [])

View Source

Disables the GCM channel for an application and deletes any existing settings for the channel.

Link to this function

delete_journey(client, application_id, journey_id, input, options \\ [])

View Source

Deletes a journey from an application.

Link to this function

delete_push_template(client, template_name, input, options \\ [])

View Source

Deletes a message template for messages that were sent through a push notification channel.

Link to this function

delete_recommender_configuration(client, recommender_id, input, options \\ [])

View Source

Deletes an Amazon Pinpoint configuration for a recommender model.

Link to this function

delete_segment(client, application_id, segment_id, input, options \\ [])

View Source

Deletes a segment from an application.

Link to this function

delete_sms_channel(client, application_id, input, options \\ [])

View Source

Disables the SMS channel for an application and deletes any existing settings for the channel.

Link to this function

delete_sms_template(client, template_name, input, options \\ [])

View Source

Deletes a message template for messages that were sent through the SMS channel.

Link to this function

delete_user_endpoints(client, application_id, user_id, input, options \\ [])

View Source

Deletes all the endpoints that are associated with a specific user ID.

Link to this function

delete_voice_channel(client, application_id, input, options \\ [])

View Source

Disables the voice channel for an application and deletes any existing settings for the channel.

Link to this function

delete_voice_template(client, template_name, input, options \\ [])

View Source

Deletes a message template for messages that were sent through the voice channel.

Link to this function

get_adm_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_apns_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_apns_sandbox_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_apns_voip_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_apns_voip_sandbox_channel(client, application_id, options \\ [])

View Source

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

Link to this function

get_app(client, application_id, options \\ [])

View Source

Retrieves information about an application.

Link to this function

get_application_date_range_kpi(client, application_id, kpi_name, end_time \\ nil, next_token \\ nil, page_size \\ nil, start_time \\ nil, options \\ [])

View Source

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

Link to this function

get_application_settings(client, application_id, options \\ [])

View Source

Retrieves information about the settings for an application.

Link to this function

get_apps(client, page_size \\ nil, token \\ nil, options \\ [])

View Source

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

Link to this function

get_baidu_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_campaign(client, application_id, campaign_id, options \\ [])

View Source

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

Link to this function

get_campaign_activities(client, application_id, campaign_id, page_size \\ nil, token \\ nil, options \\ [])

View Source

Retrieves information about all the activities for a campaign.

Link to this function

get_campaign_date_range_kpi(client, application_id, campaign_id, kpi_name, end_time \\ nil, next_token \\ nil, page_size \\ nil, start_time \\ nil, options \\ [])

View Source

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

Link to this function

get_campaign_version(client, application_id, campaign_id, version, options \\ [])

View Source

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

Link to this function

get_campaign_versions(client, application_id, campaign_id, page_size \\ nil, token \\ nil, options \\ [])

View Source

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

Link to this function

get_campaigns(client, application_id, page_size \\ nil, token \\ nil, options \\ [])

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_channels(client, application_id, options \\ [])

View Source

Retrieves information about the history and status of each channel for an application.

Link to this function

get_email_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_email_template(client, template_name, version \\ nil, options \\ [])

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_endpoint(client, application_id, endpoint_id, options \\ [])

View Source

Retrieves information about the settings and attributes of a specific endpoint for an application.

Link to this function

get_event_stream(client, application_id, options \\ [])

View Source

Retrieves information about the event stream settings for an application.

Link to this function

get_export_job(client, application_id, job_id, options \\ [])

View Source

Retrieves information about the status and settings of a specific export job for an application.

Link to this function

get_export_jobs(client, application_id, page_size \\ nil, token \\ nil, options \\ [])

View Source

Retrieves information about the status and settings of all the export jobs for an application.

Link to this function

get_gcm_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_import_job(client, application_id, job_id, options \\ [])

View Source

Retrieves information about the status and settings of a specific import job for an application.

Link to this function

get_import_jobs(client, application_id, page_size \\ nil, token \\ nil, options \\ [])

View Source

Retrieves information about the status and settings of all the import jobs for an application.

Link to this function

get_journey(client, application_id, journey_id, options \\ [])

View Source

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

Link to this function

get_journey_date_range_kpi(client, application_id, journey_id, kpi_name, end_time \\ nil, next_token \\ nil, page_size \\ nil, start_time \\ nil, options \\ [])

View Source

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

Link to this function

get_journey_execution_activity_metrics(client, application_id, journey_activity_id, journey_id, next_token \\ nil, page_size \\ nil, options \\ [])

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_metrics(client, application_id, journey_id, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

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

Link to this function

get_push_template(client, template_name, version \\ nil, options \\ [])

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_recommender_configuration(client, recommender_id, options \\ [])

View Source

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

Link to this function

get_recommender_configurations(client, page_size \\ nil, token \\ nil, options \\ [])

View Source

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

Link to this function

get_segment(client, application_id, segment_id, options \\ [])

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_export_jobs(client, application_id, segment_id, page_size \\ nil, token \\ nil, options \\ [])

View Source

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

Link to this function

get_segment_import_jobs(client, application_id, segment_id, page_size \\ nil, token \\ nil, options \\ [])

View Source

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

Link to this function

get_segment_version(client, application_id, segment_id, version, options \\ [])

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_versions(client, application_id, segment_id, page_size \\ nil, token \\ nil, options \\ [])

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_segments(client, application_id, page_size \\ nil, token \\ nil, options \\ [])

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_sms_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_sms_template(client, template_name, version \\ nil, options \\ [])

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_user_endpoints(client, application_id, user_id, options \\ [])

View Source

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

Link to this function

get_voice_channel(client, application_id, options \\ [])

View Source

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

Link to this function

get_voice_template(client, template_name, version \\ nil, options \\ [])

View Source

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

Link to this function

list_journeys(client, application_id, page_size \\ nil, token \\ nil, options \\ [])

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_tags_for_resource(client, resource_arn, options \\ [])

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_template_versions(client, template_name, template_type, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

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

Link to this function

list_templates(client, next_token \\ nil, page_size \\ nil, prefix \\ nil, template_type \\ nil, options \\ [])

View Source

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

Link to this function

phone_number_validate(client, input, options \\ [])

View Source

Retrieves information about a phone number.

Link to this function

put_event_stream(client, application_id, input, options \\ [])

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_events(client, application_id, input, options \\ [])

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

remove_attributes(client, application_id, attribute_type, input, options \\ [])

View Source

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

Link to this function

send_messages(client, application_id, input, options \\ [])

View Source

Creates and sends a direct message.

Link to this function

send_users_messages(client, application_id, input, options \\ [])

View Source

Creates and sends a message to a list of users.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

update_adm_channel(client, application_id, input, options \\ [])

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_apns_channel(client, application_id, input, options \\ [])

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_sandbox_channel(client, application_id, input, options \\ [])

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_voip_channel(client, application_id, input, options \\ [])

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_sandbox_channel(client, application_id, input, options \\ [])

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_application_settings(client, application_id, input, options \\ [])

View Source

Updates the settings for an application.

Link to this function

update_baidu_channel(client, application_id, input, options \\ [])

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_campaign(client, application_id, campaign_id, input, options \\ [])

View Source

Updates the configuration and other settings for a campaign.

Link to this function

update_email_channel(client, application_id, input, options \\ [])

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_template(client, template_name, input, options \\ [])

View Source

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

Link to this function

update_endpoint(client, application_id, endpoint_id, input, options \\ [])

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_endpoints_batch(client, application_id, input, options \\ [])

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_gcm_channel(client, application_id, input, options \\ [])

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_journey(client, application_id, journey_id, input, options \\ [])

View Source

Updates the configuration and other settings for a journey.

Link to this function

update_journey_state(client, application_id, journey_id, input, options \\ [])

View Source

Pause, resume or cancels (stops) a journey.

Link to this function

update_push_template(client, template_name, input, options \\ [])

View Source

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

Link to this function

update_recommender_configuration(client, recommender_id, input, options \\ [])

View Source

Updates an Amazon Pinpoint configuration for a recommender model.

Link to this function

update_segment(client, application_id, segment_id, input, options \\ [])

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_sms_channel(client, application_id, input, options \\ [])

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_template(client, template_name, input, options \\ [])

View Source

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

Link to this function

update_template_active_version(client, template_name, template_type, input, options \\ [])

View Source

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

Link to this function

update_voice_channel(client, application_id, input, options \\ [])

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_template(client, template_name, input, options \\ [])

View Source

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