Expand description
Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2, including supported operations, data types, parameters, and schemas.
Amazon SES is an AWS service that you can use to send email messages to your customers.
If you're new to Amazon SES API v2, you might find it helpful to also review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.
The Amazon SES API v2 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 SesV2Client and SesV2.
Structs§
- Account
Details An object that contains information about your account details.
- 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.
- Bulk
Email Content An object that contains the body of the message. You can specify a template message.
- Bulk
Email Entry - Bulk
Email Entry Result The result of the
SendBulkEmailoperation of each specifiedBulkEmailEntry.- 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 email events to Amazon CloudWatch.
- Contact
A contact is the end-user who is receiving the email.
- Contact
List A list that contains contacts that have subscribed to a particular topic or topics.
- Contact
List Destination An object that contains details about the action of a contact list.
- 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
Contact List Request - Create
Contact List Response - Create
Contact Request - Create
Contact Response - Create
Custom Verification Email Template Request Represents a request to create a custom verification email template.
- Create
Custom Verification Email Template Response If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
- 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. We send that message to special email addresses spread across several major email providers around the world. The test takes about 24 hours to complete. When the test is complete, 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 Policy Request Represents a request to create a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
- Create
Email Identity Policy Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- 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 information about the DKIM verification status for the domain.
If the email identity is an email address, this object is empty.
- Create
Email Template Request Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
- Create
Email Template Response If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
- Create
Import JobRequest Represents a request to create an import job from a data source for a data destination.
- Create
Import JobResponse An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Custom
Verification Email Template Metadata Contains information about a custom verification email template.
- 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 SES account.
To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.
- 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
Contact List Request - Delete
Contact List Response - Delete
Contact Request - Delete
Contact Response - Delete
Custom Verification Email Template Request Represents a request to delete an existing custom verification email template.
- Delete
Custom Verification Email Template Response If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
- 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 Policy Request Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
- Delete
Email Identity Policy 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 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.
- Delete
Email Template Request Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.
- Delete
Email Template Response If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
- Delete
Suppressed Destination Request A request to remove an email address from the suppression list for your account.
- Delete
Suppressed Destination 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 authentication status for an email identity.
Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity
- Dkim
Signing Attributes An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).
- 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.
- Email
Template Content The content of the email, composed of a subject line, an HTML part, and a text-only part.
- Email
Template Metadata Contains information about an email template.
- Event
Destination In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. 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.
- Failure
Info An object that contains the failure details about an import job.
- GetAccount
Request A request to obtain information about the email-sending capabilities of your Amazon SES account.
- GetAccount
Response A list of details about the email-sending capabilities of your Amazon SES 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.
- GetContact
List Request - GetContact
List Response - GetContact
Request - GetContact
Response - GetCustom
Verification Email Template Request Represents a request to retrieve an existing custom verification email template.
- GetCustom
Verification Email Template Response The following elements are returned by the service.
- 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 AWS account.
- GetDeliverability
Dashboard Options Request Retrieve information about the status of the Deliverability dashboard for your AWS account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for your domains. 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 SES and other AWS services. 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.
- 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.
- 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 Policies Request A request to return the policies of an email identity.
- GetEmail
Identity Policies Response Identity policies associated with email identity.
- GetEmail
Identity Request A request to return details about an email identity.
- GetEmail
Identity Response Details about an email identity.
- GetEmail
Template Request Represents a request to display the template object (which includes the subject line, HTML part and text part) for the template you specify.
- GetEmail
Template Response The following element is returned by the service.
- GetImport
JobRequest Represents a request for information about an import job using the import job ID.
- GetImport
JobResponse An HTTP 200 response if the request succeeds, or an error message if the request fails.
- GetSuppressed
Destination Request A request to retrieve information about an email address that's on the suppression list for your account.
- GetSuppressed
Destination Response Information about the suppressed email address.
- Identity
Info Information about an email identity.
- Import
Data Source An object that contains details about the data source of the import job.
- Import
Destination An object that contains details about the resource destination the import job is going to target.
- Import
JobSummary A summary of the import job.
- 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.
- 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 SES account in the current AWS Region.
- List
Configuration Sets Response A list of configuration sets in your Amazon SES account in the current AWS Region.
- List
Contact Lists Request - List
Contact Lists Response - List
Contacts Filter A filter that can be applied to a list of contacts.
- List
Contacts Request - List
Contacts Response - List
Custom Verification Email Templates Request Represents a request to list the existing custom verification email templates for your account.
- List
Custom Verification Email Templates Response The following elements are returned by the service.
- 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.
- 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 for the domain.
- List
Email Identities Request A request to list all of the email identities associated with your AWS 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, regardless of whether or not those identities were successfully verified.
- List
Email Templates Request Represents a request to list the email templates present in your Amazon SES account in the current AWS Region. For more information, see the Amazon SES Developer Guide.
- List
Email Templates Response The following elements are returned by the service.
- List
Import Jobs Request Represents a request to list all of the import jobs for a data destination within the specified maximum number of import jobs.
- List
Import Jobs Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- List
Management Options An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
- List
Suppressed Destinations Request A request to obtain a list of email destinations that are on the suppression list for your account.
- List
Suppressed Destinations Response A list of suppressed email addresses.
- 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 an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
- 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
Details Request A request to submit new account details.
- PutAccount
Details 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.
- PutAccount
Suppression Attributes Request A request to change your account's suppression preferences.
- PutAccount
Suppression 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 SES 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
SetSuppression Options Request A request to change the account suppression list preferences for a specific configuration set.
- PutConfiguration
SetSuppression 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. 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 SES API v2. 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 SES and other AWS services. 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.
- PutEmail
Identity Configuration SetAttributes Request A request to associate a configuration set with an email identity.
- PutEmail
Identity Configuration SetAttributes Response If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
- 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 Dkim Signing Attributes Request A request to change the DKIM attributes for an email identity.
- PutEmail
Identity Dkim Signing Attributes Response If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- 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.
- PutSuppressed
Destination Request A request to add an email destination to the suppression list for your account.
- PutSuppressed
Destination Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- RawMessage
Represents the raw content of an email message.
- Replacement
Email Content The
ReplaceEmailContentobject to be used for a specificBulkEmailEntry. TheReplacementTemplatecan be specified within this object.- Replacement
Template An object which contains
ReplacementTemplateDatato be used for a specificBulkEmailEntry.- Reputation
Options Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
- Review
Details An object that contains information about your account details review.
- Send
Bulk Email Request Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
- Send
Bulk Email Response The following data is returned in JSON format by the service.
- Send
Custom Verification Email Request Represents a request to send a custom verification email to a specified recipient.
- Send
Custom Verification Email Response The following element is returned by the service.
- Send
Email Request Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
- Send
Email Response A unique message ID that you receive when an email is accepted for sending.
- Send
Quota An object that contains information about the per-day and per-second sending limits for your Amazon SES 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.
- SesV2
Client - A client for the Amazon SES V2 API.
- 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.
- Suppressed
Destination An object that contains information about an email address that is on the suppression list for your account.
- Suppressed
Destination Attributes An object that contains additional attributes that are related an email address that is on the suppression list for your account.
- Suppressed
Destination Summary A summary that describes the suppressed email address.
- Suppression
Attributes An object that contains information about the email address suppression preferences for your account in the current AWS Region.
- Suppression
List Destination An object that contains details about the action of suppression list.
- Suppression
Options An object that contains information about the suppression list preferences for your account.
- 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. 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
An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to define, save, and reuse in email messages that you send.
- Test
Render Email Template Request >Represents a request to create a preview of the MIME content of an email when provided with a template and a set of replacement data.
- Test
Render Email Template Response The following element is returned by the service.
- Topic
An interest group, theme, or label within a list. Lists can have multiple topics.
- Topic
Filter Used for filtering by a specific topic preference.
- Topic
Preference The contact's preference for being opted-in to or opted-out of a topic.
- Tracking
Options An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 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 the Amazon SES 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.
- Update
Contact List Request - Update
Contact List Response - Update
Contact Request - Update
Contact Response - Update
Custom Verification Email Template Request Represents a request to update an existing custom verification email template.
- Update
Custom Verification Email Template Response If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
- Update
Email Identity Policy Request Represents a request to update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
- Update
Email Identity Policy Response An HTTP 200 response if the request succeeds, or an error message if the request fails.
- Update
Email Template Request Represents a request to update an email template. For more information, see the Amazon SES Developer Guide.
- Update
Email Template Response If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
- 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
Contact Error - Errors returned by CreateContact
- Create
Contact List Error - Errors returned by CreateContactList
- Create
Custom Verification Email Template Error - Errors returned by CreateCustomVerificationEmailTemplate
- 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
- Create
Email Identity Policy Error - Errors returned by CreateEmailIdentityPolicy
- Create
Email Template Error - Errors returned by CreateEmailTemplate
- Create
Import JobError - Errors returned by CreateImportJob
- Delete
Configuration SetError - Errors returned by DeleteConfigurationSet
- Delete
Configuration SetEvent Destination Error - Errors returned by DeleteConfigurationSetEventDestination
- Delete
Contact Error - Errors returned by DeleteContact
- Delete
Contact List Error - Errors returned by DeleteContactList
- Delete
Custom Verification Email Template Error - Errors returned by DeleteCustomVerificationEmailTemplate
- Delete
Dedicated IpPool Error - Errors returned by DeleteDedicatedIpPool
- Delete
Email Identity Error - Errors returned by DeleteEmailIdentity
- Delete
Email Identity Policy Error - Errors returned by DeleteEmailIdentityPolicy
- Delete
Email Template Error - Errors returned by DeleteEmailTemplate
- Delete
Suppressed Destination Error - Errors returned by DeleteSuppressedDestination
- 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
- GetContact
Error - Errors returned by GetContact
- GetContact
List Error - Errors returned by GetContactList
- GetCustom
Verification Email Template Error - Errors returned by GetCustomVerificationEmailTemplate
- 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
- GetEmail
Identity Policies Error - Errors returned by GetEmailIdentityPolicies
- GetEmail
Template Error - Errors returned by GetEmailTemplate
- GetImport
JobError - Errors returned by GetImportJob
- GetSuppressed
Destination Error - Errors returned by GetSuppressedDestination
- List
Configuration Sets Error - Errors returned by ListConfigurationSets
- List
Contact Lists Error - Errors returned by ListContactLists
- List
Contacts Error - Errors returned by ListContacts
- List
Custom Verification Email Templates Error - Errors returned by ListCustomVerificationEmailTemplates
- 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
Email Templates Error - Errors returned by ListEmailTemplates
- List
Import Jobs Error - Errors returned by ListImportJobs
- List
Suppressed Destinations Error - Errors returned by ListSuppressedDestinations
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutAccount
Dedicated IpWarmup Attributes Error - Errors returned by PutAccountDedicatedIpWarmupAttributes
- PutAccount
Details Error - Errors returned by PutAccountDetails
- PutAccount
Sending Attributes Error - Errors returned by PutAccountSendingAttributes
- PutAccount
Suppression Attributes Error - Errors returned by PutAccountSuppressionAttributes
- 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
SetSuppression Options Error - Errors returned by PutConfigurationSetSuppressionOptions
- 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 Configuration SetAttributes Error - Errors returned by PutEmailIdentityConfigurationSetAttributes
- PutEmail
Identity Dkim Attributes Error - Errors returned by PutEmailIdentityDkimAttributes
- PutEmail
Identity Dkim Signing Attributes Error - Errors returned by PutEmailIdentityDkimSigningAttributes
- PutEmail
Identity Feedback Attributes Error - Errors returned by PutEmailIdentityFeedbackAttributes
- PutEmail
Identity Mail From Attributes Error - Errors returned by PutEmailIdentityMailFromAttributes
- PutSuppressed
Destination Error - Errors returned by PutSuppressedDestination
- Send
Bulk Email Error - Errors returned by SendBulkEmail
- Send
Custom Verification Email Error - Errors returned by SendCustomVerificationEmail
- Send
Email Error - Errors returned by SendEmail
- TagResource
Error - Errors returned by TagResource
- Test
Render Email Template Error - Errors returned by TestRenderEmailTemplate
- Untag
Resource Error - Errors returned by UntagResource
- Update
Configuration SetEvent Destination Error - Errors returned by UpdateConfigurationSetEventDestination
- Update
Contact Error - Errors returned by UpdateContact
- Update
Contact List Error - Errors returned by UpdateContactList
- Update
Custom Verification Email Template Error - Errors returned by UpdateCustomVerificationEmailTemplate
- Update
Email Identity Policy Error - Errors returned by UpdateEmailIdentityPolicy
- Update
Email Template Error - Errors returned by UpdateEmailTemplate
Traits§
- SesV2
- Trait representing the capabilities of the Amazon SES V2 API. Amazon SES V2 clients implement this trait.