{
"api_version": "2010-12-01",
"type": "query",
"result_wrapped": true,
"signature_version": "v4",
"signing_name": "ses",
"service_full_name": "Amazon Simple Email Service",
"service_abbreviation": "Amazon SES",
"endpoint_prefix": "email",
"xmlnamespace": "http://ses.amazonaws.com/doc/2010-12-01/",
"documentation": "\n
\n This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be\n used in conjunction with the Amazon SES Developer Guide.\n
\n\n For specific details on how to construct a service request, please consult the Amazon SES Developer Guide.\n
\nhttps://email.us-east-1.amazonaws.com
\n The identity to be removed from the list of identities for the AWS Account.
\n ", "required": true } }, "documentation": "\nRepresents a request instructing the service to delete an identity from the list of identities for the AWS Account.
\n " }, "output": { "shape_name": "DeleteIdentityResponse", "type": "structure", "members": {}, "documentation": "\nAn empty element. Receiving this element indicates that the request completed successfully.
\n " }, "errors": [], "documentation": "\nDeletes the specified identity (email address or domain) from the list of verified identities.
\nThis action is throttled at one request per second.
\nAn email address to be removed from the list of verified addresses.
\n ", "required": true } }, "documentation": "\nRepresents a request instructing the service to delete an address from the list of verified email addresses.
\n " }, "output": null, "errors": [], "documentation": "\nDeletes the specified email address from the list of verified addresses.
\nThis action is throttled at one request per second.
\nA list of one or more verified identities - email addresses, domains, or both.
\n ", "required": true } }, "documentation": "\nGiven a list of verified identities, describes their DKIM attributes. The DKIM attributes of an email address\n identity includes whether DKIM signing is individually enabled or disabled for that address. The DKIM attributes\n of a domain name identity includes whether DKIM signing is enabled, as well as the DNS records (tokens)\n that must remain published in the domain name's DNS.
\n " }, "output": { "shape_name": "GetIdentityDkimAttributesResponse", "type": "structure", "members": { "DkimAttributes": { "shape_name": "DkimAttributes", "type": "map", "keys": { "shape_name": "Identity", "type": "string", "documentation": null }, "members": { "shape_name": "IdentityDkimAttributes", "type": "structure", "members": { "DkimEnabled": { "shape_name": "Enabled", "type": "boolean", "documentation": "\nTrue if DKIM signing is enabled for email sent from the identity; false otherwise.
\n ", "required": true }, "DkimVerificationStatus": { "shape_name": "VerificationStatus", "type": "string", "enum": [ "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted" ], "documentation": "\nDescribes whether Amazon SES has successfully verified the DKIM DNS records\n (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
\n ", "required": true }, "DkimTokens": { "shape_name": "VerificationTokenList", "type": "list", "members": { "shape_name": "VerificationToken", "type": "string", "documentation": null }, "documentation": "\nA set of character strings that represent the domain's identity. Using these tokens, you\n will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon\n SES. Amazon Web Services will eventually detect that you have updated your DNS records;\n this detection process may take up to 72 hours. Upon successful detection, Amazon SES\n will be able to DKIM-sign email originating from that domain. (This only applies to\n domain identities, not email address identities.)
\nFor more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.
\n " } }, "documentation": "\nRepresents the DKIM attributes of a verified email address or a domain.
\n " }, "documentation": "\nThe DKIM attributes for an email address or a domain.
\n ", "required": true } }, "documentation": "\nRepresents a list of all the DKIM attributes for the specified identity.
\n \n " }, "errors": [], "documentation": "\nReturns the current status of Easy DKIM signing for an entity. For domain name\n identities, this action also returns the DKIM tokens that are required for Easy DKIM\n signing, and whether Amazon SES has successfully verified that these tokens have been\n published.
\nThis action takes a list of identities as input and returns the following\n information for each:
\nThis action is throttled at one request per second.
\nFor more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.
\nA list of one or more identities.
\n ", "required": true } }, "documentation": "\n \n " }, "output": { "shape_name": "GetIdentityNotificationAttributesResponse", "type": "structure", "members": { "NotificationAttributes": { "shape_name": "NotificationAttributes", "type": "map", "keys": { "shape_name": "Identity", "type": "string", "documentation": null }, "members": { "shape_name": "IdentityNotificationAttributes", "type": "structure", "members": { "BounceTopic": { "shape_name": "NotificationTopic", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n where Amazon SES will publish bounce notifications.
\n ", "required": true }, "ComplaintTopic": { "shape_name": "NotificationTopic", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n where Amazon SES will publish complaint notifications.
\n ", "required": true }, "ForwardingEnabled": { "shape_name": "Enabled", "type": "boolean", "documentation": "\nDescribes whether Amazon SES will forward feedback as email. true
indicates \n that Amazon SES will forward feedback as email, while false
indicates that \n feedback will be published only to the specified Bounce and Complaint topics.
Represents the notification attributes of an identity, including whether a bounce \n or complaint topic are set, and whether feedback forwarding is enabled.
\n " }, "documentation": "\nA map of Identity to IdentityNotificationAttributes.
\n ", "required": true } }, "documentation": "\nDescribes whether an identity has a bounce topic or complaint topic set, or feedback \n forwarding enabled.
\n " }, "errors": [], "documentation": "\nGiven a list of verified identities (email addresses and/or domains), returns a structure describing identity \n notification attributes.
\nThis action is throttled at one request per second.
\nFor more information about feedback notification, see the \n Amazon SES Developer Guide.
\nA list of identities.
\n ", "required": true } }, "documentation": "\nRepresents a request instructing the service to provide the verification attributes for a list of identities.
\n " }, "output": { "shape_name": "GetIdentityVerificationAttributesResponse", "type": "structure", "members": { "VerificationAttributes": { "shape_name": "VerificationAttributes", "type": "map", "keys": { "shape_name": "Identity", "type": "string", "documentation": null }, "members": { "shape_name": "IdentityVerificationAttributes", "type": "structure", "members": { "VerificationStatus": { "shape_name": "VerificationStatus", "type": "string", "enum": [ "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted" ], "documentation": "\nThe verification status of the identity: \"Pending\", \"Success\", \"Failed\", or \"TemporaryFailure\".
\n ", "required": true }, "VerificationToken": { "shape_name": "VerificationToken", "type": "string", "documentation": "\nThe verification token for a domain identity. Null for email address identities.
\n " } }, "documentation": "\nRepresents the verification attributes of a single identity.
\n " }, "documentation": "\nA map of Identities to IdentityVerificationAttributes objects.
\n ", "required": true } }, "documentation": "\nRepresents the verification attributes for a list of identities.
\n " }, "errors": [], "documentation": "\nGiven a list of identities (email addresses and/or domains), returns the verification\n status and (for domain identities) the verification token for each identity.
\nThis action is throttled at one request per second.
\nThe maximum number of emails the user is allowed to send in a 24-hour interval.
\n " }, "MaxSendRate": { "shape_name": "MaxSendRate", "type": "double", "documentation": "\nThe maximum number of emails the user is allowed to send per second.
\n " }, "SentLast24Hours": { "shape_name": "SentLast24Hours", "type": "double", "documentation": "\nThe number of emails sent during the previous 24 hours.
\n " } }, "documentation": "\nRepresents the user's current activity limits returned from a successful\n GetSendQuota
\n request.\n
Returns the user's current sending limits.
\nThis action is throttled at one request per second.
\nTime of the data point.
\n " }, "DeliveryAttempts": { "shape_name": "Counter", "type": "long", "documentation": "\nNumber of emails that have been enqueued for sending.
\n " }, "Bounces": { "shape_name": "Counter", "type": "long", "documentation": "\nNumber of emails that have bounced.
\n " }, "Complaints": { "shape_name": "Counter", "type": "long", "documentation": "\nNumber of unwanted emails that were rejected by recipients.
\n " }, "Rejects": { "shape_name": "Counter", "type": "long", "documentation": "\nNumber of emails rejected by Amazon SES.
\n " } }, "documentation": "\nRepresents sending statistics data. Each\n SendDataPoint
\n contains statistics for a 15-minute period of sending activity.\n
A list of data points, each of which represents 15 minutes of activity.
\n " } }, "documentation": "\nRepresents a list of\n SendDataPoint
\n items returned from a successful\n GetSendStatistics
\n request. This list contains aggregated data from the previous two weeks of sending activity.\n
Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of\n sending activity.\n
\nEach data point in the list contains statistics for a 15-minute interval.
\nThis action is throttled at one request per second.
\nThe type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities will be listed.
\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\tThe token to use for pagination.
\n " }, "MaxItems": { "shape_name": "MaxItems", "type": "integer", "documentation": "\n\tThe maximum number of identities per page. Possible values are 1-100 inclusive.
\n " } }, "documentation": "\n\tRepresents a request instructing the service to list all identities for the AWS Account.
\n " }, "output": { "shape_name": "ListIdentitiesResponse", "type": "structure", "members": { "Identities": { "shape_name": "IdentityList", "type": "list", "members": { "shape_name": "Identity", "type": "string", "documentation": null }, "documentation": "\nA list of identities.
\n ", "required": true }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\nThe token used for pagination.
\n " } }, "documentation": "\n\tRepresents a list of all verified identities for the AWS Account.
\n " }, "errors": [], "documentation": "\nReturns a list containing all of the identities (email addresses and domains) for \n a specific AWS Account, regardless of verification status.
\nThis action is throttled at one request per second.
\nA list of email addresses that have been verified.
\n " } }, "documentation": "\nRepresents a list of all the email addresses verified for the current user.
\n " }, "errors": [], "documentation": "\nReturns a list containing all of the email addresses that have been verified.
\nThis action is throttled at one request per second.
\nThe identity's email address.
\n\n By default, the string must be 7-bit ASCII. If the text must contain any other characters, \n then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. \n MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=
. \n For more information, see RFC 2047.\n
The To: field(s) of the message.
\n " }, "CcAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\nThe CC: field(s) of the message.
\n " }, "BccAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\nThe BCC: field(s) of the message.
\n " } }, "documentation": "\nThe destination for this email, composed of To:, CC:, and BCC: fields.
\n ", "required": true }, "Message": { "shape_name": "Message", "type": "structure", "members": { "Subject": { "shape_name": "Content", "type": "structure", "members": { "Data": { "shape_name": "MessageData", "type": "string", "documentation": "\nThe textual data of the content.
\n ", "required": true }, "Charset": { "shape_name": "Charset", "type": "string", "documentation": "\nThe character set of the content.
\n " } }, "documentation": "\nThe subject of the message: A short summary of the content, which will appear in the recipient's inbox.
\n ", "required": true }, "Body": { "shape_name": "Body", "type": "structure", "members": { "Text": { "shape_name": "Content", "type": "structure", "members": { "Data": { "shape_name": "MessageData", "type": "string", "documentation": "\nThe textual data of the content.
\n ", "required": true }, "Charset": { "shape_name": "Charset", "type": "string", "documentation": "\nThe character set of the content.
\n " } }, "documentation": "\nThe content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile\n devices).\n
\n " }, "Html": { "shape_name": "Content", "type": "structure", "members": { "Data": { "shape_name": "MessageData", "type": "string", "documentation": "\nThe textual data of the content.
\n ", "required": true }, "Charset": { "shape_name": "Charset", "type": "string", "documentation": "\nThe character set of the content.
\n " } }, "documentation": "\nThe content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted\n text, and much more in an HTML message.\n
\n " } }, "documentation": "\nThe message body.
\n ", "required": true } }, "documentation": "\nThe message to be sent.
\n ", "required": true }, "ReplyToAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\nThe reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address\n will receive the reply.\n
\n " }, "ReturnPath": { "shape_name": "Address", "type": "string", "documentation": "\nThe email address to which bounce notifications are to be forwarded. If the message cannot be delivered to the\n recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded\n to the email address specified by the\n ReturnPath
\n parameter.\n
Represents a request instructing the service to send a single email message.
\nThis datatype can be used in application code to compose a message consisting of source, destination, message, reply-to, and return-path\n parts. This object can then be sent using the\n SendEmail
\n action.\n
The unique message identifier returned from the\n SendEmail
\n action.\n
Represents a unique message ID returned from a successful\n SendEmail
\n request.\n
Composes an email message based on input data, and then immediately queues the message\n for sending.\n
\nThe total size of the message cannot exceed 10 MB.
\nAmazon SES has a limit on the total number of recipients per message: The combined number\n of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email\n message to a larger audience, you can divide your recipient list into groups of 50 or\n fewer, and then call Amazon SES repeatedly to send the message to each group.\n
\nFor every message that you send, the total number of recipients (To:, CC: and BCC:) is\n counted against your\n sending quota\n - the maximum number of emails you can send in\n a 24-hour period. For information about your sending quota, go to the Amazon SES\n Developer Guide.\n
\nThe identity's email address.
\n\n By default, the string must be 7-bit ASCII. If the text must contain any other characters, \n then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. \n MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=
. \n For more information, see RFC 2047.\n
Source
\n parameter, then bounce notifications and\n complaints will be sent to this email address. This takes precedence over any\n Return-Path\n header that you might include in the raw text of the message.\n A list of destinations for the message.
\n " }, "RawMessage": { "shape_name": "RawMessage", "type": "structure", "members": { "Data": { "shape_name": "RawMessageData", "type": "blob", "documentation": "\nThe raw data of the message. The client must ensure that the message format complies with Internet email\n standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).\n
\nFor more information, go to the Amazon SES Developer Guide.\n
\n ", "required": true } }, "documentation": "\nThe raw text of the message. The client is responsible for ensuring the following:
\n\n
Represents a request instructing the service to send a raw email message.
\nThis datatype can be used in application code to compose a message consisting of source, destination, and raw message text. This object can\n then be sent using the\n SendRawEmail
\n action.\n
The unique message identifier returned from the\n SendRawEmail
\n action.\n
Represents a unique message ID returned from a successful\n SendRawEmail
\n request.\n
Sends an email message, with header and content specified by the client. The\n SendRawEmail
\n action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet\n email standards; otherwise, the message cannot be sent.\n
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
\nAmazon SES has a limit on the total number of recipients per message: The combined number\n of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email\n message to a larger audience, you can divide your recipient list into groups of 50 or\n fewer, and then call Amazon SES repeatedly to send the message to each group.\n
\nFor every message that you send, the total number of recipients (To:, CC: and BCC:) is\n counted against your\n sending quota\n - the maximum number of emails you can send in\n a 24-hour period. For information about your sending quota, go to the Amazon SES\n Developer Guide.\n
\nThe identity for which DKIM signing should be enabled or disabled.
\n ", "required": true }, "DkimEnabled": { "shape_name": "Enabled", "type": "boolean", "documentation": "\nSets whether DKIM signing is enabled for an identity. Set to true
to enable DKIM signing for this identity; \n false
to disable it.
Represents a request instructing the service to enable or disable DKIM signing for an identity.
\n " }, "output": { "shape_name": "SetIdentityDkimEnabledResponse", "type": "structure", "members": {}, "documentation": "\nAn empty element. Receiving this element indicates that the request completed successfully.
\n " }, "errors": [], "documentation": "\nEnables or disables Easy DKIM signing of email sent from an identity:
\nexample.com
), then Amazon SES will DKIM-sign\n all email sent by addresses under that domain name (e.g.,\n user@example.com
).For email addresses (e.g., user@example.com
), you can only enable Easy DKIM signing if the\n corresponding domain (e.g., example.com
) has been set up for Easy DKIM using the AWS Console or \n the VerifyDomainDkim
action.
This action is throttled at one request per second.
\nFor more information about Easy DKIM signing, go to the \n Amazon SES Developer Guide.
\n \nThe identity for which to set feedback notification forwarding. \n Examples: user@example.com
, example.com
.
Sets whether Amazon SES will forward feedback notifications as email. true
specifies \n that Amazon SES will forward feedback notifications as email, in addition to any Amazon SNS topic publishing \n otherwise specified. false
specifies that Amazon SES\n will publish feedback notifications only through Amazon SNS. This value can only be \n set to false
when topics are specified for both Bounce
and \n Complaint
topic types.
An empty element. Receiving this element indicates that the request completed successfully.
\n " }, "errors": [], "documentation": "\nGiven an identity (email address or domain), enables or disables whether Amazon SES forwards \n feedback notifications as email. Feedback forwarding may only be disabled when both complaint \n and bounce topics are set.
\nThis action is throttled at one request per second.
\nFor more information about feedback notification, \n see the Amazon SES Developer Guide.
\nThe identity for which the topic will be set. Examples: user@example.com
, example.com
.
The type of feedback notifications that will be published to the specified topic.
\n ", "required": true }, "SnsTopic": { "shape_name": "NotificationTopic", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic. \n If the parameter is omitted from the request or a null value is passed, the topic is cleared and publishing is disabled.
\n " } }, "documentation": "\nRepresents a request to set or clear an identity's notification topic.
\n " }, "output": { "shape_name": "SetIdentityNotificationTopicResponse", "type": "structure", "members": {}, "documentation": "\nAn empty element. Receiving this element indicates that the request completed successfully.
\n " }, "errors": [], "documentation": "\nGiven an identity (email address or domain), sets the Amazon SNS topic to which Amazon SES will publish \n bounce and complaint notifications for emails sent with that identity as the Source
. \n Publishing to topics may only be disabled when feedback forwarding is enabled.
This action is throttled at one request per second.
\nFor more information about feedback notification, see the\n Amazon SES Developer Guide.
\nThe name of the domain to be verified for Easy DKIM signing.
\n ", "required": true } }, "documentation": "\nRepresents a request instructing the service to begin DKIM verification for a domain.
\n " }, "output": { "shape_name": "VerifyDomainDkimResponse", "type": "structure", "members": { "DkimTokens": { "shape_name": "VerificationTokenList", "type": "list", "members": { "shape_name": "VerificationToken", "type": "string", "documentation": null }, "documentation": "\nA set of character strings that represent the domain's identity. If the identity is an\n email address, the tokens represent the domain of that address.
\nUsing these tokens, you will need to create DNS CNAME records that point to DKIM public\n keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have\n updated your DNS records; this detection process may take up to 72 hours. Upon\n successful detection, Amazon SES will be able to DKIM-sign emails originating from that\n domain.
\nFor more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.
\n ", "required": true } }, "documentation": "\nRepresents the DNS records that must be published in the domain name's DNS to complete\n DKIM setup.
\n " }, "errors": [], "documentation": "\nReturns a set of DKIM tokens for a domain. DKIM tokens are character strings that\n represent your domain's identity. Using these tokens, you will need to create DNS CNAME\n records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will\n eventually detect that you have updated your DNS records; this detection process may\n take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign\n email originating from that domain.
\nThis action is throttled at one request per second.
\nTo enable or disable Easy DKIM signing for\n a domain, use the SetIdentityDkimEnabled
action.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.
\nThe domain to be verified.
\n ", "required": true } }, "documentation": "\nRepresents a request instructing the service to begin domain verification.
\n " }, "output": { "shape_name": "VerifyDomainIdentityResponse", "type": "structure", "members": { "VerificationToken": { "shape_name": "VerificationToken", "type": "string", "documentation": "\nA TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.
\n ", "required": true } }, "documentation": "\nRepresents a token used for domain ownership verification.
\n " }, "errors": [], "documentation": "\nVerifies a domain.
\nThis action is throttled at one request per second.
\nThe email address to be verified.
\n ", "required": true } }, "documentation": "\nRepresents a request instructing the service to begin email address verification.
\n " }, "output": null, "errors": [], "documentation": "\nVerifies an email address. This action causes a confirmation email message to be \n sent to the specified address.
\nThis action is throttled at one request per second.
\nThe email address to be verified.
\n ", "required": true } }, "documentation": "\nRepresents a request instructing the service to begin email address verification.
\n " }, "output": { "shape_name": "VerifyEmailIdentityResponse", "type": "structure", "members": {}, "documentation": "\nAn empty element. Receiving this element indicates that the request completed successfully.
\n " }, "errors": [], "documentation": "\nVerifies an email address. This action causes a confirmation email message\n to be sent to the specified address.
\nThis action is throttled at one request per second.
\n