Amazon Web Services, Inc.

Amazon Simple Email Service

Amazon Simple Email Service This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This…

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 Simple Email Service
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version
2010-12-01. This document is best used in conjunction with the Amazon SES Developer
Guide .

For a list of Amazon SES endpoints to use in service requests, see Regions and
Amazon SES in the Amazon SES Developer
Guide .

This documentation contains reference information related to the following:

Amazon SES API Actions

Amazon SES
API Data Types

Common
Parameters

Common Errors

Endpoints 71

  • POSTClone receipt rule set/#Action=CloneReceiptRuleSet?Action=CloneReceiptRuleSet&Version=2010-12-01Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely…
  • POSTCreate configuration set/#Action=CreateConfigurationSet?Action=CreateConfigurationSet&Version=2010-12-01Creates a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES…
  • POSTCreate configuration set event destination/#Action=CreateConfigurationSetEventDestination?Action=CreateConfigurationSetEventDestination&Version=2010-12-01Creates a configuration set event destination. When you create or update an event destination, you must provide one, and only one, destination. The…
  • POSTCreate configuration set tracking options/#Action=CreateConfigurationSetTrackingOptions?Action=CreateConfigurationSetTrackingOptions&Version=2010-12-01Creates an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open…
  • POSTCreate custom verification email template/#Action=CreateCustomVerificationEmailTemplate?Action=CreateCustomVerificationEmailTemplate&Version=2010-12-01Creates a new custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email…
  • POSTCreate receipt filter/#Action=CreateReceiptFilter?Action=CreateReceiptFilter&Version=2010-12-01Creates a new IP address filter. For information about setting up IP address filters, see the Amazon SES Developer Guide . You can execute this operation no…
  • POSTCreate receipt rule/#Action=CreateReceiptRule?Action=CreateReceiptRule&Version=2010-12-01Creates a receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide . You can execute this operation no more than once…
  • POSTCreate receipt rule set/#Action=CreateReceiptRuleSet?Action=CreateReceiptRuleSet&Version=2010-12-01Creates an empty receipt rule set. For information about setting up receipt rule sets, see the Amazon SES Developer Guide . You can execute this operation no…
  • POSTCreate template/#Action=CreateTemplate?Action=CreateTemplate&Version=2010-12-01Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see…
  • POSTDelete configuration set/#Action=DeleteConfigurationSet?Action=DeleteConfigurationSet&Version=2010-12-01Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES…
  • POSTDelete configuration set event destination/#Action=DeleteConfigurationSetEventDestination?Action=DeleteConfigurationSetEventDestination&Version=2010-12-01Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email…
  • POSTDelete configuration set tracking options/#Action=DeleteConfigurationSetTrackingOptions?Action=DeleteConfigurationSetTrackingOptions&Version=2010-12-01Deletes an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open…
  • POSTDelete custom verification email template/#Action=DeleteCustomVerificationEmailTemplate?Action=DeleteCustomVerificationEmailTemplate&Version=2010-12-01Deletes an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email…
  • POSTDelete identity/#Action=DeleteIdentity?Action=DeleteIdentity&Version=2010-12-01Deletes the specified identity (an email address or a domain) from the list of verified identities. You can execute this operation no more than once per second.
  • POSTDelete identity policy/#Action=DeleteIdentityPolicy?Action=DeleteIdentityPolicy&Version=2010-12-01Deletes the specified sending authorization policy for the given identity (an email address or a domain). This operation returns successfully even if a policy…
  • POSTDelete receipt filter/#Action=DeleteReceiptFilter?Action=DeleteReceiptFilter&Version=2010-12-01Deletes the specified IP address filter. For information about managing IP address filters, see the Amazon SES Developer Guide . You can execute this…
  • POSTDelete receipt rule/#Action=DeleteReceiptRule?Action=DeleteReceiptRule&Version=2010-12-01Deletes the specified receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide . You can execute this operation no more…
  • POSTDelete receipt rule set/#Action=DeleteReceiptRuleSet?Action=DeleteReceiptRuleSet&Version=2010-12-01Deletes the specified receipt rule set and all of the receipt rules it contains. The currently active rule set cannot be deleted. For information about…
  • POSTDelete template/#Action=DeleteTemplate?Action=DeleteTemplate&Version=2010-12-01Deletes an email template. You can execute this operation no more than once per second.
  • POSTDelete verified email address/#Action=DeleteVerifiedEmailAddress?Action=DeleteVerifiedEmailAddress&Version=2010-12-01Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
  • POSTDescribe active receipt rule set/#Action=DescribeActiveReceiptRuleSet?Action=DescribeActiveReceiptRuleSet&Version=2010-12-01Returns the metadata and receipt rules for the receipt rule set that is currently active. For information about setting up receipt rule sets, see the Amazon…
  • POSTDescribe configuration set/#Action=DescribeConfigurationSet?Action=DescribeConfigurationSet&Version=2010-12-01Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide . You can execute…
  • POSTDescribe receipt rule/#Action=DescribeReceiptRule?Action=DescribeReceiptRule&Version=2010-12-01Returns the details of the specified receipt rule. For information about setting up receipt rules, see the Amazon SES Developer Guide . You can execute this…
  • POSTDescribe receipt rule set/#Action=DescribeReceiptRuleSet?Action=DescribeReceiptRuleSet&Version=2010-12-01Returns the details of the specified receipt rule set. For information about managing receipt rule sets, see the Amazon SES Developer Guide . You can execute…
  • POSTGet account sending enabled/#Action=GetAccountSendingEnabled?Action=GetAccountSendingEnabled&Version=2010-12-01Returns the email sending status of the Amazon SES account for the current Region. You can execute this operation no more than once per second.
  • POSTGet custom verification email template/#Action=GetCustomVerificationEmailTemplate?Action=GetCustomVerificationEmailTemplate&Version=2010-12-01Returns the custom email verification template for the template name you specify. For more information about custom verification email templates, see Using…
  • POSTGet identity dkim attributes/#Action=GetIdentityDkimAttributes?Action=GetIdentityDkimAttributes&Version=2010-12-01Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for…
  • POSTGet identity mail from domain attributes/#Action=GetIdentityMailFromDomainAttributes?Action=GetIdentityMailFromDomainAttributes&Version=2010-12-01Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains). This operation is throttled at one request per second and can…
  • POSTGet identity notification attributes/#Action=GetIdentityNotificationAttributes?Action=GetIdentityNotificationAttributes&Version=2010-12-01Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes. This operation is…
  • POSTGet identity policies/#Action=GetIdentityPolicies?Action=GetIdentityPolicies&Version=2010-12-01Returns 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…
  • POSTGet identity verification attributes/#Action=GetIdentityVerificationAttributes?Action=GetIdentityVerificationAttributes&Version=2010-12-01Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each…
  • POSTGet send quota/#Action=GetSendQuota?Action=GetSendQuota&Version=2010-12-01Provides the sending limits for the Amazon SES account. You can execute this operation no more than once per second.
  • POSTGet send statistics/#Action=GetSendStatistics?Action=GetSendStatistics&Version=2010-12-01Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending…
  • POSTGet template/#Action=GetTemplate?Action=GetTemplate&Version=2010-12-01Displays 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…
  • POSTList configuration sets/#Action=ListConfigurationSets?Action=ListConfigurationSets&Version=2010-12-01Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using…
  • POSTList custom verification email templates/#Action=ListCustomVerificationEmailTemplates?Action=ListCustomVerificationEmailTemplates&Version=2010-12-01Lists the existing custom verification email templates for your account in the current Amazon Web Services Region. For more information about custom…
  • POSTList identities/#Action=ListIdentities?Action=ListIdentities&Version=2010-12-01Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region,…
  • POSTList identity policies/#Action=ListIdentityPolicies?Action=ListIdentityPolicies&Version=2010-12-01Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This operation returns only a list.…
  • POSTList receipt filters/#Action=ListReceiptFilters?Action=ListReceiptFilters&Version=2010-12-01Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region. For information about managing IP…
  • POSTList receipt rule sets/#Action=ListReceiptRuleSets?Action=ListReceiptRuleSets&Version=2010-12-01Lists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule…
  • POSTList templates/#Action=ListTemplates?Action=ListTemplates&Version=2010-12-01Lists 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…
  • POSTList verified email addresses/#Action=ListVerifiedEmailAddresses?Action=ListVerifiedEmailAddresses&Version=2010-12-01Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.
  • POSTPut configuration set delivery options/#Action=PutConfigurationSetDeliveryOptions?Action=PutConfigurationSetDeliveryOptions&Version=2010-12-01Adds or updates the delivery options for a configuration set.
  • POSTPut identity policy/#Action=PutIdentityPolicy?Action=PutIdentityPolicy&Version=2010-12-01Adds or updates a sending authorization policy for the specified identity (an email address or a domain). This operation is for the identity owner only. If…
  • POSTReorder receipt rule set/#Action=ReorderReceiptRuleSet?Action=ReorderReceiptRuleSet&Version=2010-12-01Reorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, it is error if the…
  • POSTSend bounce/#Action=SendBounce?Action=SendBounce&Version=2010-12-01Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours…
  • POSTSend bulk templated email/#Action=SendBulkTemplatedEmail?Action=SendBulkTemplatedEmail&Version=2010-12-01Composes an email message to multiple destinations. The message body is created using an email template. To send email using this operation, your call must…
  • POSTSend custom verification email/#Action=SendCustomVerificationEmail?Action=SendCustomVerificationEmail&Version=2010-12-01Adds 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/#Action=SendEmail?Action=SendEmail&Version=2010-12-01Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements: The…
  • POSTSend raw email/#Action=SendRawEmail?Action=SendRawEmail&Version=2010-12-01Composes an email message and immediately queues it for sending. This operation is more flexible than the SendEmail operation. When you use the SendRawEmail…
  • POSTSend templated email/#Action=SendTemplatedEmail?Action=SendTemplatedEmail&Version=2010-12-01Composes an email message using an email template and immediately queues it for sending. To send email using this operation, your call must meet the following…
  • POSTSet active receipt rule set/#Action=SetActiveReceiptRuleSet?Action=SetActiveReceiptRuleSet&Version=2010-12-01Sets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this operation…
  • POSTSet identity dkim enabled/#Action=SetIdentityDkimEnabled?Action=SetIdentityDkimEnabled&Version=2010-12-01Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all…
  • POSTSet identity feedback forwarding enabled/#Action=SetIdentityFeedbackForwardingEnabled?Action=SetIdentityFeedbackForwardingEnabled&Version=2010-12-01Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback…
  • POSTSet identity headers in notifications enabled/#Action=SetIdentityHeadersInNotificationsEnabled?Action=SetIdentityHeadersInNotificationsEnabled&Version=2010-12-01Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service…
  • POSTSet identity mail from domain/#Action=SetIdentityMailFromDomain?Action=SetIdentityMailFromDomain&Version=2010-12-01Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain). To send emails using the specified MAIL FROM…
  • POSTSet identity notification topic/#Action=SetIdentityNotificationTopic?Action=SetIdentityNotificationTopic&Version=2010-12-01Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified…
  • POSTSet receipt rule position/#Action=SetReceiptRulePosition?Action=SetReceiptRulePosition&Version=2010-12-01Sets the position of the specified receipt rule in the receipt rule set. For information about managing receipt rules, see the Amazon SES Developer Guide .…
  • POSTTest render template/#Action=TestRenderTemplate?Action=TestRenderTemplate&Version=2010-12-01Creates 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 account sending enabled/#Action=UpdateAccountSendingEnabled?Action=UpdateAccountSendingEnabled&Version=2010-12-01Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction…
  • POSTUpdate configuration set event destination/#Action=UpdateConfigurationSetEventDestination?Action=UpdateConfigurationSetEventDestination&Version=2010-12-01Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending…
  • POSTUpdate configuration set reputation metrics enabled/#Action=UpdateConfigurationSetReputationMetricsEnabled?Action=UpdateConfigurationSetReputationMetricsEnabled&Version=2010-12-01Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation…
  • POSTUpdate configuration set sending enabled/#Action=UpdateConfigurationSetSendingEnabled?Action=UpdateConfigurationSetSendingEnabled&Version=2010-12-01Enables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services Region. You can use this operation in…
  • POSTUpdate configuration set tracking options/#Action=UpdateConfigurationSetTrackingOptions?Action=UpdateConfigurationSetTrackingOptions&Version=2010-12-01Modifies an association between a configuration set and a custom domain for open and click event tracking. By default, images and links used for tracking open…
  • POSTUpdate custom verification email template/#Action=UpdateCustomVerificationEmailTemplate?Action=UpdateCustomVerificationEmailTemplate&Version=2010-12-01Updates an existing custom verification email template. For more information about custom verification email templates, see Using Custom Verification Email…
  • POSTUpdate receipt rule/#Action=UpdateReceiptRule?Action=UpdateReceiptRule&Version=2010-12-01Updates a receipt rule. For information about managing receipt rules, see the Amazon SES Developer Guide . You can execute this operation no more than once…
  • POSTUpdate template/#Action=UpdateTemplate?Action=UpdateTemplate&Version=2010-12-01Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see…
  • POSTVerify domain dkim/#Action=VerifyDomainDkim?Action=VerifyDomainDkim&Version=2010-12-01Returns a set of DKIM tokens for a domain identity. When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of…
  • POSTVerify domain identity/#Action=VerifyDomainIdentity?Action=VerifyDomainIdentity&Version=2010-12-01Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information…
  • POSTVerify email address/#Action=VerifyEmailAddress?Action=VerifyEmailAddress&Version=2010-12-01Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
  • POSTVerify email identity/#Action=VerifyEmailIdentity?Action=VerifyEmailIdentity&Version=2010-12-01Adds 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…

API details

Base URL
https://email.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
71 operations on 71 pathsPOST 71
Description format
AWS Smithy model, API version 2010-12-01

How to test the Amazon Simple Email Service 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 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 “Clone receipt rule set” (POST /#Action=CloneReceiptRuleSet?Action=CloneReceiptRuleSet&Version=2010-12-01), 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?

Amazon Simple Email Service This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This… It is listed under Communication and has 71 endpoints.

Who publishes the Amazon Simple Email Service?

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?

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?

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

How many endpoints does the Amazon Simple Email Service have?

71 operations on 71 paths (71 POST).

Is forking the Amazon Simple Email Service 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.