Pinpoint

create_app(create_application_request)
create_app(create_application_request, params::Dict{String,<:Any})

Creates an application.

Arguments

• create_application_request:

create_campaign(write_campaign_request, application-id)
create_campaign(write_campaign_request, application-id, params::Dict{String,<:Any})

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

Arguments

• write_campaign_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

create_email_template(email_template_request, template-name)
create_email_template(email_template_request, template-name, params::Dict{String,<:Any})

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

Arguments

• email_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

create_export_job(export_job_request, application-id)
create_export_job(export_job_request, application-id, params::Dict{String,<:Any})

Creates an export job for an application.

Arguments

• export_job_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

create_import_job(import_job_request, application-id)
create_import_job(import_job_request, application-id, params::Dict{String,<:Any})

Creates an import job for an application.

Arguments

• import_job_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

create_in_app_template(in_app_template_request, template-name)
create_in_app_template(in_app_template_request, template-name, params::Dict{String,<:Any})

Creates a new message template for messages using the in-app message channel.

Arguments

• in_app_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

create_journey(write_journey_request, application-id)
create_journey(write_journey_request, application-id, params::Dict{String,<:Any})

Creates a journey for an application.

Arguments

• write_journey_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

create_push_template(push_notification_template_request, template-name)
create_push_template(push_notification_template_request, template-name, params::Dict{String,<:Any})

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

Arguments

• push_notification_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

create_recommender_configuration(create_recommender_configuration)
create_recommender_configuration(create_recommender_configuration, params::Dict{String,<:Any})

Creates an Amazon Pinpoint configuration for a recommender model.

Arguments

• create_recommender_configuration:

create_segment(write_segment_request, application-id)
create_segment(write_segment_request, application-id, params::Dict{String,<:Any})

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.

Arguments

• write_segment_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

create_sms_template(smstemplate_request, template-name)
create_sms_template(smstemplate_request, template-name, params::Dict{String,<:Any})

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

Arguments

• smstemplate_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

create_voice_template(voice_template_request, template-name)
create_voice_template(voice_template_request, template-name, params::Dict{String,<:Any})

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

Arguments

• voice_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

delete_adm_channel(application-id)
delete_adm_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_apns_channel(application-id)
delete_apns_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_apns_sandbox_channel(application-id)
delete_apns_sandbox_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_apns_voip_channel(application-id)
delete_apns_voip_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_apns_voip_sandbox_channel(application-id)
delete_apns_voip_sandbox_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_app(application-id)
delete_app(application-id, params::Dict{String,<:Any})

Deletes an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_baidu_channel(application-id)
delete_baidu_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_campaign(application-id, campaign-id)
delete_campaign(application-id, campaign-id, params::Dict{String,<:Any})

Deletes a campaign from an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• campaign-id: The unique identifier for the campaign.

delete_email_channel(application-id)
delete_email_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_email_template(template-name)
delete_email_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

delete_endpoint(application-id, endpoint-id)
delete_endpoint(application-id, endpoint-id, params::Dict{String,<:Any})

Deletes an endpoint from an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• endpoint-id: The unique identifier for the endpoint.

delete_event_stream(application-id)
delete_event_stream(application-id, params::Dict{String,<:Any})

Deletes the event stream for an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_gcm_channel(application-id)
delete_gcm_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_in_app_template(template-name)
delete_in_app_template(template-name, params::Dict{String,<:Any})

Deletes a message template for messages sent using the in-app message channel.

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

delete_journey(application-id, journey-id)
delete_journey(application-id, journey-id, params::Dict{String,<:Any})

Deletes a journey from an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• journey-id: The unique identifier for the journey.

delete_push_template(template-name)
delete_push_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

delete_recommender_configuration(recommender-id)
delete_recommender_configuration(recommender-id, params::Dict{String,<:Any})

Deletes an Amazon Pinpoint configuration for a recommender model.

Arguments

• recommender-id: The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

delete_segment(application-id, segment-id)
delete_segment(application-id, segment-id, params::Dict{String,<:Any})

Deletes a segment from an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• segment-id: The unique identifier for the segment.

delete_sms_channel(application-id)
delete_sms_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_sms_template(template-name)
delete_sms_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

delete_user_endpoints(application-id, user-id)
delete_user_endpoints(application-id, user-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• user-id: The unique identifier for the user.

delete_voice_channel(application-id)
delete_voice_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

delete_voice_template(template-name)
delete_voice_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

get_adm_channel(application-id)
get_adm_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_apns_channel(application-id)
get_apns_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_apns_sandbox_channel(application-id)
get_apns_sandbox_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_apns_voip_channel(application-id)
get_apns_voip_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_apns_voip_sandbox_channel(application-id)
get_apns_voip_sandbox_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_app(application-id)
get_app(application-id, params::Dict{String,<:Any})

Retrieves information about an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_application_date_range_kpi(application-id, kpi-name)
get_application_date_range_kpi(application-id, kpi-name, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• kpi-name: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "end-time": The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
• "next-token": The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "start-time": The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

get_application_settings(application-id)
get_application_settings(application-id, params::Dict{String,<:Any})

Retrieves information about the settings for an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_apps()
get_apps(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_baidu_channel(application-id)
get_baidu_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_campaign(application-id, campaign-id)
get_campaign(application-id, campaign-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• campaign-id: The unique identifier for the campaign.

get_campaign_activities(application-id, campaign-id)
get_campaign_activities(application-id, campaign-id, params::Dict{String,<:Any})

Retrieves information about all the activities for a campaign.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• campaign-id: The unique identifier for the campaign.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_campaign_date_range_kpi(application-id, campaign-id, kpi-name)
get_campaign_date_range_kpi(application-id, campaign-id, kpi-name, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• campaign-id: The unique identifier for the campaign.
• kpi-name: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "end-time": The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
• "next-token": The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "start-time": The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

get_campaign_version(application-id, campaign-id, version)
get_campaign_version(application-id, campaign-id, version, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• campaign-id: The unique identifier for the campaign.
• version: The unique version number (Version property) for the campaign version.

get_campaign_versions(application-id, campaign-id)
get_campaign_versions(application-id, campaign-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• campaign-id: The unique identifier for the campaign.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_campaigns(application-id)
get_campaigns(application-id, params::Dict{String,<:Any})

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_channels(application-id)
get_channels(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_email_channel(application-id)
get_email_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_email_template(template-name)
get_email_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

get_endpoint(application-id, endpoint-id)
get_endpoint(application-id, endpoint-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• endpoint-id: The unique identifier for the endpoint.

get_event_stream(application-id)
get_event_stream(application-id, params::Dict{String,<:Any})

Retrieves information about the event stream settings for an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_export_job(application-id, job-id)
get_export_job(application-id, job-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• job-id: The unique identifier for the job.

get_export_jobs(application-id)
get_export_jobs(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_gcm_channel(application-id)
get_gcm_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_import_job(application-id, job-id)
get_import_job(application-id, job-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• job-id: The unique identifier for the job.

get_import_jobs(application-id)
get_import_jobs(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_in_app_messages(application-id, endpoint-id)
get_in_app_messages(application-id, endpoint-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• endpoint-id: The unique identifier for the endpoint.

get_in_app_template(template-name)
get_in_app_template(template-name, params::Dict{String,<:Any})

Retrieves the content and settings of a message template for messages sent through the in-app channel.

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

get_journey(application-id, journey-id)
get_journey(application-id, journey-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• journey-id: The unique identifier for the journey.

get_journey_date_range_kpi(application-id, journey-id, kpi-name)
get_journey_date_range_kpi(application-id, journey-id, kpi-name, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• journey-id: The unique identifier for the journey.
• kpi-name: The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "end-time": The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
• "next-token": The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "start-time": The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

get_journey_execution_activity_metrics(application-id, journey-activity-id, journey-id)
get_journey_execution_activity_metrics(application-id, journey-activity-id, journey-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• journey-activity-id: The unique identifier for the journey activity.
• journey-id: The unique identifier for the journey.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "next-token": The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

get_journey_execution_metrics(application-id, journey-id)
get_journey_execution_metrics(application-id, journey-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• journey-id: The unique identifier for the journey.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "next-token": The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

get_push_template(template-name)
get_push_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

get_recommender_configuration(recommender-id)
get_recommender_configuration(recommender-id, params::Dict{String,<:Any})

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

Arguments

• recommender-id: The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

get_recommender_configurations()
get_recommender_configurations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_segment(application-id, segment-id)
get_segment(application-id, segment-id, params::Dict{String,<:Any})

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• segment-id: The unique identifier for the segment.

get_segment_export_jobs(application-id, segment-id)
get_segment_export_jobs(application-id, segment-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• segment-id: The unique identifier for the segment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_segment_import_jobs(application-id, segment-id)
get_segment_import_jobs(application-id, segment-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• segment-id: The unique identifier for the segment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_segment_version(application-id, segment-id, version)
get_segment_version(application-id, segment-id, version, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• segment-id: The unique identifier for the segment.
• version: The unique version number (Version property) for the campaign version.

get_segment_versions(application-id, segment-id)
get_segment_versions(application-id, segment-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• segment-id: The unique identifier for the segment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_segments(application-id)
get_segments(application-id, params::Dict{String,<:Any})

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

get_sms_channel(application-id)
get_sms_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_sms_template(template-name)
get_sms_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

get_user_endpoints(application-id, user-id)
get_user_endpoints(application-id, user-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• user-id: The unique identifier for the user.

get_voice_channel(application-id)
get_voice_channel(application-id, params::Dict{String,<:Any})

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

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

get_voice_template(template-name)
get_voice_template(template-name, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

list_journeys(application-id)
list_journeys(application-id, params::Dict{String,<:Any})

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

Arguments

• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "token": The NextToken string that specifies which page of results to return in a paginated response.

list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

Arguments

• resource-arn: The Amazon Resource Name (ARN) of the resource.

list_template_versions(template-name, template-type)
list_template_versions(template-name, template-type, params::Dict{String,<:Any})

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

Arguments

• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
• template-type: The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "next-token": The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

list_templates()
list_templates(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "next-token": The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "page-size": The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
• "prefix": The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.
• "template-type": The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

phone_number_validate(number_validate_request)
phone_number_validate(number_validate_request, params::Dict{String,<:Any})

Retrieves information about a phone number.

Arguments

• number_validate_request:

put_event_stream(write_event_stream, application-id)
put_event_stream(write_event_stream, application-id, params::Dict{String,<:Any})

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

Arguments

• write_event_stream:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

put_events(events_request, application-id)
put_events(events_request, application-id, params::Dict{String,<:Any})

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

Arguments

• events_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

remove_attributes(update_attributes_request, application-id, attribute-type)
remove_attributes(update_attributes_request, application-id, attribute-type, params::Dict{String,<:Any})

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

Arguments

• update_attributes_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• attribute-type: The type of attribute or attributes to remove. Valid values are: endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel. endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart. endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

send_messages(message_request, application-id)
send_messages(message_request, application-id, params::Dict{String,<:Any})

Creates and sends a direct message.

Arguments

• message_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

send_otpmessage(send_otpmessage_request_parameters, application-id)
send_otpmessage(send_otpmessage_request_parameters, application-id, params::Dict{String,<:Any})

Send an OTP message

Arguments

• send_otpmessage_request_parameters:
• application-id: The unique ID of your Amazon Pinpoint application.

send_users_messages(send_users_message_request, application-id)
send_users_messages(send_users_message_request, application-id, params::Dict{String,<:Any})

Creates and sends a message to a list of users.

Arguments

• send_users_message_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

tag_resource(tags_model, resource-arn)
tag_resource(tags_model, resource-arn, params::Dict{String,<:Any})

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

Arguments

• tags_model:
• resource-arn: The Amazon Resource Name (ARN) of the resource.

untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

• resource-arn: The Amazon Resource Name (ARN) of the resource.
• tag_keys: The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

update_adm_channel(admchannel_request, application-id)
update_adm_channel(admchannel_request, application-id, params::Dict{String,<:Any})

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

Arguments

• admchannel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_apns_channel(apnschannel_request, application-id)
update_apns_channel(apnschannel_request, application-id, params::Dict{String,<:Any})

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

Arguments

• apnschannel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_apns_sandbox_channel(apnssandbox_channel_request, application-id)
update_apns_sandbox_channel(apnssandbox_channel_request, application-id, params::Dict{String,<:Any})

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

Arguments

• apnssandbox_channel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_apns_voip_channel(apnsvoip_channel_request, application-id)
update_apns_voip_channel(apnsvoip_channel_request, application-id, params::Dict{String,<:Any})

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

Arguments

• apnsvoip_channel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_apns_voip_sandbox_channel(apnsvoip_sandbox_channel_request, application-id)
update_apns_voip_sandbox_channel(apnsvoip_sandbox_channel_request, application-id, params::Dict{String,<:Any})

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

Arguments

• apnsvoip_sandbox_channel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_application_settings(write_application_settings_request, application-id)
update_application_settings(write_application_settings_request, application-id, params::Dict{String,<:Any})

Updates the settings for an application.

Arguments

• write_application_settings_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_baidu_channel(baidu_channel_request, application-id)
update_baidu_channel(baidu_channel_request, application-id, params::Dict{String,<:Any})

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

Arguments

• baidu_channel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_campaign(write_campaign_request, application-id, campaign-id)
update_campaign(write_campaign_request, application-id, campaign-id, params::Dict{String,<:Any})

Updates the configuration and other settings for a campaign.

Arguments

• write_campaign_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• campaign-id: The unique identifier for the campaign.

update_email_channel(email_channel_request, application-id)
update_email_channel(email_channel_request, application-id, params::Dict{String,<:Any})

Enables the email channel for an application or updates the status and settings of the email channel for an application.

Arguments

• email_channel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_email_template(email_template_request, template-name)
update_email_template(email_template_request, template-name, params::Dict{String,<:Any})

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

Arguments

• email_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "create-new-version": Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

update_endpoint(endpoint_request, application-id, endpoint-id)
update_endpoint(endpoint_request, application-id, endpoint-id, params::Dict{String,<:Any})

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.

Arguments

• endpoint_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• endpoint-id: The unique identifier for the endpoint.

update_endpoints_batch(endpoint_batch_request, application-id)
update_endpoints_batch(endpoint_batch_request, application-id, params::Dict{String,<:Any})

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.

Arguments

• endpoint_batch_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_gcm_channel(gcmchannel_request, application-id)
update_gcm_channel(gcmchannel_request, application-id, params::Dict{String,<:Any})

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

Arguments

• gcmchannel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_in_app_template(in_app_template_request, template-name)
update_in_app_template(in_app_template_request, template-name, params::Dict{String,<:Any})

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

Arguments

• in_app_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "create-new-version": Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

update_journey(write_journey_request, application-id, journey-id)
update_journey(write_journey_request, application-id, journey-id, params::Dict{String,<:Any})

Updates the configuration and other settings for a journey.

Arguments

• write_journey_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• journey-id: The unique identifier for the journey.

update_journey_state(journey_state_request, application-id, journey-id)
update_journey_state(journey_state_request, application-id, journey-id, params::Dict{String,<:Any})

Cancels (stops) an active journey.

Arguments

• journey_state_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• journey-id: The unique identifier for the journey.

update_push_template(push_notification_template_request, template-name)
update_push_template(push_notification_template_request, template-name, params::Dict{String,<:Any})

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

Arguments

• push_notification_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "create-new-version": Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

update_recommender_configuration(update_recommender_configuration, recommender-id)
update_recommender_configuration(update_recommender_configuration, recommender-id, params::Dict{String,<:Any})

Updates an Amazon Pinpoint configuration for a recommender model.

Arguments

• update_recommender_configuration:
• recommender-id: The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.

update_segment(write_segment_request, application-id, segment-id)
update_segment(write_segment_request, application-id, segment-id, params::Dict{String,<:Any})

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.

Arguments

• write_segment_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
• segment-id: The unique identifier for the segment.

update_sms_channel(smschannel_request, application-id)
update_sms_channel(smschannel_request, application-id, params::Dict{String,<:Any})

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

Arguments

• smschannel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_sms_template(smstemplate_request, template-name)
update_sms_template(smstemplate_request, template-name, params::Dict{String,<:Any})

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

Arguments

• smstemplate_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "create-new-version": Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

update_template_active_version(template_active_version_request, template-name, template-type)
update_template_active_version(template_active_version_request, template-name, template-type, params::Dict{String,<:Any})

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

Arguments

• template_active_version_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
• template-type: The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.

update_voice_channel(voice_channel_request, application-id)
update_voice_channel(voice_channel_request, application-id, params::Dict{String,<:Any})

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

Arguments

• voice_channel_request:
• application-id: The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

update_voice_template(voice_template_request, template-name)
update_voice_template(voice_template_request, template-name, params::Dict{String,<:Any})

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

Arguments

• voice_template_request:
• template-name: The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "create-new-version": Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
• "version": The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.

verify_otpmessage(verify_otpmessage_request_parameters, application-id)
verify_otpmessage(verify_otpmessage_request_parameters, application-id, params::Dict{String,<:Any})

Verify an OTP

Arguments

• verify_otpmessage_request_parameters:
• application-id: The unique ID of your Amazon Pinpoint application.