Expand description
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.
If you’re using the service, you’re probably looking for PinpointEmailClient and PinpointEmail.
Structs§
- Blacklist
Entry An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
- Body
Represents the body of the email message.
- Cloud
Watch Destination An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
- Cloud
Watch Dimension Configuration An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.
- Content
An object that represents the content of the email, and optionally a character set specification.
- Create
Configuration SetEvent Destination Request A request to add an event destination to a configuration set.
- Create
Configuration SetEvent Destination Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Create
Configuration SetRequest A request to create a configuration set.
- Create
Configuration SetResponse An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Create
Dedicated IpPool Request A request to create a new dedicated IP pool.
- Create
Dedicated IpPool Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Create
Deliverability Test Report Request A request to perform a 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
GetDeliverabilityTestReportoperation to view the results of the test.- Create
Deliverability Test Report Response Information about the predictive inbox placement test that you created.
- Create
Email Identity Request A request to begin the verification process for an email identity (an email address or domain).
- Create
Email Identity Response If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain.
If the email identity is an email address, this object is empty.
- Daily
Volume An object that contains information about the volume of email sent on each day of the analysis period.
- Dedicated
Ip Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.
- Delete
Configuration SetEvent Destination Request A request to delete an event destination from a configuration set.
- Delete
Configuration SetEvent Destination Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Delete
Configuration SetRequest A request to delete a configuration set.
- Delete
Configuration SetResponse An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Delete
Dedicated IpPool Request A request to delete a dedicated IP pool.
- Delete
Dedicated IpPool Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Delete
Email Identity Request A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.
- Delete
Email Identity Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Deliverability
Test Report An object that contains metadata related to a predictive inbox placement test.
- Delivery
Options Used to associate a configuration set with a dedicated IP pool.
- Destination
An object that describes the recipients for an email.
- Dkim
Attributes An object that contains information about the DKIM configuration for an email identity.
- Domain
Deliverability Campaign An object that contains 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 (
PutDeliverabilityDashboardOptionoperation).- Domain
Deliverability Tracking Option An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
- Domain
IspPlacement An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
- Email
Content An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.
- 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.
- Event
Destination Definition An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.
- GetAccount
Request A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.
- GetAccount
Response A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
- GetBlacklist
Reports Request A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
- GetBlacklist
Reports Response An object that contains information about blacklist events.
- GetConfiguration
SetEvent Destinations Request A request to obtain information about the event destinations for a configuration set.
- GetConfiguration
SetEvent Destinations Response Information about an event destination for a configuration set.
- GetConfiguration
SetRequest A request to obtain information about a configuration set.
- GetConfiguration
SetResponse Information about a configuration set.
- GetDedicated
IpRequest A request to obtain more information about a dedicated IP address.
- GetDedicated
IpResponse Information about a dedicated IP address.
- GetDedicated
IpsRequest A request to obtain more information about dedicated IP pools.
- GetDedicated
IpsResponse Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.
- GetDeliverability
Dashboard Options Request 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.
- GetDeliverability
Dashboard Options Response An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.
- GetDeliverability
Test Report Request A request to retrieve the results of a predictive inbox placement test.
- GetDeliverability
Test Report Response The results of the predictive inbox placement test.
- GetDomain
Deliverability Campaign Request 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 (
PutDeliverabilityDashboardOptionoperation).- GetDomain
Deliverability Campaign Response An object that contains 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 (
PutDeliverabilityDashboardOptionoperation).- GetDomain
Statistics Report Request A request to obtain deliverability metrics for a domain.
- GetDomain
Statistics Report Response An object that includes statistics that are related to the domain that you specified.
- GetEmail
Identity Request A request to return details about an email identity.
- GetEmail
Identity Response Details about an email identity.
- Identity
Info Information about an email identity.
- Inbox
Placement Tracking Option An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain (
PutDeliverabilityDashboardOptionoperation).- IspPlacement
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
- Kinesis
Firehose Destination An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
- List
Configuration Sets Request A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.
- List
Configuration Sets Response A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.
- List
Dedicated IpPools Request A request to obtain a list of dedicated IP pools.
- List
Dedicated IpPools Response A list of dedicated IP pools.
- List
Deliverability Test Reports Request A request to list all of the predictive inbox placement tests that you've performed.
- List
Deliverability Test Reports Response A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
- List
Domain Deliverability Campaigns Request 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 (
PutDeliverabilityDashboardOptionoperation) for the domain.- List
Domain Deliverability Campaigns Response An array of objects that provide 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 (
PutDeliverabilityDashboardOptionoperation) for the domain.- List
Email Identities Request A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.
- List
Email Identities Response A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.
- List
Tags ForResource Request - List
Tags ForResource Response - Mail
From Attributes A list of attributes that are associated with a MAIL FROM domain.
- Message
Represents the email message that you're sending. The
Messageobject consists of a subject line and a message body.- Message
Tag Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
- Overall
Volume An object that contains information about email that was sent from the selected domain.
- Pinpoint
Destination An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
- Pinpoint
Email Client - A client for the Pinpoint Email API.
- Placement
Statistics An object that contains inbox placement data for an email provider.
- PutAccount
Dedicated IpWarmup Attributes Request A request to enable or disable the automatic IP address warm-up feature.
- PutAccount
Dedicated IpWarmup Attributes Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutAccount
Sending Attributes Request A request to change the ability of your account to send email.
- PutAccount
Sending Attributes Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutConfiguration
SetDelivery Options Request A request to associate a configuration set with a dedicated IP pool.
- PutConfiguration
SetDelivery Options Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutConfiguration
SetReputation Options Request A request to enable or disable tracking of reputation metrics for a configuration set.
- PutConfiguration
SetReputation Options Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutConfiguration
SetSending Options Request A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.
- PutConfiguration
SetSending Options Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutConfiguration
SetTracking Options Request A request to add a custom domain for tracking open and click events to a configuration set.
- PutConfiguration
SetTracking Options Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutDedicated
IpIn Pool Request A request to move a dedicated IP address to a dedicated IP pool.
- PutDedicated
IpIn Pool Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutDedicated
IpWarmup Attributes Request A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.
- PutDedicated
IpWarmup Attributes Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutDeliverability
Dashboard Option Request 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.
- PutDeliverability
Dashboard Option Response A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
- PutEmail
Identity Dkim Attributes Request A request to enable or disable DKIM signing of email that you send from an email identity.
- PutEmail
Identity Dkim Attributes Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutEmail
Identity Feedback Attributes Request A request to set the attributes that control how bounce and complaint events are processed.
- PutEmail
Identity Feedback Attributes Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- PutEmail
Identity Mail From Attributes Request A request to configure the custom MAIL FROM domain for a verified identity.
- PutEmail
Identity Mail From Attributes Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- RawMessage
The raw email message.
- Reputation
Options Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
- Send
Email Request A request to send an email message.
- Send
Email Response A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.
- Send
Quota An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
- Sending
Options Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
- SnsDestination
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
- Tag
An object that defines the tags that are associated with a 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 a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
-
Tag keys and values are case sensitive.
-
For each associated resource, each tag key must be unique and it can have only one value.
-
The
aws:prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource. -
You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.
-
- TagResource
Request - TagResource
Response - Template
- Tracking
Options An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.
- Untag
Resource Request - Untag
Resource Response - Update
Configuration SetEvent Destination Request A request to change the settings for an event destination for a configuration set.
- Update
Configuration SetEvent Destination Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Volume
Statistics An object that contains information about the amount of email that was delivered to recipients.
Enums§
- Create
Configuration SetError - Errors returned by CreateConfigurationSet
- Create
Configuration SetEvent Destination Error - Errors returned by CreateConfigurationSetEventDestination
- Create
Dedicated IpPool Error - Errors returned by CreateDedicatedIpPool
- Create
Deliverability Test Report Error - Errors returned by CreateDeliverabilityTestReport
- Create
Email Identity Error - Errors returned by CreateEmailIdentity
- Delete
Configuration SetError - Errors returned by DeleteConfigurationSet
- Delete
Configuration SetEvent Destination Error - Errors returned by DeleteConfigurationSetEventDestination
- Delete
Dedicated IpPool Error - Errors returned by DeleteDedicatedIpPool
- Delete
Email Identity Error - Errors returned by DeleteEmailIdentity
- GetAccount
Error - Errors returned by GetAccount
- GetBlacklist
Reports Error - Errors returned by GetBlacklistReports
- GetConfiguration
SetError - Errors returned by GetConfigurationSet
- GetConfiguration
SetEvent Destinations Error - Errors returned by GetConfigurationSetEventDestinations
- GetDedicated
IpError - Errors returned by GetDedicatedIp
- GetDedicated
IpsError - Errors returned by GetDedicatedIps
- GetDeliverability
Dashboard Options Error - Errors returned by GetDeliverabilityDashboardOptions
- GetDeliverability
Test Report Error - Errors returned by GetDeliverabilityTestReport
- GetDomain
Deliverability Campaign Error - Errors returned by GetDomainDeliverabilityCampaign
- GetDomain
Statistics Report Error - Errors returned by GetDomainStatisticsReport
- GetEmail
Identity Error - Errors returned by GetEmailIdentity
- List
Configuration Sets Error - Errors returned by ListConfigurationSets
- List
Dedicated IpPools Error - Errors returned by ListDedicatedIpPools
- List
Deliverability Test Reports Error - Errors returned by ListDeliverabilityTestReports
- List
Domain Deliverability Campaigns Error - Errors returned by ListDomainDeliverabilityCampaigns
- List
Email Identities Error - Errors returned by ListEmailIdentities
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutAccount
Dedicated IpWarmup Attributes Error - Errors returned by PutAccountDedicatedIpWarmupAttributes
- PutAccount
Sending Attributes Error - Errors returned by PutAccountSendingAttributes
- PutConfiguration
SetDelivery Options Error - Errors returned by PutConfigurationSetDeliveryOptions
- PutConfiguration
SetReputation Options Error - Errors returned by PutConfigurationSetReputationOptions
- PutConfiguration
SetSending Options Error - Errors returned by PutConfigurationSetSendingOptions
- PutConfiguration
SetTracking Options Error - Errors returned by PutConfigurationSetTrackingOptions
- PutDedicated
IpIn Pool Error - Errors returned by PutDedicatedIpInPool
- PutDedicated
IpWarmup Attributes Error - Errors returned by PutDedicatedIpWarmupAttributes
- PutDeliverability
Dashboard Option Error - Errors returned by PutDeliverabilityDashboardOption
- PutEmail
Identity Dkim Attributes Error - Errors returned by PutEmailIdentityDkimAttributes
- PutEmail
Identity Feedback Attributes Error - Errors returned by PutEmailIdentityFeedbackAttributes
- PutEmail
Identity Mail From Attributes Error - Errors returned by PutEmailIdentityMailFromAttributes
- Send
Email Error - Errors returned by SendEmail
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Configuration SetEvent Destination Error - Errors returned by UpdateConfigurationSetEventDestination
Traits§
- Pinpoint
Email - Trait representing the capabilities of the Pinpoint Email API. Pinpoint Email clients implement this trait.