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.
Optional configuration of credentials, endpoint, and/or region.
A client for the service. You can call the service's operations using
svc is the name you've assigned
to the client. The available operations are listed in the
1 2 3 4 5 6 7 8 9 10 11 12 13 14
|create_configuration_set||Create a configuration set|
|create_configuration_set_event_destination||Create an event destination|
|create_dedicated_ip_pool||Create a new pool of dedicated IP addresses|
|create_deliverability_test_report||Create a new predictive inbox placement test|
|create_email_identity||Verifies an email identity for use with Amazon Pinpoint|
|delete_configuration_set||Delete an existing configuration set|
|delete_configuration_set_event_destination||Delete an event destination|
|delete_dedicated_ip_pool||Delete a dedicated IP pool|
|delete_email_identity||Deletes an email identity that you previously verified for use with Amazon Pinpoint|
|get_account||Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region|
|get_blacklist_reports||Retrieve a list of the blacklists that your dedicated IP addresses appear on|
|get_configuration_set||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|
|get_configuration_set_event_destinations||Retrieve a list of event destinations that are associated with a configuration set|
|get_dedicated_ip||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|
|get_dedicated_ips||List the dedicated IP addresses that are associated with your Amazon Pinpoint account|
|get_deliverability_dashboard_options||Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account|
|get_deliverability_test_report||Retrieve the results of a predictive inbox placement test|
|get_domain_deliverability_campaign||Retrieve all the deliverability data for a specific campaign|
|get_domain_statistics_report||Retrieve inbox placement and engagement rates for the domains that you use to send email|
|get_email_identity||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_configuration_sets||List all of the configuration sets associated with your Amazon Pinpoint account in the current region|
|list_dedicated_ip_pools||List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region|
|list_deliverability_test_reports||Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses|
|list_domain_deliverability_campaigns||Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range|
|list_email_identities||Returns a list of all of the email identities that are associated with your Amazon Pinpoint account|
|list_tags_for_resource||Retrieve a list of the tags (keys and values) that are associated with a specified resource|
|put_account_dedicated_ip_warmup_attributes||Enable or disable the automatic warm-up feature for dedicated IP addresses|
|put_account_sending_attributes||Enable or disable the ability of your account to send email|
|put_configuration_set_delivery_options||Associate a configuration set with a dedicated IP pool|
|put_configuration_set_reputation_options||Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region|
|put_configuration_set_sending_options||Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region|
|put_configuration_set_tracking_options||Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint|
|put_dedicated_ip_in_pool||Move a dedicated IP address to an existing dedicated IP pool|
|put_dedicated_ip_warmup_attributes||Put dedicated ip warmup attributes|
|put_deliverability_dashboard_option||Enable or disable the Deliverability dashboard for your Amazon Pinpoint account|
|put_email_identity_dkim_attributes||Used to enable or disable DKIM authentication for an email identity|
|put_email_identity_feedback_attributes||Used to enable or disable feedback forwarding for an identity|
|put_email_identity_mail_from_attributes||Used to enable or disable the custom Mail-From domain configuration for an email identity|
|send_email||Sends an email message|
|tag_resource||Add one or more tags (keys and values) to a specified resource|
|untag_resource||Remove one or more tags (keys and values) from a specified resource|
|update_configuration_set_event_destination||Update the configuration of an event destination for a configuration set|
1 2 3 4 5 6 7
## Not run: svc <- pinpointemail() svc$create_configuration_set( Foo = 123 ) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.