Amazon SES Email API
The Email API from Amazon SES — 60 operation(s) for email.
Amazon SES Email API is one of 17 APIs that Amazon SES publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Email. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 86 operations across 60 paths, and defines 320 schemas. It is described by OpenAPI 3.2.0, at version 2019-09-27.
Requests are made against 4 base URLs: http://email.{region}.amazonaws.com, https://email.{region}.amazonaws.com, http://email.{region}.amazonaws.com.cn, https://email.{region}.amazonaws.com.cn.
86 operations
60 paths
320 schemas
11 DELETE31 GET19 POST25 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Amazon SES Email API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 86
Across 60 paths, the API surfaces 86 operations — 11 DELETE, 31 GET, 19 POST, 25 PUT. Each is listed below with its method, path, parameters, and response codes.
Email 86
POST
/v2/email/metrics/batch
Retrieves batches of metric data collected based on your sending activity. You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (c…
POST
/v2/email/configuration-sets
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuratio…
GET
/v2/email/configuration-sets
List all of the configuration sets associated with your account in the current region. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set…
POST
/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations
Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For e…
GET
/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations
Retrieve a list of event destinations that are associated with a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places tha…
POST
/v2/email/contact-lists/{ContactListName}/contacts
Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
GET
/v2/email/contact-lists/{ContactListName}/contacts
Lists the contacts present in a specific contact list.
POST
/v2/email/contact-lists
Creates a contact list.
GET
/v2/email/contact-lists
Lists all of the contact lists available.
POST
/v2/email/custom-verification-email-templates
Creates a new custom verification email template. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide . You…
GET
/v2/email/custom-verification-email-templates
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom verification email templates, see Using custom ver…
POST
/v2/email/dedicated-ip-pools
Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configura…
GET
/v2/email/dedicated-ip-pools
List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
POST
/v2/email/deliverability-dashboard/test
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 p…
POST
/v2/email/identities
Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify i…
GET
/v2/email/identities
Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that…
POST
/v2/email/identities/{EmailIdentity}/policies/{PolicyName}
Creates the specified sending authorization policy for the given identity (an email address or a domain). This API is for the identity owner only. If you have not verified the identity, this API will…
DELETE
/v2/email/identities/{EmailIdentity}/policies/{PolicyName}
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This A…
PUT
/v2/email/identities/{EmailIdentity}/policies/{PolicyName}
Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist. This A…
POST
/v2/email/templates
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide . You…
GET
/v2/email/templates
Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second.
POST
/v2/email/import-jobs
Creates an import job for a data destination.
GET
/v2/email/import-jobs
Lists all of the import jobs.
DELETE
/v2/email/configuration-sets/{ConfigurationSetName}
Delete an existing configuration set. 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 confi…
GET
/v2/email/configuration-sets/{ConfigurationSetName}
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. Configuration sets are groups…
DELETE
/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}
Delete an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For e…
PUT
/v2/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}
Update the configuration of an event destination for a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can…
DELETE
/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}
Removes a contact from a contact list.
GET
/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}
Returns a contact from a contact list.
PUT
/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}
Updates a contact's preferences for a list. It is not necessary to specify all existing topic preferences in the TopicPreferences object, just the ones that need updating.
DELETE
/v2/email/contact-lists/{ContactListName}
Deletes a contact list and all of the contacts on that list.
GET
/v2/email/contact-lists/{ContactListName}
Returns contact list metadata. It does not return any information about the contacts present in the list.
PUT
/v2/email/contact-lists/{ContactListName}
Updates contact list metadata. This operation does a complete replacement.
DELETE
/v2/email/custom-verification-email-templates/{TemplateName}
Deletes an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide…
GET
/v2/email/custom-verification-email-templates/{TemplateName}
Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using custom verification email templates in the…
PUT
/v2/email/custom-verification-email-templates/{TemplateName}
Updates an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide…
DELETE
/v2/email/dedicated-ip-pools/{PoolName}
Delete a dedicated IP pool.
GET
/v2/email/dedicated-ip-pools/{PoolName}
Retrieve information about the dedicated pool.
DELETE
/v2/email/identities/{EmailIdentity}
Deletes an email identity. An identity can be either an email address or a domain name.
GET
/v2/email/identities/{EmailIdentity}
Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.
DELETE
/v2/email/templates/{TemplateName}
Deletes an email template. You can execute this operation no more than once per second.
GET
/v2/email/templates/{TemplateName}
Displays the template object (which includes the subject line, HTML part and text part) for the template you specify. You can execute this operation no more than once per second.
PUT
/v2/email/templates/{TemplateName}
Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide . You…
DELETE
/v2/email/suppression/addresses/{EmailAddress}
Removes an email address from the suppression list for your account.
GET
/v2/email/suppression/addresses/{EmailAddress}
Retrieves information about a specific email address that's on the suppression list for your account.
GET
/v2/email/account
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
GET
/v2/email/deliverability-dashboard/blacklist-report#BlacklistItemNames
Retrieve a list of the blacklists that your dedicated IP addresses appear on.
GET
/v2/email/dedicated-ips/{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
/v2/email/dedicated-ips
List the dedicated IP addresses that are associated with your Amazon Web Services account.
GET
/v2/email/deliverability-dashboard
Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics…
PUT
/v2/email/deliverability-dashboard
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 ema…
GET
/v2/email/deliverability-dashboard/test-reports/{ReportId}
Retrieve the results of a predictive inbox placement test.
GET
/v2/email/deliverability-dashboard/campaigns/{CampaignId}
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.
GET
/v2/email/deliverability-dashboard/statistics-report/{Domain}#StartDate&EndDate
Retrieve inbox placement and engagement rates for the domains that you use to send email.
GET
/v2/email/identities/{EmailIdentity}/policies
Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a m…
GET
/v2/email/import-jobs/{JobId}
Provides information about an import job.
GET
/v2/email/deliverability-dashboard/test-reports
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 GetDeliverabilityTestR…
GET
/v2/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns#StartDate&EndDate
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…
POST
/v2/email/vdm/recommendations
Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second.
GET
/v2/email/suppression/addresses
Retrieves a list of email addresses that are on the suppression list for your account.
PUT
/v2/email/suppression/addresses
Adds an email address to the suppression list for your account.
GET
/v2/email/tags#ResourceArn
Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required…
PUT
/v2/email/account/dedicated-ips/warmup
Enable or disable the automatic warm-up feature for dedicated IP addresses.
POST
/v2/email/account/details
Update your Amazon SES account details.
PUT
/v2/email/account/sending
Enable or disable the ability of your account to send email.
PUT
/v2/email/account/suppression
Change the settings for the account-level suppression list.
PUT
/v2/email/account/vdm
Update your Amazon SES account VDM attributes. You can execute this operation no more than once per second.
PUT
/v2/email/configuration-sets/{ConfigurationSetName}/delivery-options
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.
PUT
/v2/email/configuration-sets/{ConfigurationSetName}/reputation-options
Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
PUT
/v2/email/configuration-sets/{ConfigurationSetName}/sending
Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
PUT
/v2/email/configuration-sets/{ConfigurationSetName}/suppression-options
Specify the account suppression list preferences for a configuration set.
PUT
/v2/email/configuration-sets/{ConfigurationSetName}/tracking-options
Specify a custom domain to use for open and click tracking elements in email that you send.
PUT
/v2/email/configuration-sets/{ConfigurationSetName}/vdm-options
Specify VDM preferences for email that you send using the configuration set. You can execute this operation no more than once per second.
PUT
/v2/email/dedicated-ips/{IP}/pool
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 Web Services account. The dedicated…
PUT
/v2/email/dedicated-ips/{IP}/warmup
PUT
/v2/email/identities/{EmailIdentity}/configuration-set
Used to associate a configuration set with an email identity.
PUT
/v2/email/identities/{EmailIdentity}/dkim
Used to enable or disable DKIM authentication for an email identity.
PUT
/v1/email/identities/{EmailIdentity}/dkim/signing
Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following: Update the signing attributes for an identity that us…
PUT
/v2/email/identities/{EmailIdentity}/feedback
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. If the value…
PUT
/v2/email/identities/{EmailIdentity}/mail-from
Used to enable or disable the custom Mail-From domain configuration for an email identity.
POST
/v2/email/outbound-bulk-emails
Composes an email message to multiple destinations.
POST
/v2/email/outbound-custom-verification-emails
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized…
POST
/v2/email/outbound-emails
Sends an email message. You can use the Amazon SES API v2 to send the following types of messages: Simple – A standard email message. When you create this type of message, you specify the sender, the…
POST
/v2/email/tags
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. Tags can help you categorize and manage resources in differe…
POST
/v2/email/templates/{TemplateName}/render
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data. You can execute this operation no more than once per second.
DELETE
/v2/email/tags#ResourceArn&TagKeys
Remove one or more tags (keys and values) from a specified resource.
Schemas 320
The contract defines 320 schemas that model the data the API accepts and returns. The most detailed are DomainDeliverabilityCampaign (14 properties), GetEmailIdentityResponse (9 properties), GetImportJobResponse (9 properties), GetConfigurationSetResponse (8 properties). Each schema is shown below with its type and property counts.
ListEmailIdentitiesResponse
object
A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.
2 properties
SuppressionListReasons
array
DefaultDimensionValue
string
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value ha…
UpdateConfigurationSetEventDestinationResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
FailedRecordsS3Url
string
DimensionName
string
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: It can only contain ASCII lett…
Ip
string
An IPv4 address.
PutConfigurationSetDeliveryOptionsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
SendEmailResponse
object
A unique message ID that you receive when an email is accepted for sending.
1 property
IspPlacement
object
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
2 properties
DkimAttributes
object
An object that contains information about the DKIM authentication status for an email identity. Amazon SES determines the authentication status by searching fo…
7 properties
ReviewStatus
string
Esp
string
DkimSigningKeyLength
string
ImportDataSource
object
An object that contains details about the data source of the import job.
2 properties
2 required
ListDeliverabilityTestReportsResponse
object
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
2 properties
1 required
Tag
object
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 y…
2 properties
2 required
GetSuppressedDestinationResponse
object
Information about the suppressed email address.
1 property
1 required
IdentityInfo
object
Information about an email identity.
4 properties
ReportId
string
A unique string that identifies a Deliverability dashboard report.
TagList
array
Timestamp
string
IspName
string
The name of an email provider.
GetDedicatedIpResponse
object
Information about a dedicated IP address.
1 property
UpdateEmailIdentityPolicyResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutAccountSendingAttributesResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
ConflictException
EmailTemplateMetadata
object
Contains information about an email template.
2 properties
Selector
string
GetConfigurationSetEventDestinationsResponse
object
Information about an event destination for a configuration set.
1 property
CreateEmailTemplateResponse
object
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
PutAccountSuppressionAttributesResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
BlacklistReport
object
PutDeliverabilityDashboardOptionResponse
object
A response that indicates whether the Deliverability dashboard is enabled.
AdditionalContactEmailAddress
string
ReputationOptions
object
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current Amazon Web Services Region.
2 properties
TopicPreference
object
The contact's preference for being opted-in to or opted-out of a topic.
2 properties
2 required
TagValue
string
ListCustomVerificationEmailTemplatesResponse
object
The following elements are returned by the service.
2 properties
SendBulkEmailResponse
object
The following data is returned in JSON format by the service.
1 property
1 required
Template
object
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…
3 properties
Esps
array
SuppressionListDestination
object
An object that contains details about the action of suppression list.
1 property
1 required
SuppressionListReason
string
The reason that the address was added to the suppression list for your account. The value can be one of the following: COMPLAINT – Amazon SES added an email ad…
BatchGetMetricDataResponse
object
Represents the result of processing your metric data batch request
2 properties
OverallVolume
object
An object that contains information about email that was sent from the selected domain.
3 properties
ListDedicatedIpPoolsResponse
object
A list of dedicated IP pools.
2 properties
MetricDimensionValue
string
MessageData
string
FailureInfo
object
An object that contains the failure details about an import job.
2 properties
SuppressedDestinationSummary
object
A summary that describes the suppressed email address.
3 properties
3 required
ConfigurationSetName
string
The name of a configuration set. Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by…
UseDefaultIfPreferenceUnavailable
boolean
GuardianAttributes
object
An object containing additional settings for your VDM configuration as applicable to the Guardian.
1 property
PutAccountDetailsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Percentage100Wrapper
integer
RawMessageData
string
The raw email message. The message has to meet the following criteria: The message has to contain a header and a body, separated by one blank line. All of the…
CloudWatchDimensionConfiguration
object
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
3 properties
3 required
ContactListImportAction
string
DeleteContactListResponse
object
TemplateContent
string
The content of the custom verification email template.
ContactListName
string
EventDestination
object
In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. Event destinations are places that…
7 properties
2 required
EmailTemplateText
string
The email body that will be visible to recipients whose email clients do not display HTML.
TlsPolicy
string
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require , messages are only deliv…
InvalidNextTokenException
SuppressedDestination
object
An object that contains information about an email address that is on the suppression list for your account.
4 properties
3 required
SuppressedDestinationSummaries
array
WebsiteURL
string
GetEmailTemplateResponse
object
The following element is returned by the service.
2 properties
2 required
CustomVerificationEmailTemplatesList
array
A list of the custom verification email templates that exist in your account.
IpList
array
Volume
integer
An object that contains information about inbox placement volume.
MetricNamespace
string
PutConfigurationSetTrackingOptionsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DomainDeliverabilityTrackingOptions
array
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an activ…
SuppressionAttributes
object
An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
1 property
ListRecommendationFilterValue
string
ImportJobSummary
object
A summary of the import job.
6 properties
UpdateEmailTemplateResponse
object
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
DailyVolume
object
An object that contains information about the volume of email sent on each day of the analysis period.
3 properties
Message
object
Represents the email message that you're sending. The Message object consists of a subject line and a message body.
2 properties
2 required
EventDestinations
array
GetDomainStatisticsReportResponse
object
An object that includes statistics that are related to the domain that you specified.
2 properties
2 required
TimestampList
array
BlacklistEntries
array
DashboardAttributes
object
An object containing additional settings for your VDM configuration as applicable to the Dashboard.
1 property
ListOfContactLists
array
ListRecommendationsResponse
object
Contains the response to your request to retrieve the list of recommendations for your account.
2 properties
DeleteDedicatedIpPoolResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
GetDeliverabilityTestReportResponse
object
The results of the predictive inbox placement test.
5 properties
3 required
ListTagsForResourceResponse
object
1 property
1 required
LastFreshStart
string
The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics a…
GeneralEnforcementStatus
string
DataFormat
string
The data format of the import job's data source.
DeleteCustomVerificationEmailTemplateResponse
object
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
PoolName
string
The name of a dedicated IP pool.
SendCustomVerificationEmailResponse
object
The following element is returned by the service.
1 property
PutSuppressedDestinationResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DomainIspPlacement
object
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
5 properties
MessageTagName
string
The name of the message tag. The message tag name has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores…
PolicyMap
object
An object that contains mapping between PolicyName and Policy text.
DkimStatus
string
The DKIM authentication status of the identity. The status can be one of the following: PENDING – The verification process was initiated, but Amazon SES hasn't…
CreateCustomVerificationEmailTemplateResponse
object
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
ReplacementTemplate
object
An object which contains ReplacementTemplateData to be used for a specific BulkEmailEntry .
1 property
JobId
string
A string that represents the import job ID.
DedicatedIpList
array
A list of dedicated IP addresses that are associated with your Amazon Web Services account.
DomainDeliverabilityCampaignList
array
GetContactResponse
object
8 properties
Body
object
Represents the body of the email message.
2 properties
BehaviorOnMxFailure
string
The action to take if the required MX record can't be found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazons…
DailyVolumes
array
BlacklistEntry
object
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
3 properties
ListConfigurationSetsResponse
object
A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region.
2 properties
MetricDataError
object
An error corresponding to the unsuccessful processing of a single metric data query.
3 properties
EmailTemplateData
string
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in…
EventDestinationName
string
The name of an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can…
ConfigurationSetNameList
array
DnsToken
string
BulkEmailEntryResult
object
The result of the SendBulkEmail operation of each specified BulkEmailEntry .
3 properties
GetContactListResponse
object
6 properties
EmailTemplateMetadataList
array
A list of the EmailTemplateMetadata object.
EmailTemplateContent
object
The content of the email, composed of a subject line, an HTML part, and a text-only part.
3 properties
RecommendationType
string
MessageRejected
Topics
array
InboxPlacementTrackingOption
object
An object that contains information about the inbox placement data settings for a verified domain that’s associated with your Amazon Web Services account. This…
2 properties
UpdateContactResponse
object
ReplacementEmailContent
object
The ReplaceEmailContent object to be used for a specific BulkEmailEntry . The ReplacementTemplate can be specified within this object.
1 property
TestRenderEmailTemplateResponse
object
The following element is returned by the service.
1 property
1 required
RenderedEmailTemplate
string
The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.
MessageTagList
array
A list of message tags.
Charset
string
VerificationStatus
string
ListImportJobsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
2 properties
Max24HourSend
number
DeliverabilityTestSubject
string
The subject line for an email that you submitted in a predictive inbox placement test.
NextToken
string
PutEmailIdentityDkimSigningAttributesResponse
object
If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service.
2 properties
PutDedicatedIpInPoolResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateDeliverabilityTestReportResponse
object
Information about the predictive inbox placement test that you created.
2 properties
2 required
RblName
string
The name of a blacklist that an IP address was found on.
DisplayName
string
BulkEmailEntryResultList
array
A list of BulkMailEntry objects.
ReviewDetails
object
An object that contains information about your account details review.
2 properties
MailFromAttributes
object
A list of attributes that are associated with a MAIL FROM domain.
3 properties
3 required
GetDeliverabilityDashboardOptionsResponse
object
An object that shows the status of the Deliverability dashboard.
5 properties
1 required
CaseId
string
Counter
integer
DeliverabilityTestReports
array
TagKey
string
BulkEmailEntry
object
3 properties
1 required
PutConfigurationSetVdmOptionsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PlacementStatistics
object
An object that contains inbox placement data for an email provider.
5 properties
MetricDataResultList
array
QueryErrorCode
string
RecommendationDescription
string
Policy
string
The text of the policy in JSON format. The policy cannot exceed 4 KB. For information about the syntax of sending authorization policies, see the Amazon SES De…
VolumeStatistics
object
An object that contains information about the amount of email that was delivered to recipients.
4 properties
CreateContactResponse
object
ErrorMessage
string
QueryIdentifier
string
AttributesData
string
CreateImportJobResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
1 property
GetImportJobResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
9 properties
TopicFilter
object
Used for filtering by a specific topic preference.
2 properties
SubscriptionStatus
string
Metric
string
AmazonResourceName
string
EmailTemplateName
string
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
MailFromDomainStatus
string
The status of the MAIL FROM domain. This status can have the following values: PENDING – Amazon SES hasn't started searching for the MX record yet. SUCCESS – A…
JobStatus
string
The status of the import job.
ContactListDestination
object
An object that contains details about the action of a contact list.
2 properties
2 required
Topic
object
An interest group, theme, or label within a list. Lists can have multiple topics.
4 properties
3 required
Dimensions
object
CloudWatchDimensionConfigurations
array
RecommendationsList
array
ContactList
object
A list that contains contacts that have subscribed to a particular topic or topics.
2 properties
WarmupStatus
string
The warmup status of a dedicated IP.
DomainIspPlacements
array
GetDedicatedIpsResponse
object
Information about the dedicated IP addresses that are associated with your Amazon Web Services account.
2 properties
PutEmailIdentityConfigurationSetAttributesResponse
object
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
KinesisFirehoseDestination
object
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,…
2 properties
2 required
DeliveryOptions
object
Used to associate a configuration set with a dedicated IP pool.
2 properties
DeleteSuppressedDestinationResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DkimSigningAttributesOrigin
string
DedicatedIp
object
Contains information about a dedicated IP address that is associated with your Amazon SES account. To learn more about requesting dedicated IP addresses, see R…
4 properties
3 required
DomainDeliverabilityTrackingOption
object
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an activ…
3 properties
Recommendation
object
A recommendation generated for your account.
7 properties
MailFromDomainName
string
The domain to use as a MAIL FROM domain.
IdentityType
string
GetDedicatedIpPoolResponse
object
The following element is returned by the service.
1 property
CustomVerificationEmailTemplateMetadata
object
Contains information about a custom verification email template.
5 properties
Description
string
VdmAttributes
object
The VDM attributes that apply to your Amazon SES account.
3 properties
1 required
CreateEmailIdentityResponse
object
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 addres…
3 properties
BlacklistingDescription
string
A description of the blacklisting event.
ListOfDedicatedIpPools
array
A list of dedicated IP pools that are associated with your Amazon Web Services account.
Domain
string
UnsubscribeAll
boolean
SendingOptions
object
Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region.
1 property
GetEmailIdentityPoliciesResponse
object
Identity policies associated with email identity.
1 property
MaxSendRate
number
GetAccountResponse
object
A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region.
8 properties
ListEmailTemplatesResponse
object
The following elements are returned by the service.
2 properties
EmailTemplateSubject
string
The subject line of the email.
DeleteContactResponse
object
Subject
string
NotFoundException
Content
object
An object that represents the content of the email, and optionally a character set specification.
2 properties
1 required
GetCustomVerificationEmailTemplateResponse
object
The following elements are returned by the service.
6 properties
DeleteEmailIdentityResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
ImageUrl
string
TagResourceResponse
object
SendingPausedException
MailFromDomainNotVerifiedException
EmailTemplateHtml
string
The HTML body of the email.
CustomRedirectDomain
string
The domain to use for tracking open and click events.
ImportJobSummaryList
array
A list of the import job summaries.
UpdateContactListResponse
object
BadRequestException
SendQuota
object
An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.
3 properties
PinpointDestination
object
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 usin…
1 property
DeliverabilityDashboardAccountStatus
string
The current status of your Deliverability dashboard subscription. If this value is PENDINGEXPIRATION , your subscription is scheduled to expire at the end of t…
DedicatedIpPool
object
Contains information about a dedicated IP pool.
2 properties
2 required
DeliverabilityTestReport
object
An object that contains metadata related to a predictive inbox placement test.
6 properties
S3Url
string
An Amazon S3 URL in the format s3://
FailedRecordsCount
integer
PutEmailIdentityMailFromAttributesResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
SentLast24Hours
number
SuppressionListImportAction
string
The type of action to perform on the address. The following are possible values: PUT: add the addresses to the suppression list. DELETE: remove the address fro…
PrivateKey
string
GetEmailIdentityResponse
object
Details about an email identity.
9 properties
ConcurrentModificationException
FailureRedirectionURL
string
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
ProcessedRecordsCount
integer
PutConfigurationSetSendingOptionsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
SuccessRedirectionURL
string
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
CreateConfigurationSetEventDestinationResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Destination
object
An object that describes the recipients for an email. Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 . For this reason, the local…
3 properties
DomainDeliverabilityCampaign
object
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 domai…
14 properties
ListSuppressedDestinationsResponse
object
A list of suppressed email addresses.
2 properties
ListDomainDeliverabilityCampaignsResponse
object
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 i…
2 properties
1 required
SuppressionOptions
object
An object that contains information about the suppression list preferences for your account.
1 property
ListOfContacts
array
FeedbackId
string
AdditionalContactEmailAddresses
array
PutAccountDedicatedIpWarmupAttributesResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
EmailAddress
string
PutConfigurationSetSuppressionOptionsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
MessageTag
object
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.
2 properties
2 required
DeleteConfigurationSetEventDestinationResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
ContactLanguage
string
CreateContactListResponse
object
GetDomainDeliverabilityCampaignResponse
object
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 d…
1 property
1 required
TopicPreferenceList
array
CloudWatchDestination
object
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 metr…
1 property
1 required
MetricDataResult
object
The result of a single metric data query.
3 properties
VdmOptions
object
An object that defines the VDM settings that apply to emails that you send using the configuration set.
2 properties
BatchGetMetricDataQuery
object
Represents a single metric data query to include in a batch.
6 properties
5 required
QueryErrorMessage
string
IspPlacements
array
MailType
string
EventTypes
array
AlreadyExistsException
MessageContent
string
The body of an email message.
ReportName
string
A name that helps you identify a report generated by the Deliverability dashboard.
PutEmailIdentityFeedbackAttributesResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Identity
string
BulkEmailStatus
string
Enabled
boolean
PutConfigurationSetReputationOptionsResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
TopicName
string
SnsDestination
object
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
1 property
1 required
DashboardOptions
object
An object containing additional settings for your VDM configuration as applicable to the Dashboard.
1 property
Percentage
number
An object that contains information about inbox placement percentages.
UntagResourceResponse
object
CreateDedicatedIpPoolResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
ListContactsResponse
object
2 properties
PutDedicatedIpWarmupAttributesResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
IdentityInfoList
array
CreateConfigurationSetResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteConfigurationSetResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
SuppressedDestinationAttributes
object
An object that contains additional attributes that are related an email address that is on the suppression list for your account.
2 properties
CreateEmailIdentityPolicyResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
IspNameList
array
DnsTokenList
array
ListContactListsResponse
object
2 properties
ScalingMode
string
UpdateCustomVerificationEmailTemplateResponse
object
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
EmailAddressList
array
CampaignId
string
TrackingOptions
object
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…
1 property
1 required
RecommendationImpact
string
RecommendationStatus
string
Contact
object
A contact is the end-user who is receiving the email.
5 properties
GetBlacklistReportsResponse
object
An object that contains information about blacklist events.
1 property
1 required
MetricDataErrorList
array
MetricValueList
array
InternalServiceErrorException
FeatureStatus
string
ImportDestination
object
An object that contains details about the resource destination the import job is going to target.
2 properties
EventType
string
An email sending event type. For example, email sends, opens, and bounces are all email events.
AccountSuspendedException
AccountDetails
object
An object that contains information about your account details.
6 properties
PutEmailIdentityDkimAttributesResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutAccountVdmAttributesResponse
object
OutboundMessageId
string
BlacklistItemName
string
An IP address that you want to obtain blacklist information for.
DeliverabilityTestStatus
string
The status of a predictive inbox placement test. If the status is INPROGRESS , then the predictive inbox placement test is currently running. Predictive inbox…
GuardianOptions
object
An object containing additional settings for your VDM configuration as applicable to the Guardian.
1 property
MessageTagValue
string
The value of the message tag. The message tag value has to meet the following criteria: It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscore…
TooManyRequestsException
UseCaseDescription
string
DimensionValueSource
string
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SE…
DeleteEmailIdentityPolicyResponse
object
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteEmailTemplateResponse
object
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
GetConfigurationSetResponse
object
Information about a configuration set.
8 properties
LimitExceededException
RawMessage
object
Represents the raw content of an email message.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Amazon SES 12
Other APIs Amazon SES publishes across the network.
Amazon SES Documentation
Amazon SES OpenAPI
Amazon SES OpenAPI (APIs.guru)
Amazon SES JSON Schema
Amazon SES JSON-LD Context
Amazon SES Pricing
Amazon SES Getting Started
Amazon SES FAQ
Amazon SES User Guide
Amazon SES API Reference
Amazon SES CLI Reference
Amazon SES Security
#Email
Where this information came from
This is an independent, third-party profile of Amazon SES Email API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.