The name of the receipt rule set. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain 64 characters or fewer.
The date and time the receipt rule set was created.
" } }, "documentation":"Information about a receipt rule set.
A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide.
" }, "ReceiptRuleSetName":{"type":"string"}, "ReceiptRuleSetsLists":{ "type":"list", "member":{"shape":"ReceiptRuleSetMetadata"} }, "ReceiptRulesList":{ "type":"list", "member":{"shape":"ReceiptRule"} }, "Recipient":{"type":"string"}, "RecipientDsnFields":{ "type":"structure", "required":[ "Action", "Status" ], "members":{ "FinalRecipient":{ "shape":"Address", "documentation":"The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient is set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.
Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
" }, "RemoteMta":{ "shape":"RemoteMta", "documentation":"The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.
The status code that indicates what went wrong. This is required by RFC 3464.
" }, "DiagnosticCode":{ "shape":"DiagnosticCode", "documentation":"An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
" }, "LastAttemptDate":{ "shape":"LastAttemptDate", "documentation":"The time the final delivery attempt was made, in RFC 822 date-time format.
" }, "ExtensionFields":{ "shape":"ExtensionFieldList", "documentation":"Additional X-headers to include in the DSN.
" } }, "documentation":"Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
" }, "RecipientsList":{ "type":"list", "member":{"shape":"Recipient"} }, "RemoteMta":{"type":"string"}, "RenderedTemplate":{"type":"string"}, "ReorderReceiptRuleSetRequest":{ "type":"structure", "required":[ "RuleSetName", "RuleNames" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"The name of the receipt rule set to reorder.
" }, "RuleNames":{ "shape":"ReceiptRuleNamesList", "documentation":"The specified receipt rule set's receipt rules, in order.
" } }, "documentation":"Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "ReorderReceiptRuleSetResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "ReportingMta":{"type":"string"}, "ReputationOptions":{ "type":"structure", "members":{ "SendingEnabled":{ "shape":"Enabled", "documentation":"Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES sends emails that use the configuration set. If the value is false, Amazon SES does not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.
Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.
The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.
When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset.
If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null.
Contains information about the reputation settings for a configuration set.
" }, "RuleDoesNotExistException":{ "type":"structure", "members":{ "Name":{ "shape":"RuleOrRuleSetName", "documentation":"Indicates that the named receipt rule does not exist.
" } }, "documentation":"Indicates that the provided receipt rule does not exist.
", "error":{ "code":"RuleDoesNotExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "RuleOrRuleSetName":{"type":"string"}, "RuleSetDoesNotExistException":{ "type":"structure", "members":{ "Name":{ "shape":"RuleOrRuleSetName", "documentation":"Indicates that the named receipt rule set does not exist.
" } }, "documentation":"Indicates that the provided receipt rule set does not exist.
", "error":{ "code":"RuleSetDoesNotExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "S3Action":{ "type":"structure", "required":["BucketName"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" }, "BucketName":{ "shape":"S3BucketName", "documentation":"The name of the Amazon S3 bucket for incoming email.
" }, "ObjectKeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
" }, "KmsKeyArn":{ "shape":"AmazonResourceName", "documentation":"The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key that you created in Amazon Web Services KMS as follows:
To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your Amazon Web Services account ID is 123456789012 and you want to use the default master key in the US West (Oregon) Region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.
To use a custom master key that you created in Amazon Web Services KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.
For more information about key policies, see the Amazon Web Services KMS Developer Guide. If you do not specify a master key, Amazon SES does not encrypt your emails.
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your Amazon Web Services KMS keys for decryption. This encryption client is currently available with the Amazon Web Services SDK for Java and Amazon Web Services SDK for Ruby only. For more information about client-side encryption using Amazon Web Services KMS master keys, see the Amazon S3 Developer Guide.
When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to write emails to your Amazon S3 bucket, use an Amazon Web Services KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about granting permissions, see the Amazon SES Developer Guide.
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 40 MB. Emails larger than that bounces.
For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.
" }, "S3BucketName":{"type":"string"}, "S3KeyPrefix":{"type":"string"}, "SNSAction":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" }, "Encoding":{ "shape":"SNSActionEncoding", "documentation":"The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
" } }, "documentation":"When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.
If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.
You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.
For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.
" }, "SNSActionEncoding":{ "type":"string", "enum":[ "UTF-8", "Base64" ] }, "SNSDestination":{ "type":"structure", "required":["TopicARN"], "members":{ "TopicARN":{ "shape":"AmazonResourceName", "documentation":"The ARN of the Amazon SNS topic for email sending events. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } }, "documentation":"Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "SendBounceRequest":{ "type":"structure", "required":[ "OriginalMessageId", "BounceSender", "BouncedRecipientInfoList" ], "members":{ "OriginalMessageId":{ "shape":"MessageId", "documentation":"The message ID of the message to be bounced.
" }, "BounceSender":{ "shape":"Address", "documentation":"The address to use in the \"From\" header of the bounce message. This must be an identity that you have verified with Amazon SES.
" }, "Explanation":{ "shape":"Explanation", "documentation":"Human-readable text for the bounce message to explain the failure. If not specified, the text is auto-generated based on the bounced recipient information.
" }, "MessageDsn":{ "shape":"MessageDsn", "documentation":"Message-related DSN fields. If not specified, Amazon SES chooses the values.
" }, "BouncedRecipientInfoList":{ "shape":"BouncedRecipientInfoList", "documentation":"A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the \"From\" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.
" } }, "documentation":"Represents a request to send a bounce message to the sender of an email you received through Amazon SES.
" }, "SendBounceResponse":{ "type":"structure", "members":{ "MessageId":{ "shape":"MessageId", "documentation":"The message ID of the bounce message.
" } }, "documentation":"Represents a unique message ID.
" }, "SendBulkTemplatedEmailRequest":{ "type":"structure", "required":[ "Source", "Template", "Destinations" ], "members":{ "Source":{ "shape":"Address", "documentation":"The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" }, "ReplyToAddresses":{ "shape":"AddressList", "documentation":"The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
" }, "ReturnPath":{ "shape":"Address", "documentation":"The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" }, "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.
A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.
The template to use when sending this email.
" }, "TemplateArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the template to use when sending this email.
" }, "DefaultTemplateData":{ "shape":"TemplateData", "documentation":"A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.
The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
" }, "Destinations":{ "shape":"BulkEmailDestinationList", "documentation":"One or more Destination objects. All of the recipients in a Destination receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.
Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "SendBulkTemplatedEmailResponse":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"BulkEmailDestinationStatusList", "documentation":"One object per intended recipient. Check each response object and retry any messages with a failure status. (Note that order of responses will be respective to order of destinations in the request.)Receipt rules enable you to specify which actions
" } } }, "SendCustomVerificationEmailRequest":{ "type":"structure", "required":[ "EmailAddress", "TemplateName" ], "members":{ "EmailAddress":{ "shape":"Address", "documentation":"The email address to verify.
" }, "TemplateName":{ "shape":"TemplateName", "documentation":"The name of the custom verification email template to use when sending the verification email.
" }, "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"Name of a configuration set to use when sending the verification email.
" } }, "documentation":"Represents a request to send a custom verification email to a specified recipient.
" }, "SendCustomVerificationEmailResponse":{ "type":"structure", "members":{ "MessageId":{ "shape":"MessageId", "documentation":"The unique message identifier returned from the SendCustomVerificationEmail operation.
The response received when attempting to send the custom verification email.
" }, "SendDataPoint":{ "type":"structure", "members":{ "Timestamp":{ "shape":"Timestamp", "documentation":"Time of the data point.
" }, "DeliveryAttempts":{ "shape":"Counter", "documentation":"Number of emails that have been sent.
" }, "Bounces":{ "shape":"Counter", "documentation":"Number of emails that have bounced.
" }, "Complaints":{ "shape":"Counter", "documentation":"Number of unwanted emails that were rejected by recipients.
" }, "Rejects":{ "shape":"Counter", "documentation":"Number of emails rejected by Amazon SES.
" } }, "documentation":"Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
The destination for this email, composed of To:, CC:, and BCC: fields.
" }, "Message":{ "shape":"Message", "documentation":"The message to be sent.
" }, "ReplyToAddresses":{ "shape":"AddressList", "documentation":"The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
" }, "ReturnPath":{ "shape":"Address", "documentation":"The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" }, "ReturnPathArn":{ "shape":"AmazonResourceName", "documentation":"This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" }, "Tags":{ "shape":"MessageTagList", "documentation":"A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
The name of the configuration set to use when you send an email using SendEmail.
Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "SendEmailResponse":{ "type":"structure", "required":["MessageId"], "members":{ "MessageId":{ "shape":"MessageId", "documentation":"The unique message identifier returned from the SendEmail action.
Represents a unique message ID.
" }, "SendRawEmailRequest":{ "type":"structure", "required":["RawMessage"], "members":{ "Source":{ "shape":"Address", "documentation":"The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)
Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints are sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
" }, "RawMessage":{ "shape":"RawMessage", "documentation":"The raw email message itself. The message has to meet the following criteria:
The message has to contain a header and a body, separated by a blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.
The entire message must be base64-encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.
Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular \"From\" address in the header of the raw email.
Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
The name of the configuration set to use when you send an email using SendRawEmail.
Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "SendRawEmailResponse":{ "type":"structure", "required":["MessageId"], "members":{ "MessageId":{ "shape":"MessageId", "documentation":"The unique message identifier returned from the SendRawEmail action.
Represents a unique message ID.
" }, "SendTemplatedEmailRequest":{ "type":"structure", "required":[ "Source", "Destination", "Template", "TemplateData" ], "members":{ "Source":{ "shape":"Address", "documentation":"The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. for this reason, The email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the \"friendly from\" name. If you want to use Unicode characters in the \"friendly from\" name, you must encode the \"friendly from\" name using MIME encoded-word syntax, as described in Sending raw email using the Amazon SES API. For more information about Punycode, see RFC 3492.
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
" }, "ReplyToAddresses":{ "shape":"AddressList", "documentation":"The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.
" }, "ReturnPath":{ "shape":"Address", "documentation":"The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient's ISP; this message is forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" }, "ReturnPathArn":{ "shape":"AmazonResourceName", "documentation":"This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide.
" }, "Tags":{ "shape":"MessageTagList", "documentation":"A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
The name of the configuration set to use when you send an email using SendTemplatedEmail.
The template to use when sending this email.
" }, "TemplateArn":{ "shape":"AmazonResourceName", "documentation":"The ARN of the template to use when sending this email.
" }, "TemplateData":{ "shape":"TemplateData", "documentation":"A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
" } }, "documentation":"Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "SendTemplatedEmailResponse":{ "type":"structure", "required":["MessageId"], "members":{ "MessageId":{ "shape":"MessageId", "documentation":"The unique message identifier returned from the SendTemplatedEmail action.
The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
" } }, "documentation":"Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "SetActiveReceiptRuleSetResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "SetIdentityDkimEnabledRequest":{ "type":"structure", "required":[ "Identity", "DkimEnabled" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"The identity for which DKIM signing should be enabled or disabled.
" }, "DkimEnabled":{ "shape":"Enabled", "documentation":"Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.
Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
" }, "SetIdentityDkimEnabledResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "SetIdentityFeedbackForwardingEnabledRequest":{ "type":"structure", "required":[ "Identity", "ForwardingEnabled" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.
Sets whether Amazon SES forwards bounce and complaint notifications as email. true specifies that Amazon SES forwards bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES publishes bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.
Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.
" }, "SetIdentityFeedbackForwardingEnabledResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "SetIdentityHeadersInNotificationsEnabledRequest":{ "type":"structure", "required":[ "Identity", "NotificationType", "Enabled" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.
The notification type for which to enable or disable headers in notifications.
" }, "Enabled":{ "shape":"Enabled", "documentation":"Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES includes headers in notifications, and a value of false specifies that Amazon SES does not include headers in notifications.
This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.
Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.
" }, "SetIdentityHeadersInNotificationsEnabledResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "SetIdentityMailFromDomainRequest":{ "type":"structure", "required":["Identity"], "members":{ "Identity":{ "shape":"Identity", "documentation":"The verified identity.
" }, "MailFromDomain":{ "shape":"MailFromDomainName", "documentation":"The custom MAIL FROM domain for the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.
The action for Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES returns a MailFromDomainNotVerified error and not send the email.
The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.
Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
" }, "SetIdentityMailFromDomainResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "SetIdentityNotificationTopicRequest":{ "type":"structure", "required":[ "Identity", "NotificationType" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"The identity (email address or domain) for the Amazon SNS topic.
You can only specify a verified identity for this parameter.
You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
The type of notifications that are published to the specified Amazon SNS topic.
" }, "SnsTopic":{ "shape":"NotificationTopic", "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.
Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or delivery notifications for emails sent with that identity as the source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
" }, "SetIdentityNotificationTopicResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "SetReceiptRulePositionRequest":{ "type":"structure", "required":[ "RuleSetName", "RuleName" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"The name of the receipt rule set that contains the receipt rule to reposition.
" }, "RuleName":{ "shape":"ReceiptRuleName", "documentation":"The name of the receipt rule to reposition.
" }, "After":{ "shape":"ReceiptRuleName", "documentation":"The name of the receipt rule after which to place the specified receipt rule.
" } }, "documentation":"Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "SetReceiptRulePositionResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "StopAction":{ "type":"structure", "required":["Scope"], "members":{ "Scope":{ "shape":"StopScope", "documentation":"The scope of the StopAction. The only acceptable value is RuleSet.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" } }, "documentation":"When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.
" }, "StopScope":{ "type":"string", "enum":["RuleSet"] }, "Subject":{"type":"string"}, "SubjectPart":{"type":"string"}, "SuccessRedirectionURL":{"type":"string"}, "Template":{ "type":"structure", "required":["TemplateName"], "members":{ "TemplateName":{ "shape":"TemplateName", "documentation":"The name of the template. You use this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
The subject line of the email.
" }, "TextPart":{ "shape":"TextPart", "documentation":"The email body that is visible to recipients whose email clients do not display HTML content.
" }, "HtmlPart":{ "shape":"HtmlPart", "documentation":"The HTML body of the email.
" } }, "documentation":"The content of the email, composed of a subject line and either an HTML part or a text-only part.
" }, "TemplateContent":{"type":"string"}, "TemplateData":{ "type":"string", "max":262144 }, "TemplateDoesNotExistException":{ "type":"structure", "members":{ "TemplateName":{"shape":"TemplateName"} }, "documentation":"Indicates that the Template object you specified does not exist in your Amazon SES account.
", "error":{ "code":"TemplateDoesNotExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TemplateMetadata":{ "type":"structure", "members":{ "Name":{ "shape":"TemplateName", "documentation":"The name of the template.
" }, "CreatedTimestamp":{ "shape":"Timestamp", "documentation":"The time and date the template was created.
" } }, "documentation":"Contains information about an email template.
" }, "TemplateMetadataList":{ "type":"list", "member":{"shape":"TemplateMetadata"} }, "TemplateName":{"type":"string"}, "TestRenderTemplateRequest":{ "type":"structure", "required":[ "TemplateName", "TemplateData" ], "members":{ "TemplateName":{ "shape":"TemplateName", "documentation":"The name of the template to render.
" }, "TemplateData":{ "shape":"TemplateData", "documentation":"A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
" } } }, "TestRenderTemplateResponse":{ "type":"structure", "members":{ "RenderedTemplate":{ "shape":"RenderedTemplate", "documentation":"The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.
" } } }, "TextPart":{"type":"string"}, "Timestamp":{"type":"timestamp"}, "TlsPolicy":{ "type":"string", "enum":[ "Require", "Optional" ] }, "TrackingOptions":{ "type":"structure", "members":{ "CustomRedirectDomain":{ "shape":"CustomRedirectDomain", "documentation":"The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain.
" } }, "documentation":"A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.
" }, "TrackingOptionsAlreadyExistsException":{ "type":"structure", "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"Indicates that a TrackingOptions object already exists in the specified configuration set.
" } }, "documentation":"Indicates that the configuration set you specified already contains a TrackingOptions object.
", "error":{ "code":"TrackingOptionsAlreadyExistsException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TrackingOptionsDoesNotExistException":{ "type":"structure", "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"Indicates that a TrackingOptions object does not exist in the specified configuration set.
" } }, "documentation":"Indicates that the TrackingOptions object you specified does not exist.
", "error":{ "code":"TrackingOptionsDoesNotExistException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "UpdateAccountSendingEnabledRequest":{ "type":"structure", "members":{ "Enabled":{ "shape":"Enabled", "documentation":"Describes whether email sending is enabled or disabled for your Amazon SES account in the current Amazon Web Services Region.
" } }, "documentation":"Represents a request to enable or disable the email sending capabilities for your entire Amazon SES account.
" }, "UpdateConfigurationSetEventDestinationRequest":{ "type":"structure", "required":[ "ConfigurationSetName", "EventDestination" ], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"The name of the configuration set that contains the event destination.
" }, "EventDestination":{ "shape":"EventDestination", "documentation":"The event destination object.
" } }, "documentation":"Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "UpdateConfigurationSetEventDestinationResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "UpdateConfigurationSetReputationMetricsEnabledRequest":{ "type":"structure", "required":[ "ConfigurationSetName", "Enabled" ], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"The name of the configuration set to update.
" }, "Enabled":{ "shape":"Enabled", "documentation":"Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
" } }, "documentation":"Represents a request to modify the reputation metric publishing settings for a configuration set.
" }, "UpdateConfigurationSetSendingEnabledRequest":{ "type":"structure", "required":[ "ConfigurationSetName", "Enabled" ], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"The name of the configuration set to update.
" }, "Enabled":{ "shape":"Enabled", "documentation":"Describes whether email sending is enabled or disabled for the configuration set.
" } }, "documentation":"Represents a request to enable or disable the email sending capabilities for a specific configuration set.
" }, "UpdateConfigurationSetTrackingOptionsRequest":{ "type":"structure", "required":[ "ConfigurationSetName", "TrackingOptions" ], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"The name of the configuration set.
" }, "TrackingOptions":{"shape":"TrackingOptions"} }, "documentation":"Represents a request to update the tracking options for a configuration set.
" }, "UpdateConfigurationSetTrackingOptionsResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "UpdateCustomVerificationEmailTemplateRequest":{ "type":"structure", "required":["TemplateName"], "members":{ "TemplateName":{ "shape":"TemplateName", "documentation":"The name of the custom verification email template to update.
" }, "FromEmailAddress":{ "shape":"FromAddress", "documentation":"The email address that the custom verification email is sent from.
" }, "TemplateSubject":{ "shape":"Subject", "documentation":"The subject line of the custom verification email.
" }, "TemplateContent":{ "shape":"TemplateContent", "documentation":"The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
" }, "SuccessRedirectionURL":{ "shape":"SuccessRedirectionURL", "documentation":"The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
" }, "FailureRedirectionURL":{ "shape":"FailureRedirectionURL", "documentation":"The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
" } }, "documentation":"Represents a request to update an existing custom verification email template.
" }, "UpdateReceiptRuleRequest":{ "type":"structure", "required":[ "RuleSetName", "Rule" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"The name of the receipt rule set that the receipt rule belongs to.
" }, "Rule":{ "shape":"ReceiptRule", "documentation":"A data structure that contains the updated receipt rule information.
" } }, "documentation":"Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "UpdateReceiptRuleResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "UpdateTemplateRequest":{ "type":"structure", "required":["Template"], "members":{ "Template":{"shape":"Template"} } }, "UpdateTemplateResponse":{ "type":"structure", "members":{ } }, "VerificationAttributes":{ "type":"map", "key":{"shape":"Identity"}, "value":{"shape":"IdentityVerificationAttributes"} }, "VerificationStatus":{ "type":"string", "enum":[ "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted" ] }, "VerificationToken":{"type":"string"}, "VerificationTokenList":{ "type":"list", "member":{"shape":"VerificationToken"} }, "VerifyDomainDkimRequest":{ "type":"structure", "required":["Domain"], "members":{ "Domain":{ "shape":"Domain", "documentation":"The name of the domain to be verified for Easy DKIM signing.
" } }, "documentation":"Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
" }, "VerifyDomainDkimResponse":{ "type":"structure", "required":["DkimTokens"], "members":{ "DkimTokens":{ "shape":"VerificationTokenList", "documentation":"A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
" } }, "documentation":"Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.
" }, "VerifyDomainIdentityRequest":{ "type":"structure", "required":["Domain"], "members":{ "Domain":{ "shape":"Domain", "documentation":"The domain to be verified.
" } }, "documentation":"Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.
" }, "VerifyDomainIdentityResponse":{ "type":"structure", "required":["VerificationToken"], "members":{ "VerificationToken":{ "shape":"VerificationToken", "documentation":"A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.
As Amazon SES searches for the TXT record, the domain's verification status is \"Pending\". When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, to verify the domain, you must restart the verification process from the beginning. The domain's verification status also changes to \"Success\" when it is DKIM verified.
" } }, "documentation":"Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.
" }, "VerifyEmailAddressRequest":{ "type":"structure", "required":["EmailAddress"], "members":{ "EmailAddress":{ "shape":"Address", "documentation":"The email address to be verified.
" } }, "documentation":"Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
" }, "VerifyEmailIdentityRequest":{ "type":"structure", "required":["EmailAddress"], "members":{ "EmailAddress":{ "shape":"Address", "documentation":"The email address to be verified.
" } }, "documentation":"Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.
" }, "VerifyEmailIdentityResponse":{ "type":"structure", "members":{ }, "documentation":"An empty element returned on a successful request.
" }, "WorkmailAction":{ "type":"structure", "required":["OrganizationArn"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
" }, "OrganizationArn":{ "shape":"AmazonResourceName", "documentation":"The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following format:
arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with \"m-\", followed by a string of alphanumeric characters.
For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.
" } }, "documentation":"When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.
For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.
" } }, "documentation":"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:
" }