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

Amazon Pinpoint Email Service

Welcome to the Amazon Pinpoint Email API Reference.

This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.

Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

Link to this section Summary

Functions

Create a new pool of dedicated IP addresses.

Create a new predictive inbox placement test.

Verifies an email identity for use with Amazon Pinpoint.

Deletes an email identity that you previously verified for use with Amazon Pinpoint.

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

Retrieve a list of event destinations that are associated with a configuration set.

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.

Retrieve the results of a predictive inbox placement test.

Retrieve all the deliverability data for a specific campaign.

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.

Retrieve a list of the tags (keys and values) that are associated with a specified resource.

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Enable or disable the ability of your account to send email.

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

Move a dedicated IP address to an existing dedicated IP pool.

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.

Used to enable or disable DKIM authentication for an email identity.

Used to enable or disable feedback forwarding for an identity.

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Add one or more tags (keys and values) to a specified resource.

Remove one or more tags (keys and values) from a specified resource.

Link to this section Functions

Link to this function

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

View Source

Create a configuration set.

Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Link to this function

create_configuration_set_event_destination(client, configuration_set_name, input, options \\ [])

View Source

Create an event destination.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

A single configuration set can include more than one event destination.

Link to this function

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

View Source

Create a new pool of dedicated IP addresses.

A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.

Link to this function

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

View Source

Create a new predictive inbox placement test.

Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Link to this function

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

View Source

Verifies an email identity for use with Amazon Pinpoint.

In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.

When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

Link to this function

delete_configuration_set(client, configuration_set_name, input, options \\ [])

View Source

Delete an existing configuration set.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Link to this function

delete_configuration_set_event_destination(client, configuration_set_name, event_destination_name, input, options \\ [])

View Source

Delete an event destination.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Link to this function

delete_dedicated_ip_pool(client, pool_name, input, options \\ [])

View Source

Delete a dedicated IP pool.

Link to this function

delete_email_identity(client, email_identity, input, options \\ [])

View Source

Deletes an email identity that you previously verified for use with Amazon Pinpoint.

An identity can be either an email address or a domain name.

Link to this function

get_account(client, options \\ [])

View Source

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

Link to this function

get_blacklist_reports(client, blacklist_item_names, options \\ [])

View Source

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Link to this function

get_configuration_set(client, configuration_set_name, options \\ [])

View Source

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Link to this function

get_configuration_set_event_destinations(client, configuration_set_name, options \\ [])

View Source

Retrieve a list of event destinations that are associated with a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Link to this function

get_dedicated_ip(client, ip, options \\ [])

View Source

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

Link to this function

get_dedicated_ips(client, next_token \\ nil, page_size \\ nil, pool_name \\ nil, options \\ [])

View Source

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

Link to this function

get_deliverability_dashboard_options(client, options \\ [])

View Source

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account.

When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Link to this function

get_deliverability_test_report(client, report_id, options \\ [])

View Source

Retrieve the results of a predictive inbox placement test.

Link to this function

get_domain_deliverability_campaign(client, campaign_id, options \\ [])

View Source

Retrieve all the deliverability data for a specific campaign.

This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

Link to this function

get_domain_statistics_report(client, domain, end_date, start_date, options \\ [])

View Source

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Link to this function

get_email_identity(client, email_identity, options \\ [])

View Source

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

Link to this function

list_configuration_sets(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Link to this function

list_dedicated_ip_pools(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

Link to this function

list_deliverability_test_reports(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses.

For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

Link to this function

list_domain_deliverability_campaigns(client, subscribed_domain, end_date, next_token \\ nil, page_size \\ nil, start_date, options \\ [])

View Source

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range.

This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

Link to this function

list_email_identities(client, next_token \\ nil, page_size \\ nil, options \\ [])

View Source

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account.

An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Retrieve a list of the tags (keys and values) that are associated with a specified resource.

tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Link to this function

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

View Source

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Link to this function

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

View Source

Enable or disable the ability of your account to send email.

Link to this function

put_configuration_set_delivery_options(client, configuration_set_name, input, options \\ [])

View Source

Associate a configuration set with a dedicated IP pool.

You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

Link to this function

put_configuration_set_reputation_options(client, configuration_set_name, input, options \\ [])

View Source

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

Link to this function

put_configuration_set_sending_options(client, configuration_set_name, input, options \\ [])

View Source

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

Link to this function

put_configuration_set_tracking_options(client, configuration_set_name, input, options \\ [])

View Source

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

Link to this function

put_dedicated_ip_in_pool(client, ip, input, options \\ [])

View Source

Move a dedicated IP address to an existing dedicated IP pool.

The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.

The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

Link to this function

put_dedicated_ip_warmup_attributes(client, ip, input, options \\ [])

View Source
Link to this function

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

View Source

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account.

When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Link to this function

put_email_identity_dkim_attributes(client, email_identity, input, options \\ [])

View Source

Used to enable or disable DKIM authentication for an email identity.

Link to this function

put_email_identity_feedback_attributes(client, email_identity, input, options \\ [])

View Source

Used to enable or disable feedback forwarding for an identity.

This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Link to this function

put_email_identity_mail_from_attributes(client, email_identity, input, options \\ [])

View Source

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Link to this function

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

View Source

Sends an email message.

You can use the Amazon Pinpoint Email API to send two types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

Link to this function

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

View Source

Add one or more tags (keys and values) to a specified resource.

A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Link to this function

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

View Source

Remove one or more tags (keys and values) from a specified resource.

Link to this function

update_configuration_set_event_destination(client, configuration_set_name, event_destination_name, input, options \\ [])

View Source

Update the configuration of an event destination for a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.