Amazon Web Services, Inc.

Amazon Simple Email Service v2

Amazon SES API v2 Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers. If you're new to Amazon SES API v2,…

Communication#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon SES API v2

Amazon SES is an Amazon Web Services 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 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.

Endpoints 116

  • POSTAssociate email identity certificate/v2/email/identity/certificatesAssociates an S/MIME certificate with an email identity. After the certificate is active, Amazon SES API v2 can add an S/MIME signature to messages that you…
  • POSTBatch get metric data/v2/email/metrics/batchRetrieves 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…
  • PUTCancel export job/v2/email/export-jobs/:JobId/cancelCancels an export job.
  • POSTCreate configuration set/v2/email/configuration-setsCreate 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…
  • GETGet configuration set event destinations/v2/email/configuration-sets/:ConfigurationSetName/event-destinationsRetrieve a list of event destinations that are associated with a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and…
  • POSTCreate configuration set event destination/v2/email/configuration-sets/:ConfigurationSetName/event-destinationsCreate an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send…
  • POSTCreate contact/v2/email/contact-lists/:ContactListName/contactsCreates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
  • GETList contact lists/v2/email/contact-lists?PageSize=0&NextToken=stringLists all of the contact lists available. If your output includes a "NextToken" field with a string value, this indicates there may be additional contacts on…
  • POSTCreate contact list/v2/email/contact-listsCreates a contact list.
  • GETList custom verification email templates/v2/email/custom-verification-email-templates?NextToken=string&PageSize=0Lists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom…
  • POSTCreate custom verification email template/v2/email/custom-verification-email-templatesCreates a new custom verification email template. For more information about custom verification email templates, see Using custom verification email…
  • GETList dedicated ip pools/v2/email/dedicated-ip-pools?NextToken=string&PageSize=0List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
  • POSTCreate dedicated ip pool/v2/email/dedicated-ip-poolsCreate 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.…
  • POSTCreate deliverability test report/v2/email/deliverability-dashboard/testCreate a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email…
  • POSTCreate email identity/v2/email/identitiesStarts 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…
  • PUTUpdate email identity policy/v2/email/identities/:EmailIdentity/policies/:PolicyNameUpdates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with…
  • POSTCreate email identity policy/v2/email/identities/:EmailIdentity/policies/:PolicyNameCreates 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…
  • DELETEDelete email identity policy/v2/email/identities/:EmailIdentity/policies/:PolicyNameDeletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with…
  • GETList email templates/v2/email/templates?NextToken=string&PageSize=0Lists 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…
  • POSTCreate email template/v2/email/templatesCreates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information,…
  • POSTCreate export job/v2/email/export-jobsCreates an export job for a data source and destination. Export jobs run asynchronously. This operation returns a JobId . Call GetExportJob with that ID until…
  • POSTCreate import job/v2/email/import-jobsCreates an import job for a data destination.
  • GETList multi region endpoints/v2/email/multi-region-endpoints?NextToken=string&PageSize=0List the multi-region endpoints (global-endpoints). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is…
  • POSTCreate multi region endpoint/v2/email/multi-region-endpointsCreates a multi-region endpoint (global-endpoint). The primary region is going to be the AWS-Region where the operation is executed. The secondary region has…
  • POSTCreate tenant/v2/email/tenantsCreate a tenant. Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email…
  • POSTCreate tenant resource association/v2/email/tenants/resourcesAssociate a resource with a tenant. Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant,…
  • GETGet configuration set/v2/email/configuration-sets/:ConfigurationSetNameGet 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,…
  • DELETEDelete configuration set/v2/email/configuration-sets/:ConfigurationSetNameDelete 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…
  • PUTUpdate configuration set event destination/v2/email/configuration-sets/:ConfigurationSetName/event-destinations/:EventDestinationNameUpdate the configuration of an event destination for a configuration set. Events include message sends, deliveries, opens, clicks, bounces, and complaints.…
  • DELETEDelete configuration set event destination/v2/email/configuration-sets/:ConfigurationSetName/event-destinations/:EventDestinationNameDelete an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send…
  • GETGet contact/v2/email/contact-lists/:ContactListName/contacts/:EmailAddressReturns a contact from a contact list.
  • PUTUpdate contact/v2/email/contact-lists/:ContactListName/contacts/:EmailAddressUpdates a contact's preferences for a list. You must specify all existing topic preferences in the TopicPreferences object, not just the ones that need…
  • DELETEDelete contact/v2/email/contact-lists/:ContactListName/contacts/:EmailAddressRemoves a contact from a contact list.
  • GETGet contact list/v2/email/contact-lists/:ContactListNameReturns contact list metadata. It does not return any information about the contacts present in the list.
  • PUTUpdate contact list/v2/email/contact-lists/:ContactListNameUpdates contact list metadata. This operation does a complete replacement.
  • DELETEDelete contact list/v2/email/contact-lists/:ContactListNameDeletes a contact list and all of the contacts on that list.
  • GETGet custom verification email template/v2/email/custom-verification-email-templates/:TemplateNameReturns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using…
  • PUTUpdate custom verification email template/v2/email/custom-verification-email-templates/:TemplateNameUpdates an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email…
  • DELETEDelete custom verification email template/v2/email/custom-verification-email-templates/:TemplateNameDeletes an existing custom verification email template. For more information about custom verification email templates, see Using custom verification email…
  • GETGet dedicated ip pool/v2/email/dedicated-ip-pools/:PoolNameRetrieve information about the dedicated pool.
  • DELETEDelete dedicated ip pool/v2/email/dedicated-ip-pools/:PoolNameDelete a dedicated IP pool.
  • GETGet email identity/v2/email/identities/:EmailIdentityProvides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status,…
  • DELETEDelete email identity/v2/email/identities/:EmailIdentityDeletes an email identity. An identity can be either an email address or a domain name.
  • GETGet email template/v2/email/templates/:TemplateNameDisplays 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…
  • PUTUpdate email template/v2/email/templates/:TemplateNameUpdates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information,…
  • DELETEDelete email template/v2/email/templates/:TemplateNameDeletes an email template. You can execute this operation no more than once per second.
  • GETGet multi region endpoint/v2/email/multi-region-endpoints/:EndpointNameDisplays the multi-region endpoint (global-endpoint) configuration. Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region…
  • DELETEDelete multi region endpoint/v2/email/multi-region-endpoints/:EndpointNameDeletes a multi-region endpoint (global-endpoint). Only multi-region endpoints (global-endpoints) whose primary region is the AWS-Region where operation is…
  • GETGet suppressed destination/v2/email/suppression/addresses/:EmailAddress?TenantName=stringRetrieves information about a specific email address that's on the suppression list for your account or for a specific tenant. To target a tenant's…
  • DELETEDelete suppressed destination/v2/email/suppression/addresses/:EmailAddress?TenantName=stringRemoves an email address from the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName…
  • POSTDelete tenant/v2/email/tenants/deleteDelete an existing tenant. When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.
  • POSTDelete tenant resource association/v2/email/tenants/resources/deleteDelete an association between a tenant and a resource. When you delete a tenant-resource association, the resource itself is not deleted, only its association…
  • POSTDisassociate email identity certificate/v2/email/identity/certificates/deleteRemoves the association between an S/MIME certificate and an email identity. After the association is removed, Amazon SES API v2 stops adding an S/MIME…
  • GETGet account/v2/email/accountObtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
  • GETGet blacklist reports/v2/email/deliverability-dashboard/blacklist-report?BlacklistItemNames=Retrieve a list of the blacklists that your dedicated IP addresses appear on.
  • GETGet dedicated ip/v2/email/dedicated-ips/:IpGet 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…
  • GETGet dedicated ips/v2/email/dedicated-ips?PoolName=string&NextToken=string&PageSize=0List the dedicated IP addresses that are associated with your Amazon Web Services account.
  • GETGet deliverability dashboard options/v2/email/deliverability-dashboardRetrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to…
  • PUTPut deliverability dashboard option/v2/email/deliverability-dashboardEnable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics…
  • GETGet deliverability test report/v2/email/deliverability-dashboard/test-reports/:ReportIdRetrieve the results of a predictive inbox placement test.
  • GETGet domain deliverability campaign/v2/email/deliverability-dashboard/campaigns/:CampaignIdRetrieve 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…
  • GETGet domain statistics report/v2/email/deliverability-dashboard/statistics-report/:Domain?StartDate=string&EndDate=stringRetrieve inbox placement and engagement rates for the domains that you use to send email.
  • POSTGet email address insights/v2/email/email-address-insightsProvides validation insights about a specific email address, including syntax validation, DNS record checks, mailbox existence, and other deliverability…
  • GETGet email identity policies/v2/email/identities/:EmailIdentity/policiesReturns 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…
  • GETGet export job/v2/email/export-jobs/:JobIdProvides information about an export job. When the job status is COMPLETED , the response includes a pre-signed URL in ExportDestination.S3Url that you use to…
  • GETGet import job/v2/email/import-jobs/:JobIdProvides information about an import job.
  • GETGet message insights/v2/email/insights/:MessageIdProvides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with…
  • GETGet reputation entity/v2/email/reputation/entities/:ReputationEntityType/:ReputationEntityReferenceRetrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon…
  • POSTGet tenant/v2/email/tenants/getGet information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, sending status, and suppression attributes.
  • POSTList configuration sets/v2/email/list-configuration-setsList 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…
  • POSTList contacts/v2/email/contact-lists/:ContactListName/contacts/listLists the contacts present in a specific contact list.
  • GETList deliverability test reports/v2/email/deliverability-dashboard/test-reports?NextToken=string&PageSize=0Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are…
  • GETList domain deliverability campaigns/v2/email/deliverability-dashboard/domains/:SubscribedDomain/campaigns?StartDate=string&EndDate=string&NextToken=string&PageSize=0Retrieve 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…
  • POSTList email identities/v2/email/list-identitiesReturns 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…
  • POSTList email identity certificates/v2/email/identity/certificates/listLists the S/MIME certificates that are associated with the specified email identity. The results include certificates in all states, such as PROVISIONING ,…
  • POSTList export jobs/v2/email/list-export-jobsLists all of the export jobs.
  • POSTList import jobs/v2/email/import-jobs/listLists all of the import jobs.
  • POSTList recommendations/v2/email/vdm/recommendationsLists 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…
  • POSTList reputation entities/v2/email/reputation/entitiesList reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact,…
  • POSTList resource tenants/v2/email/resources/tenants/listList all tenants associated with a specific resource. This operation returns a list of tenants that are associated with the specified resource. This is useful…
  • GETList suppressed destinations/v2/email/suppression/addresses?TenantName=string&Reason=&StartDate=string&EndDate=string&NextToken=string&PageSize=0Retrieves a list of email addresses that are on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify…
  • PUTPut suppressed destination/v2/email/suppression/addressesAdds an email address to the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName…
  • GETList tags for resource/v2/email/tags?ResourceArn=stringRetrieve 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…
  • POSTTag resource/v2/email/tagsAdd 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…
  • DELETEUntag resource/v2/email/tags?ResourceArn=string&TagKeys=Remove one or more tags (keys and values) from a specified resource.
  • POSTList tenant resources/v2/email/tenants/resources/listList all resources associated with a specific tenant. This operation returns a list of resources (email identities, configuration sets, or email templates)…
  • POSTList tenants/v2/email/tenants/listList all tenants associated with your account in the current Amazon Web Services Region. This operation returns basic information about each tenant, such as…
  • PUTPut account dedicated ip warmup attributes/v2/email/account/dedicated-ips/warmupEnable or disable the automatic warm-up feature for dedicated IP addresses.
  • POSTPut account details/v2/email/account/detailsUpdate your Amazon SES account details.
  • PUTPut account pricing attributes/v2/email/account/pricing-attributesSet the pricing plan for your Amazon SES account.
  • PUTPut account sending attributes/v2/email/account/sendingEnable or disable the ability of your account to send email.
  • PUTPut account suppression attributes/v2/email/account/suppressionChange the settings for the account-level suppression list.
  • PUTPut account vdm attributes/v2/email/account/vdmUpdate your Amazon SES account VDM attributes. You can execute this operation no more than once per second.
  • PUTPut configuration set archiving options/v2/email/configuration-sets/:ConfigurationSetName/archiving-optionsAssociate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be…
  • PUTPut configuration set delivery options/v2/email/configuration-sets/:ConfigurationSetName/delivery-optionsAssociate 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…
  • PUTPut configuration set reputation options/v2/email/configuration-sets/:ConfigurationSetName/reputation-optionsEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
  • PUTPut configuration set sending options/v2/email/configuration-sets/:ConfigurationSetName/sendingEnable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
  • PUTPut configuration set suppression options/v2/email/configuration-sets/:ConfigurationSetName/suppression-optionsSpecify the suppression list preferences for a configuration set. You can also use this operation to specify a SuppressionScope to override the suppression…
  • PUTPut configuration set tracking options/v2/email/configuration-sets/:ConfigurationSetName/tracking-optionsSpecify a custom domain to use for open and click tracking elements in email that you send.
  • PUTPut configuration set vdm options/v2/email/configuration-sets/:ConfigurationSetName/vdm-optionsSpecify VDM preferences for email that you send using the configuration set. You can execute this operation no more than once per second.
  • PUTPut dedicated ip in pool/v2/email/dedicated-ips/:Ip/poolMove 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…
  • PUTPut dedicated ip pool scaling attributes/v2/email/dedicated-ip-pools/:PoolName/scalingUsed to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be converted to STANDARD scaling mode.
  • PUTPut dedicated ip warmup attributes/v2/email/dedicated-ips/:Ip/warmup
  • PUTPut email identity configuration set attributes/v2/email/identities/:EmailIdentity/configuration-setUsed to associate a configuration set with an email identity.
  • PUTPut email identity dkim attributes/v2/email/identities/:EmailIdentity/dkimUsed to enable or disable DKIM authentication for an email identity.
  • PUTPut email identity dkim signing attributes/v2/email/identities/:EmailIdentity/dkim/signingUsed 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…
  • PUTPut email identity feedback attributes/v2/email/identities/:EmailIdentity/feedbackUsed 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…
  • PUTPut email identity mail from attributes/v2/email/identities/:EmailIdentity/mail-fromUsed to enable or disable the custom Mail-From domain configuration for an email identity.
  • POSTPut tenant suppression attributes/v2/email/tenant/suppressionConfigure the suppression list preferences for a tenant. Use this operation to enable or disable tenant-level suppression, or to change the suppressed reasons…
  • POSTSend bulk email/v2/email/outbound-bulk-emailsComposes an email message to multiple destinations.
  • POSTSend custom verification email/v2/email/outbound-custom-verification-emailsAdds 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…
  • POSTSend email/v2/email/outbound-emailsSends 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…
  • POSTTest render email template/v2/email/templates/:TemplateName/renderCreates 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…
  • POSTUpdate configuration set/v2/email/update-configuration-setsUpdates an existing configuration set. This operation performs a partial update. Only the attributes that you include in the request are updated; any omitted…
  • PUTUpdate reputation entity customer managed status/v2/email/reputation/entities/:ReputationEntityType/:ReputationEntityReference/customer-managed-statusUpdate the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity. The…
  • PUTUpdate reputation entity policy/v2/email/reputation/entities/:ReputationEntityType/:ReputationEntityReference/policyUpdate the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically…

API details

Base URL
https://email.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
116 operations on 90 pathsPOST 41GET 32PUT 31DELETE 12
Description format
AWS Smithy model, API version 2019-09-27

How to test the Amazon Simple Email Service v2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Simple Email Service v2 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate email identity certificate” (POST /v2/email/identity/certificates), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Simple Email Service v2?

Amazon SES API v2 Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers. If you're new to Amazon SES API v2,… It is listed under Communication and has 116 endpoints.

Who publishes the Amazon Simple Email Service v2?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Simple Email Service v2?

Requests go to https://email.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Simple Email Service v2?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Simple Email Service v2 have?

116 operations on 90 paths (41 POST, 32 GET, 31 PUT, 12 DELETE).

Is forking the Amazon Simple Email Service v2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.