Creates 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 independent of the source rule set.
For information about setting up rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "CreateConfigurationSet": { "name": "CreateConfigurationSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateConfigurationSetRequest" }, "output": { "shape": "CreateConfigurationSetResponse", "resultWrapper": "CreateConfigurationSetResult" }, "errors": [ { "shape": "ConfigurationSetAlreadyExistsException" }, { "shape": "InvalidConfigurationSetException" }, { "shape": "LimitExceededException" } ], "documentation": "Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "CreateConfigurationSetEventDestination": { "name": "CreateConfigurationSetEventDestination", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateConfigurationSetEventDestinationRequest" }, "output": { "shape": "CreateConfigurationSetEventDestinationResponse", "resultWrapper": "CreateConfigurationSetEventDestinationResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "EventDestinationAlreadyExistsException" }, { "shape": "InvalidCloudWatchDestinationException" }, { "shape": "InvalidFirehoseDestinationException" }, { "shape": "InvalidSNSDestinationException" }, { "shape": "LimitExceededException" } ], "documentation": "Creates a configuration set event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the Amazon Web Services service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "CreateConfigurationSetTrackingOptions": { "name": "CreateConfigurationSetTrackingOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateConfigurationSetTrackingOptionsRequest" }, "output": { "shape": "CreateConfigurationSetTrackingOptionsResponse", "resultWrapper": "CreateConfigurationSetTrackingOptionsResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "TrackingOptionsAlreadyExistsException" }, { "shape": "InvalidTrackingOptionsException" } ], "documentation": "Creates 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 and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
" }, "CreateCustomVerificationEmailTemplate": { "name": "CreateCustomVerificationEmailTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateCustomVerificationEmailTemplateRequest" }, "errors": [ { "shape": "CustomVerificationEmailTemplateAlreadyExistsException" }, { "shape": "FromEmailAddressNotVerifiedException" }, { "shape": "CustomVerificationEmailInvalidContentException" }, { "shape": "LimitExceededException" } ], "documentation": "Creates a new custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "CreateReceiptFilter": { "name": "CreateReceiptFilter", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateReceiptFilterRequest" }, "output": { "shape": "CreateReceiptFilterResponse", "resultWrapper": "CreateReceiptFilterResult" }, "errors": [ { "shape": "LimitExceededException" }, { "shape": "AlreadyExistsException" } ], "documentation": "Creates 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 more than once per second.
" }, "CreateReceiptRule": { "name": "CreateReceiptRule", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateReceiptRuleRequest" }, "output": { "shape": "CreateReceiptRuleResponse", "resultWrapper": "CreateReceiptRuleResult" }, "errors": [ { "shape": "InvalidSnsTopicException" }, { "shape": "InvalidS3ConfigurationException" }, { "shape": "InvalidLambdaFunctionException" }, { "shape": "AlreadyExistsException" }, { "shape": "RuleDoesNotExistException" }, { "shape": "RuleSetDoesNotExistException" }, { "shape": "LimitExceededException" } ], "documentation": "Creates 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 per second.
" }, "CreateReceiptRuleSet": { "name": "CreateReceiptRuleSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateReceiptRuleSetRequest" }, "output": { "shape": "CreateReceiptRuleSetResponse", "resultWrapper": "CreateReceiptRuleSetResult" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "LimitExceededException" } ], "documentation": "Creates 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 more than once per second.
" }, "CreateTemplate": { "name": "CreateTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateTemplateRequest" }, "output": { "shape": "CreateTemplateResponse", "resultWrapper": "CreateTemplateResult" }, "errors": [ { "shape": "AlreadyExistsException" }, { "shape": "InvalidTemplateException" }, { "shape": "LimitExceededException" } ], "documentation": "Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DeleteConfigurationSet": { "name": "DeleteConfigurationSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteConfigurationSetRequest" }, "output": { "shape": "DeleteConfigurationSetResponse", "resultWrapper": "DeleteConfigurationSetResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" } ], "documentation": "Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DeleteConfigurationSetEventDestination": { "name": "DeleteConfigurationSetEventDestination", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteConfigurationSetEventDestinationRequest" }, "output": { "shape": "DeleteConfigurationSetEventDestinationResponse", "resultWrapper": "DeleteConfigurationSetEventDestinationResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "EventDestinationDoesNotExistException" } ], "documentation": "Deletes a configuration set event destination. Configuration set event destinations 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.
You can execute this operation no more than once per second.
" }, "DeleteConfigurationSetTrackingOptions": { "name": "DeleteConfigurationSetTrackingOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteConfigurationSetTrackingOptionsRequest" }, "output": { "shape": "DeleteConfigurationSetTrackingOptionsResponse", "resultWrapper": "DeleteConfigurationSetTrackingOptionsResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "TrackingOptionsDoesNotExistException" } ], "documentation": "Deletes 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 and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
Deleting this kind of association results in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
Deletes an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DeleteIdentity": { "name": "DeleteIdentity", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteIdentityRequest" }, "output": { "shape": "DeleteIdentityResponse", "resultWrapper": "DeleteIdentityResult" }, "documentation": "Deletes 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.
" }, "DeleteIdentityPolicy": { "name": "DeleteIdentityPolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteIdentityPolicyRequest" }, "output": { "shape": "DeleteIdentityPolicyResponse", "resultWrapper": "DeleteIdentityPolicyResult" }, "documentation": "Deletes the specified sending authorization policy for the given identity (an email address or a domain). This operation returns successfully even if a policy with the specified name does not exist.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DeleteReceiptFilter": { "name": "DeleteReceiptFilter", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteReceiptFilterRequest" }, "output": { "shape": "DeleteReceiptFilterResponse", "resultWrapper": "DeleteReceiptFilterResult" }, "documentation": "Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DeleteReceiptRule": { "name": "DeleteReceiptRule", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteReceiptRuleRequest" }, "output": { "shape": "DeleteReceiptRuleResponse", "resultWrapper": "DeleteReceiptRuleResult" }, "errors": [ { "shape": "RuleSetDoesNotExistException" } ], "documentation": "Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DeleteReceiptRuleSet": { "name": "DeleteReceiptRuleSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteReceiptRuleSetRequest" }, "output": { "shape": "DeleteReceiptRuleSetResponse", "resultWrapper": "DeleteReceiptRuleSetResult" }, "errors": [ { "shape": "CannotDeleteException" } ], "documentation": "Deletes the specified receipt rule set and all of the receipt rules it contains.
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DeleteTemplate": { "name": "DeleteTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteTemplateRequest" }, "output": { "shape": "DeleteTemplateResponse", "resultWrapper": "DeleteTemplateResult" }, "documentation": "Deletes an email template.
You can execute this operation no more than once per second.
" }, "DeleteVerifiedEmailAddress": { "name": "DeleteVerifiedEmailAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVerifiedEmailAddressRequest" }, "documentation": "Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
Returns 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 SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DescribeConfigurationSet": { "name": "DescribeConfigurationSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeConfigurationSetRequest" }, "output": { "shape": "DescribeConfigurationSetResponse", "resultWrapper": "DescribeConfigurationSetResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" } ], "documentation": "Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DescribeReceiptRule": { "name": "DescribeReceiptRule", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeReceiptRuleRequest" }, "output": { "shape": "DescribeReceiptRuleResponse", "resultWrapper": "DescribeReceiptRuleResult" }, "errors": [ { "shape": "RuleDoesNotExistException" }, { "shape": "RuleSetDoesNotExistException" } ], "documentation": "Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "DescribeReceiptRuleSet": { "name": "DescribeReceiptRuleSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeReceiptRuleSetRequest" }, "output": { "shape": "DescribeReceiptRuleSetResponse", "resultWrapper": "DescribeReceiptRuleSetResult" }, "errors": [ { "shape": "RuleSetDoesNotExistException" } ], "documentation": "Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "GetAccountSendingEnabled": { "name": "GetAccountSendingEnabled", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "GetAccountSendingEnabledResponse", "resultWrapper": "GetAccountSendingEnabledResult" }, "documentation": "Returns the email sending status of the Amazon SES account for the current Region.
You can execute this operation no more than once per second.
" }, "GetCustomVerificationEmailTemplate": { "name": "GetCustomVerificationEmailTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetCustomVerificationEmailTemplateRequest" }, "output": { "shape": "GetCustomVerificationEmailTemplateResponse", "resultWrapper": "GetCustomVerificationEmailTemplateResult" }, "errors": [ { "shape": "CustomVerificationEmailTemplateDoesNotExistException" } ], "documentation": "Returns the custom email verification template for the template name you specify.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "GetIdentityDkimAttributes": { "name": "GetIdentityDkimAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIdentityDkimAttributesRequest" }, "output": { "shape": "GetIdentityDkimAttributesResponse", "resultWrapper": "GetIdentityDkimAttributesResult" }, "documentation": "Returns 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 Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
Whether Easy DKIM signing is enabled or disabled.
A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
" }, "GetIdentityMailFromDomainAttributes": { "name": "GetIdentityMailFromDomainAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIdentityMailFromDomainAttributesRequest" }, "output": { "shape": "GetIdentityMailFromDomainAttributesResponse", "resultWrapper": "GetIdentityMailFromDomainAttributesResult" }, "documentation": "Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
" }, "GetIdentityNotificationAttributes": { "name": "GetIdentityNotificationAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIdentityNotificationAttributesRequest" }, "output": { "shape": "GetIdentityNotificationAttributesResponse", "resultWrapper": "GetIdentityNotificationAttributesResult" }, "documentation": "Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
" }, "GetIdentityPolicies": { "name": "GetIdentityPolicies", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIdentityPoliciesRequest" }, "output": { "shape": "GetIdentityPoliciesResponse", "resultWrapper": "GetIdentityPoliciesResult" }, "documentation": "Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "GetIdentityVerificationAttributes": { "name": "GetIdentityVerificationAttributes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetIdentityVerificationAttributesRequest" }, "output": { "shape": "GetIdentityVerificationAttributesResponse", "resultWrapper": "GetIdentityVerificationAttributesResult" }, "documentation": "Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is \"Pending\" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to \"Success\". If the link is not clicked within 24 hours, the verification status changes to \"Failed.\" In that case, to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is \"Pending\" as Amazon SES searches for the required TXT record in the DNS settings of the domain. 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.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
" }, "GetSendQuota": { "name": "GetSendQuota", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "GetSendQuotaResponse", "resultWrapper": "GetSendQuotaResult" }, "documentation": "Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
" }, "GetSendStatistics": { "name": "GetSendStatistics", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "GetSendStatisticsResponse", "resultWrapper": "GetSendStatisticsResult" }, "documentation": "Provides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
" }, "GetTemplate": { "name": "GetTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetTemplateRequest" }, "output": { "shape": "GetTemplateResponse", "resultWrapper": "GetTemplateResult" }, "errors": [ { "shape": "TemplateDoesNotExistException" } ], "documentation": "Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.
You can execute this operation no more than once per second.
" }, "ListConfigurationSets": { "name": "ListConfigurationSets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListConfigurationSetsRequest" }, "output": { "shape": "ListConfigurationSetsResponse", "resultWrapper": "ListConfigurationSetsResult" }, "documentation": "Provides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation returns up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation also returns NextToken. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "ListIdentities": { "name": "ListIdentities", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListIdentitiesRequest" }, "output": { "shape": "ListIdentitiesResponse", "resultWrapper": "ListIdentitiesResult" }, "documentation": "Returns a list containing all of the identities (email addresses and domains) for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status.
You can execute this operation no more than once per second.
It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the original call and received a NextToken in the response, you should continue providing the IdentityType=Domain parameter for further NextToken calls; however, if you didn't provide the IdentityType parameter in the original call, then continue to not provide it for successive pagination calls. Using this protocol will ensure consistent results.
Returns 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. To get the actual policy content, use GetIdentityPolicies.
This operation is for the identity owner only. If you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "ListReceiptFilters": { "name": "ListReceiptFilters", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListReceiptFiltersRequest" }, "output": { "shape": "ListReceiptFiltersResponse", "resultWrapper": "ListReceiptFiltersResult" }, "documentation": "Lists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services Region.
For information about managing IP address filters, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "ListReceiptRuleSets": { "name": "ListReceiptRuleSets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListReceiptRuleSetsRequest" }, "output": { "shape": "ListReceiptRuleSetsResponse", "resultWrapper": "ListReceiptRuleSetsResult" }, "documentation": "Lists 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 sets to be retrieved, you receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "ListTemplates": { "name": "ListTemplates", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTemplatesRequest" }, "output": { "shape": "ListTemplatesResponse", "resultWrapper": "ListTemplatesResult" }, "documentation": "Lists the email templates present in your Amazon SES account in the current Amazon Web Services Region.
You can execute this operation no more than once per second.
" }, "ListVerifiedEmailAddresses": { "name": "ListVerifiedEmailAddresses", "http": { "method": "POST", "requestUri": "/" }, "output": { "shape": "ListVerifiedEmailAddressesResponse", "resultWrapper": "ListVerifiedEmailAddressesResult" }, "documentation": "Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.
Adds or updates the delivery options for a configuration set.
" }, "PutIdentityPolicy": { "name": "PutIdentityPolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutIdentityPolicyRequest" }, "output": { "shape": "PutIdentityPolicyResponse", "resultWrapper": "PutIdentityPolicyResult" }, "errors": [ { "shape": "InvalidPolicyException" } ], "documentation": "Adds 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 you have not verified the identity, it returns an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "ReorderReceiptRuleSet": { "name": "ReorderReceiptRuleSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ReorderReceiptRuleSetRequest" }, "output": { "shape": "ReorderReceiptRuleSetResponse", "resultWrapper": "ReorderReceiptRuleSetResult" }, "errors": [ { "shape": "RuleSetDoesNotExistException" }, { "shape": "RuleDoesNotExistException" } ], "documentation": "Reorders 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 reorder request doesn't explicitly position all of the rules.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "SendBounce": { "name": "SendBounce", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SendBounceRequest" }, "output": { "shape": "SendBounceResponse", "resultWrapper": "SendBounceResult" }, "errors": [ { "shape": "MessageRejected" } ], "documentation": "Generates 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 after you receive it.
You cannot use this operation to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "SendBulkTemplatedEmail": { "name": "SendBulkTemplatedEmail", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SendBulkTemplatedEmailRequest" }, "output": { "shape": "SendBulkTemplatedEmailResponse", "resultWrapper": "SendBulkTemplatedEmailResult" }, "errors": [ { "shape": "MessageRejected" }, { "shape": "MailFromDomainNotVerifiedException" }, { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "TemplateDoesNotExistException" }, { "shape": "ConfigurationSetSendingPausedException" }, { "shape": "AccountSendingPausedException" } ], "documentation": "Composes an email message to multiple destinations. The message body is created using an email template.
To send email using this operation, your call must meet the following requirements:
The call must refer to an existing email template. You can create email templates using CreateTemplate.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group.
The number of destinations you can contact in a single call can be limited by your account's maximum sending rate.
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "SendEmail": { "name": "SendEmail", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SendEmailRequest" }, "output": { "shape": "SendEmailResponse", "resultWrapper": "SendEmailResult" }, "errors": [ { "shape": "MessageRejected" }, { "shape": "MailFromDomainNotVerifiedException" }, { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "ConfigurationSetSendingPausedException" }, { "shape": "AccountSendingPausedException" } ], "documentation": "Composes an email message and immediately queues it for sending. To send email using this operation, your message must meet the following requirements:
The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation results in an \"Email address not verified\" error.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
Composes an email message and immediately queues it for sending.
This operation is more flexible than the SendEmail operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you need to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.
The SendRawEmail operation has the following requirements:
You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an \"Email address not verified\" error.
If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.
The maximum message size, including attachments, is 10 MB.
Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.
If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.
Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.
Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.
Additionally, keep the following considerations in mind when using the SendRawEmail operation:
Although you can customize the message headers when using the SendRawEmail operation, Amazon SES automatically applies its own Message-ID and Date headers; if you passed these headers when creating the message, they are overwritten by the values that Amazon SES provides.
If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn, or you can include the following X-headers in the header of your raw email:
X-SES-SOURCE-ARN
X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN
Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.
If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.
For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
Composes 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 requirements:
The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.
The message must be sent from a verified email address or domain.
If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
The maximum message size is 10 MB.
Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients that receives the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.
The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message is rejected, even if the message contains other recipients that are valid.
If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.
Sets 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 with RuleSetName set to null.
For information about managing receipt rule sets, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "SetIdentityDkimEnabled": { "name": "SetIdentityDkimEnabled", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetIdentityDkimEnabledRequest" }, "output": { "shape": "SetIdentityDkimEnabledResponse", "resultWrapper": "SetIdentityDkimEnabledResult" }, "documentation": "Enables 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 email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.
For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.
You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.
" }, "SetIdentityFeedbackForwardingEnabled": { "name": "SetIdentityFeedbackForwardingEnabled", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetIdentityFeedbackForwardingEnabledRequest" }, "output": { "shape": "SetIdentityFeedbackForwardingEnabledResponse", "resultWrapper": "SetIdentityFeedbackForwardingEnabledResult" }, "documentation": "Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
" }, "SetIdentityHeadersInNotificationsEnabled": { "name": "SetIdentityHeadersInNotificationsEnabled", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetIdentityHeadersInNotificationsEnabledRequest" }, "output": { "shape": "SetIdentityHeadersInNotificationsEnabledResponse", "resultWrapper": "SetIdentityHeadersInNotificationsEnabledResult" }, "documentation": "Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.
" }, "SetIdentityMailFromDomain": { "name": "SetIdentityMailFromDomain", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetIdentityMailFromDomainRequest" }, "output": { "shape": "SetIdentityMailFromDomainResponse", "resultWrapper": "SetIdentityMailFromDomainResult" }, "documentation": "Enables 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 domain, you must add an MX record to your MAIL FROM domain's DNS settings. To ensure that your emails pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "SetIdentityNotificationTopic": { "name": "SetIdentityNotificationTopic", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetIdentityNotificationTopicRequest" }, "output": { "shape": "SetIdentityNotificationTopicResponse", "resultWrapper": "SetIdentityNotificationTopicResult" }, "documentation": "Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide.
" }, "SetReceiptRulePosition": { "name": "SetReceiptRulePosition", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "SetReceiptRulePositionRequest" }, "output": { "shape": "SetReceiptRulePositionResponse", "resultWrapper": "SetReceiptRulePositionResult" }, "errors": [ { "shape": "RuleSetDoesNotExistException" }, { "shape": "RuleDoesNotExistException" } ], "documentation": "Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "TestRenderTemplate": { "name": "TestRenderTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TestRenderTemplateRequest" }, "output": { "shape": "TestRenderTemplateResponse", "resultWrapper": "TestRenderTemplateResult" }, "errors": [ { "shape": "TemplateDoesNotExistException" }, { "shape": "InvalidRenderingParameterException" }, { "shape": "MissingRenderingAttributeException" } ], "documentation": "Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
You can execute this operation no more than once per second.
" }, "UpdateAccountSendingEnabled": { "name": "UpdateAccountSendingEnabled", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateAccountSendingEnabledRequest" }, "documentation": "Enables or disables email sending across your entire Amazon SES account in the current Amazon Web Services Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given Amazon Web Services Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
" }, "UpdateConfigurationSetEventDestination": { "name": "UpdateConfigurationSetEventDestination", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateConfigurationSetEventDestinationRequest" }, "output": { "shape": "UpdateConfigurationSetEventDestinationResponse", "resultWrapper": "UpdateConfigurationSetEventDestinationResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "EventDestinationDoesNotExistException" }, { "shape": "InvalidCloudWatchDestinationException" }, { "shape": "InvalidFirehoseDestinationException" }, { "shape": "InvalidSNSDestinationException" } ], "documentation": "Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
" }, "UpdateConfigurationSetReputationMetricsEnabled": { "name": "UpdateConfigurationSetReputationMetricsEnabled", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateConfigurationSetReputationMetricsEnabledRequest" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" } ], "documentation": "Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
" }, "UpdateConfigurationSetSendingEnabled": { "name": "UpdateConfigurationSetSendingEnabled", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateConfigurationSetSendingEnabledRequest" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" } ], "documentation": "Enables 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 conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
" }, "UpdateConfigurationSetTrackingOptions": { "name": "UpdateConfigurationSetTrackingOptions", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateConfigurationSetTrackingOptionsRequest" }, "output": { "shape": "UpdateConfigurationSetTrackingOptionsResponse", "resultWrapper": "UpdateConfigurationSetTrackingOptionsResult" }, "errors": [ { "shape": "ConfigurationSetDoesNotExistException" }, { "shape": "TrackingOptionsDoesNotExistException" }, { "shape": "InvalidTrackingOptionsException" } ], "documentation": "Modifies 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 and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.
" }, "UpdateCustomVerificationEmailTemplate": { "name": "UpdateCustomVerificationEmailTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateCustomVerificationEmailTemplateRequest" }, "errors": [ { "shape": "CustomVerificationEmailTemplateDoesNotExistException" }, { "shape": "FromEmailAddressNotVerifiedException" }, { "shape": "CustomVerificationEmailInvalidContentException" } ], "documentation": "Updates an existing custom verification email template.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "UpdateReceiptRule": { "name": "UpdateReceiptRule", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateReceiptRuleRequest" }, "output": { "shape": "UpdateReceiptRuleResponse", "resultWrapper": "UpdateReceiptRuleResult" }, "errors": [ { "shape": "InvalidSnsTopicException" }, { "shape": "InvalidS3ConfigurationException" }, { "shape": "InvalidLambdaFunctionException" }, { "shape": "RuleSetDoesNotExistException" }, { "shape": "RuleDoesNotExistException" }, { "shape": "LimitExceededException" } ], "documentation": "Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "UpdateTemplate": { "name": "UpdateTemplate", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateTemplateRequest" }, "output": { "shape": "UpdateTemplateResponse", "resultWrapper": "UpdateTemplateResult" }, "errors": [ { "shape": "TemplateDoesNotExistException" }, { "shape": "InvalidTemplateException" } ], "documentation": "Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "VerifyDomainDkim": { "name": "VerifyDomainDkim", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "VerifyDomainDkimRequest" }, "output": { "shape": "VerifyDomainDkimResponse", "resultWrapper": "VerifyDomainDkimResult" }, "documentation": "Returns 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 identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it.
You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
Name: token._domainkey.example.com
Type: CNAME
Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.
You can execute this operation no more than once per second.
" }, "VerifyDomainIdentity": { "name": "VerifyDomainIdentity", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "VerifyDomainIdentityRequest" }, "output": { "shape": "VerifyDomainIdentityResponse", "resultWrapper": "VerifyDomainIdentityResult" }, "documentation": "Adds 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 about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
" }, "VerifyEmailAddress": { "name": "VerifyEmailAddress", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "VerifyEmailAddressRequest" }, "documentation": "Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.
You can execute this operation no more than once per second.
" } }, "shapes": { "AddHeaderAction": { "type": "structure", "required": [ "HeaderName", "HeaderValue" ], "members": { "HeaderName": { "shape": "HeaderName", "documentation": "The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
" }, "HeaderValue": { "shape": "HeaderValue", "documentation": "The content to include in the header. This value can contain up to 2048 characters. It can't contain newline (\\n) or carriage return (\\r) characters.
When included in a receipt rule, this action adds a header to the received email.
For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.
" }, "Address": { "type": "string" }, "AddressList": { "type": "list", "member": { "shape": "Address" } }, "AmazonResourceName": { "type": "string" }, "ArrivalDate": { "type": "timestamp" }, "BehaviorOnMXFailure": { "type": "string", "enum": [ "UseDefaultValue", "RejectMessage" ] }, "Body": { "type": "structure", "members": { "Text": { "shape": "Content", "documentation": "The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
" }, "Html": { "shape": "Content", "documentation": "The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
" } }, "documentation": "Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.
" }, "BounceAction": { "type": "structure", "required": [ "SmtpReplyCode", "Message", "Sender" ], "members": { "TopicArn": { "shape": "AmazonResourceName", "documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. 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.
" }, "SmtpReplyCode": { "shape": "BounceSmtpReplyCode", "documentation": "The SMTP reply code, as defined by RFC 5321.
" }, "StatusCode": { "shape": "BounceStatusCode", "documentation": "The SMTP enhanced status code, as defined by RFC 3463.
" }, "Message": { "shape": "BounceMessage", "documentation": "Human-readable text to include in the bounce message.
" }, "Sender": { "shape": "Address", "documentation": "The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
" } }, "documentation": "When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.
" }, "BounceMessage": { "type": "string" }, "BounceSmtpReplyCode": { "type": "string" }, "BounceStatusCode": { "type": "string" }, "BounceType": { "type": "string", "enum": [ "DoesNotExist", "MessageTooLarge", "ExceededQuota", "ContentRejected", "Undefined", "TemporaryFailure" ] }, "BouncedRecipientInfo": { "type": "structure", "required": [ "Recipient" ], "members": { "Recipient": { "shape": "Address", "documentation": "The email address of the recipient of the bounced email.
" }, "RecipientArn": { "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 receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.
" }, "BounceType": { "shape": "BounceType", "documentation": "The reason for the bounce. You must provide either this parameter or RecipientDsnFields.
Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.
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.
" }, "BouncedRecipientInfoList": { "type": "list", "member": { "shape": "BouncedRecipientInfo" } }, "BulkEmailDestination": { "type": "structure", "required": [ "Destination" ], "members": { "Destination": { "shape": "Destination" }, "ReplacementTags": { "shape": "MessageTagList", "documentation": "A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
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": "An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.
" }, "BulkEmailDestinationList": { "type": "list", "member": { "shape": "BulkEmailDestination" } }, "BulkEmailDestinationStatus": { "type": "structure", "members": { "Status": { "shape": "BulkEmailStatus", "documentation": "The status of a message sent using the SendBulkTemplatedEmail operation.
Possible values for this parameter include:
Success: Amazon SES accepted the message, and attempts to deliver it to the recipients.
MessageRejected: The message was rejected because it contained a virus.
MailFromDomainNotVerified: The sender's email address or domain was not verified.
ConfigurationSetDoesNotExist: The configuration set you specified does not exist.
TemplateDoesNotExist: The template you specified does not exist.
AccountSuspended: Your account has been shut down because of issues related to your email sending practices.
AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist.
AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.
ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
TransientFailure: Amazon SES was unable to process your request because of a temporary issue.
Failed: Amazon SES was unable to process your request. See the error message for additional information.
A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.
The unique message identifier returned from the SendBulkTemplatedEmail operation.
An object that contains the response from the SendBulkTemplatedEmail operation.
The name of the rule set to create. 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 name of the rule set to clone.
" } }, "documentation": "Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "CloneReceiptRuleSetResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "CloudWatchDestination": { "type": "structure", "required": [ "DimensionConfigurations" ], "members": { "DimensionConfigurations": { "shape": "CloudWatchDimensionConfigurations", "documentation": "A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
" } }, "documentation": "Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.
Event destinations, such as Amazon CloudWatch, 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.
" }, "CloudWatchDimensionConfiguration": { "type": "structure", "required": [ "DimensionName", "DimensionValueSource", "DefaultDimensionValue" ], "members": { "DimensionName": { "shape": "DimensionName", "documentation": "The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:).
Contain 256 characters or fewer.
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, specify messageTag. To use your own email headers, specify emailHeader. To put a custom tag on any link included in your email, specify linkTag.
The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), at signs (@), or periods (.).
Contain 256 characters or fewer.
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.
" }, "CloudWatchDimensionConfigurations": { "type": "list", "member": { "shape": "CloudWatchDimensionConfiguration" } }, "ConfigurationSet": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set. The name must meet the following requirements:
Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 64 characters or fewer.
The name of the configuration set.
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.
" }, "ConfigurationSetAttribute": { "type": "string", "enum": [ "eventDestinations", "trackingOptions", "deliveryOptions", "reputationOptions" ] }, "ConfigurationSetAttributeList": { "type": "list", "member": { "shape": "ConfigurationSetAttribute" } }, "ConfigurationSetName": { "type": "string" }, "ConfigurationSets": { "type": "list", "member": { "shape": "ConfigurationSet" } }, "Content": { "type": "structure", "required": [ "Data" ], "members": { "Data": { "shape": "MessageData", "documentation": "The textual data of the content.
" }, "Charset": { "shape": "Charset", "documentation": "The character set of the content.
" } }, "documentation": "Represents textual data, plus an optional character set specification.
By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.
" }, "Counter": { "type": "long" }, "CreateConfigurationSetEventDestinationRequest": { "type": "structure", "required": [ "ConfigurationSetName", "EventDestination" ], "members": { "ConfigurationSetName": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set that the event destination should be associated with.
" }, "EventDestination": { "shape": "EventDestination", "documentation": "An object that describes the Amazon Web Services service that email sending event where information is published.
" } }, "documentation": "Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "CreateConfigurationSetEventDestinationResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "CreateConfigurationSetRequest": { "type": "structure", "required": [ "ConfigurationSet" ], "members": { "ConfigurationSet": { "shape": "ConfigurationSet", "documentation": "A data structure that contains the name of the configuration set.
" } }, "documentation": "Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "CreateConfigurationSetResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "CreateConfigurationSetTrackingOptionsRequest": { "type": "structure", "required": [ "ConfigurationSetName", "TrackingOptions" ], "members": { "ConfigurationSetName": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set that the tracking options should be associated with.
" }, "TrackingOptions": { "shape": "TrackingOptions" } }, "documentation": "Represents a request to create an open and click tracking option object in a configuration set.
" }, "CreateConfigurationSetTrackingOptionsResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "CreateCustomVerificationEmailTemplateRequest": { "type": "structure", "required": [ "TemplateName", "FromEmailAddress", "TemplateSubject", "TemplateContent", "SuccessRedirectionURL", "FailureRedirectionURL" ], "members": { "TemplateName": { "shape": "TemplateName", "documentation": "The name of the custom verification email template.
" }, "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 create a custom verification email template.
" }, "CreateReceiptFilterRequest": { "type": "structure", "required": [ "Filter" ], "members": { "Filter": { "shape": "ReceiptFilter", "documentation": "A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
" } }, "documentation": "Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "CreateReceiptFilterResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "CreateReceiptRuleRequest": { "type": "structure", "required": [ "RuleSetName", "Rule" ], "members": { "RuleSetName": { "shape": "ReceiptRuleSetName", "documentation": "The name of the rule set where the receipt rule is added.
" }, "After": { "shape": "ReceiptRuleName", "documentation": "The name of an existing rule after which the new rule is placed. If this parameter is null, the new rule is inserted at the beginning of the rule list.
" }, "Rule": { "shape": "ReceiptRule", "documentation": "A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
" } }, "documentation": "Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "CreateReceiptRuleResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "CreateReceiptRuleSetRequest": { "type": "structure", "required": [ "RuleSetName" ], "members": { "RuleSetName": { "shape": "ReceiptRuleSetName", "documentation": "The name of the rule set to create. 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.
Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "CreateReceiptRuleSetResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "CreateTemplateRequest": { "type": "structure", "required": [ "Template" ], "members": { "Template": { "shape": "Template", "documentation": "The content of the email, composed of a subject line and either an HTML part or a text-only part.
" } }, "documentation": "Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
" }, "CreateTemplateResponse": { "type": "structure", "members": {} }, "CustomMailFromStatus": { "type": "string", "enum": [ "Pending", "Success", "Failed", "TemporaryFailure" ] }, "CustomRedirectDomain": { "type": "string" }, "CustomVerificationEmailTemplate": { "type": "structure", "members": { "TemplateName": { "shape": "TemplateName", "documentation": "The name of the custom verification email template.
" }, "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.
" }, "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": "Contains information about a custom verification email template.
" }, "CustomVerificationEmailTemplates": { "type": "list", "member": { "shape": "CustomVerificationEmailTemplate" } }, "DefaultDimensionValue": { "type": "string" }, "DeleteConfigurationSetEventDestinationRequest": { "type": "structure", "required": [ "ConfigurationSetName", "EventDestinationName" ], "members": { "ConfigurationSetName": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set from which to delete the event destination.
" }, "EventDestinationName": { "shape": "EventDestinationName", "documentation": "The name of the event destination to delete.
" } }, "documentation": "Represents a request to delete a configuration set event destination. Configuration set event destinations 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.
" }, "DeleteConfigurationSetEventDestinationResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteConfigurationSetRequest": { "type": "structure", "required": [ "ConfigurationSetName" ], "members": { "ConfigurationSetName": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set to delete.
" } }, "documentation": "Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "DeleteConfigurationSetResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteConfigurationSetTrackingOptionsRequest": { "type": "structure", "required": [ "ConfigurationSetName" ], "members": { "ConfigurationSetName": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set.
" } }, "documentation": "Represents a request to delete open and click tracking options in a configuration set.
" }, "DeleteConfigurationSetTrackingOptionsResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteCustomVerificationEmailTemplateRequest": { "type": "structure", "required": [ "TemplateName" ], "members": { "TemplateName": { "shape": "TemplateName", "documentation": "The name of the custom verification email template to delete.
" } }, "documentation": "Represents a request to delete an existing custom verification email template.
" }, "DeleteIdentityPolicyRequest": { "type": "structure", "required": [ "Identity", "PolicyName" ], "members": { "Identity": { "shape": "Identity", "documentation": "The identity that is associated with the policy to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
" }, "PolicyName": { "shape": "PolicyName", "documentation": "The name of the policy to be deleted.
" } }, "documentation": "Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
" }, "DeleteIdentityPolicyResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteIdentityRequest": { "type": "structure", "required": [ "Identity" ], "members": { "Identity": { "shape": "Identity", "documentation": "The identity to be removed from the list of identities for the Amazon Web Services account.
" } }, "documentation": "Represents a request to delete one of your Amazon SES identities (an email address or domain).
" }, "DeleteIdentityResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteReceiptFilterRequest": { "type": "structure", "required": [ "FilterName" ], "members": { "FilterName": { "shape": "ReceiptFilterName", "documentation": "The name of the IP address filter to delete.
" } }, "documentation": "Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "DeleteReceiptFilterResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteReceiptRuleRequest": { "type": "structure", "required": [ "RuleSetName", "RuleName" ], "members": { "RuleSetName": { "shape": "ReceiptRuleSetName", "documentation": "The name of the receipt rule set that contains the receipt rule to delete.
" }, "RuleName": { "shape": "ReceiptRuleName", "documentation": "The name of the receipt rule to delete.
" } }, "documentation": "Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "DeleteReceiptRuleResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteReceiptRuleSetRequest": { "type": "structure", "required": [ "RuleSetName" ], "members": { "RuleSetName": { "shape": "ReceiptRuleSetName", "documentation": "The name of the receipt rule set to delete.
" } }, "documentation": "Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "DeleteReceiptRuleSetResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "DeleteTemplateRequest": { "type": "structure", "required": [ "TemplateName" ], "members": { "TemplateName": { "shape": "TemplateName", "documentation": "The name of the template to be deleted.
" } }, "documentation": "Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.
" }, "DeleteTemplateResponse": { "type": "structure", "members": {} }, "DeleteVerifiedEmailAddressRequest": { "type": "structure", "required": [ "EmailAddress" ], "members": { "EmailAddress": { "shape": "Address", "documentation": "An email address to be removed from the list of verified addresses.
" } }, "documentation": "Represents a request to delete an email address from the list of email addresses you have attempted to verify under your Amazon Web Services account.
" }, "DeliveryOptions": { "type": "structure", "members": { "TlsPolicy": { "shape": "TlsPolicy", "documentation": "Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
" }, "DescribeActiveReceiptRuleSetRequest": { "type": "structure", "members": {}, "documentation": "Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "DescribeActiveReceiptRuleSetResponse": { "type": "structure", "members": { "Metadata": { "shape": "ReceiptRuleSetMetadata", "documentation": "The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
" }, "Rules": { "shape": "ReceiptRulesList", "documentation": "The receipt rules that belong to the active rule set.
" } }, "documentation": "Represents the metadata and receipt rules for the receipt rule set that is currently active.
" }, "DescribeConfigurationSetRequest": { "type": "structure", "required": [ "ConfigurationSetName" ], "members": { "ConfigurationSetName": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set to describe.
" }, "ConfigurationSetAttributeNames": { "shape": "ConfigurationSetAttributeList", "documentation": "A list of configuration set attributes to return.
" } }, "documentation": "Represents a request to return the details 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.
" }, "DescribeConfigurationSetResponse": { "type": "structure", "members": { "ConfigurationSet": { "shape": "ConfigurationSet", "documentation": "The configuration set object associated with the specified configuration set.
" }, "EventDestinations": { "shape": "EventDestinations", "documentation": "A list of event destinations associated with the configuration set.
" }, "TrackingOptions": { "shape": "TrackingOptions", "documentation": "The name of the custom open and click tracking domain associated with the configuration set.
" }, "DeliveryOptions": { "shape": "DeliveryOptions" }, "ReputationOptions": { "shape": "ReputationOptions", "documentation": "An object that represents the reputation settings for the configuration set.
" } }, "documentation": "Represents the details 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.
" }, "DescribeReceiptRuleRequest": { "type": "structure", "required": [ "RuleSetName", "RuleName" ], "members": { "RuleSetName": { "shape": "ReceiptRuleSetName", "documentation": "The name of the receipt rule set that the receipt rule belongs to.
" }, "RuleName": { "shape": "ReceiptRuleName", "documentation": "The name of the receipt rule.
" } }, "documentation": "Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "DescribeReceiptRuleResponse": { "type": "structure", "members": { "Rule": { "shape": "ReceiptRule", "documentation": "A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
" } }, "documentation": "Represents the details of a receipt rule.
" }, "DescribeReceiptRuleSetRequest": { "type": "structure", "required": [ "RuleSetName" ], "members": { "RuleSetName": { "shape": "ReceiptRuleSetName", "documentation": "The name of the receipt rule set to describe.
" } }, "documentation": "Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "DescribeReceiptRuleSetResponse": { "type": "structure", "members": { "Metadata": { "shape": "ReceiptRuleSetMetadata", "documentation": "The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
" }, "Rules": { "shape": "ReceiptRulesList", "documentation": "A list of the receipt rules that belong to the specified receipt rule set.
" } }, "documentation": "Represents the details of the specified receipt rule set.
" }, "Destination": { "type": "structure", "members": { "ToAddresses": { "shape": "AddressList", "documentation": "The recipients to place on the To: line of the message.
" }, "CcAddresses": { "shape": "AddressList", "documentation": "The recipients to place on the CC: line of the message.
" }, "BccAddresses": { "shape": "AddressList", "documentation": "The recipients to place on the BCC: line of the message.
" } }, "documentation": "Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
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 name of the event destination. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 64 characters or fewer.
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.
The type of email sending events to publish to the event destination.
send - The call was successful and Amazon SES is attempting to deliver the email.
reject - Amazon SES determined that the email contained a virus and rejected it.
bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.
complaint - The recipient marked the email as spam.
delivery - Amazon SES successfully delivered the email to the recipient's mail server.
open - The recipient received the email and opened it in their email client.
click - The recipient clicked one or more links in the email.
renderingFailure - Amazon SES did not send the email because of a template rendering issue.
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
" }, "CloudWatchDestination": { "shape": "CloudWatchDestination", "documentation": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
" }, "SNSDestination": { "shape": "SNSDestination", "documentation": "An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
" } }, "documentation": "Contains information about an event destination.
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "EventDestinationName": { "type": "string" }, "EventDestinations": { "type": "list", "member": { "shape": "EventDestination" } }, "EventType": { "type": "string", "enum": [ "send", "reject", "bounce", "complaint", "delivery", "open", "click", "renderingFailure" ] }, "EventTypes": { "type": "list", "member": { "shape": "EventType" } }, "Explanation": { "type": "string" }, "ExtensionField": { "type": "structure", "required": [ "Name", "Value" ], "members": { "Name": { "shape": "ExtensionFieldName", "documentation": "The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
" }, "Value": { "shape": "ExtensionFieldValue", "documentation": "The value of the header to add. Must contain 2048 characters or fewer, and must not contain newline characters (\"\\r\" or \"\\n\").
" } }, "documentation": "Additional X-headers 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.
" }, "ExtensionFieldList": { "type": "list", "member": { "shape": "ExtensionField" } }, "ExtensionFieldName": { "type": "string" }, "ExtensionFieldValue": { "type": "string" }, "FailureRedirectionURL": { "type": "string" }, "FromAddress": { "type": "string" }, "GetAccountSendingEnabledResponse": { "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 return the email sending status for your Amazon SES account in the current Amazon Web Services Region.
" }, "GetCustomVerificationEmailTemplateRequest": { "type": "structure", "required": [ "TemplateName" ], "members": { "TemplateName": { "shape": "TemplateName", "documentation": "The name of the custom verification email template to retrieve.
" } }, "documentation": "Represents a request to retrieve an existing custom verification email template.
" }, "GetCustomVerificationEmailTemplateResponse": { "type": "structure", "members": { "TemplateName": { "shape": "TemplateName", "documentation": "The name of the custom verification email template.
" }, "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.
" }, "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": "The content of the custom verification email template.
" }, "GetIdentityDkimAttributesRequest": { "type": "structure", "required": [ "Identities" ], "members": { "Identities": { "shape": "IdentityList", "documentation": "A list of one or more verified identities - email addresses, domains, or both.
" } }, "documentation": "Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.
" }, "GetIdentityDkimAttributesResponse": { "type": "structure", "required": [ "DkimAttributes" ], "members": { "DkimAttributes": { "shape": "DkimAttributes", "documentation": "The DKIM attributes for an email address or a domain.
" } }, "documentation": "Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.
" }, "GetIdentityMailFromDomainAttributesRequest": { "type": "structure", "required": [ "Identities" ], "members": { "Identities": { "shape": "IdentityList", "documentation": "A list of one or more identities.
" } }, "documentation": "Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.
" }, "GetIdentityMailFromDomainAttributesResponse": { "type": "structure", "required": [ "MailFromDomainAttributes" ], "members": { "MailFromDomainAttributes": { "shape": "MailFromDomainAttributes", "documentation": "A map of identities to custom MAIL FROM attributes.
" } }, "documentation": "Represents the custom MAIL FROM attributes for a list of identities.
" }, "GetIdentityNotificationAttributesRequest": { "type": "structure", "required": [ "Identities" ], "members": { "Identities": { "shape": "IdentityList", "documentation": "A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.
" }, "GetIdentityNotificationAttributesResponse": { "type": "structure", "required": [ "NotificationAttributes" ], "members": { "NotificationAttributes": { "shape": "NotificationAttributes", "documentation": "A map of Identity to IdentityNotificationAttributes.
" } }, "documentation": "Represents the notification attributes for a list of identities.
" }, "GetIdentityPoliciesRequest": { "type": "structure", "required": [ "Identity", "PolicyNames" ], "members": { "Identity": { "shape": "Identity", "documentation": "The identity for which the policies are retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
" }, "PolicyNames": { "shape": "PolicyNameList", "documentation": "A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.
Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
" }, "GetIdentityPoliciesResponse": { "type": "structure", "required": [ "Policies" ], "members": { "Policies": { "shape": "PolicyMap", "documentation": "A map of policy names to policies.
" } }, "documentation": "Represents the requested sending authorization policies.
" }, "GetIdentityVerificationAttributesRequest": { "type": "structure", "required": [ "Identities" ], "members": { "Identities": { "shape": "IdentityList", "documentation": "A list of identities.
" } }, "documentation": "Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.
" }, "GetIdentityVerificationAttributesResponse": { "type": "structure", "required": [ "VerificationAttributes" ], "members": { "VerificationAttributes": { "shape": "VerificationAttributes", "documentation": "A map of Identities to IdentityVerificationAttributes objects.
" } }, "documentation": "The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.
" }, "GetSendQuotaResponse": { "type": "structure", "members": { "Max24HourSend": { "shape": "Max24HourSend", "documentation": "The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
" }, "MaxSendRate": { "shape": "MaxSendRate", "documentation": "The maximum number of emails that Amazon SES can accept from the user's account per second.
The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.
The number of emails sent during the previous 24 hours.
" } }, "documentation": "Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.
" }, "GetSendStatisticsResponse": { "type": "structure", "members": { "SendDataPoints": { "shape": "SendDataPointList", "documentation": "A list of data points, each of which represents 15 minutes of activity.
" } }, "documentation": "Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.
" }, "GetTemplateRequest": { "type": "structure", "required": [ "TemplateName" ], "members": { "TemplateName": { "shape": "TemplateName", "documentation": "The name of the template to retrieve.
" } } }, "GetTemplateResponse": { "type": "structure", "members": { "Template": { "shape": "Template" } } }, "HeaderName": { "type": "string" }, "HeaderValue": { "type": "string" }, "HtmlPart": { "type": "string" }, "Identity": { "type": "string" }, "IdentityDkimAttributes": { "type": "structure", "required": [ "DkimEnabled", "DkimVerificationStatus" ], "members": { "DkimEnabled": { "shape": "Enabled", "documentation": "Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.
" }, "DkimVerificationStatus": { "shape": "VerificationStatus", "documentation": "Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
" }, "DkimTokens": { "shape": "VerificationTokenList", "documentation": "A set of character strings that represent the domain's identity. 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": "Represents the DKIM attributes of a verified email address or a domain.
" }, "IdentityList": { "type": "list", "member": { "shape": "Identity" } }, "IdentityMailFromDomainAttributes": { "type": "structure", "required": [ "MailFromDomain", "MailFromDomainStatus", "BehaviorOnMXFailure" ], "members": { "MailFromDomain": { "shape": "MailFromDomainName", "documentation": "The custom MAIL FROM domain that the identity is configured to use.
" }, "MailFromDomainStatus": { "shape": "CustomMailFromStatus", "documentation": "The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.
Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
" }, "IdentityNotificationAttributes": { "type": "structure", "required": [ "BounceTopic", "ComplaintTopic", "DeliveryTopic", "ForwardingEnabled" ], "members": { "BounceTopic": { "shape": "NotificationTopic", "documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes bounce notifications.
" }, "ComplaintTopic": { "shape": "NotificationTopic", "documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes complaint notifications.
" }, "DeliveryTopic": { "shape": "NotificationTopic", "documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES publishes delivery notifications.
" }, "ForwardingEnabled": { "shape": "Enabled", "documentation": "Describes whether Amazon SES forwards bounce and complaint notifications as email. true indicates that Amazon SES forwards bounce and complaint notifications as email, while false indicates that bounce and complaint notifications are published only to the specified bounce and complaint Amazon SNS topics.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES includes headers in bounce notifications, and a value of false specifies that Amazon SES does not include headers in bounce notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES includes headers in complaint notifications, and a value of false specifies that Amazon SES does not include headers in complaint notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES includes headers in delivery notifications, and a value of false specifies that Amazon SES does not include headers in delivery notifications.
Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.
" }, "IdentityType": { "type": "string", "enum": [ "EmailAddress", "Domain" ] }, "IdentityVerificationAttributes": { "type": "structure", "required": [ "VerificationStatus" ], "members": { "VerificationStatus": { "shape": "VerificationStatus", "documentation": "The verification status of the identity: \"Pending\", \"Success\", \"Failed\", or \"TemporaryFailure\".
" }, "VerificationToken": { "shape": "VerificationToken", "documentation": "The verification token for a domain identity. Null for email address identities.
" } }, "documentation": "Represents the verification attributes of a single identity.
" }, "InvocationType": { "type": "string", "enum": [ "Event", "RequestResponse" ] }, "KinesisFirehoseDestination": { "type": "structure", "required": [ "IAMRoleARN", "DeliveryStreamARN" ], "members": { "IAMRoleARN": { "shape": "AmazonResourceName", "documentation": "The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
" }, "DeliveryStreamARN": { "shape": "AmazonResourceName", "documentation": "The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
" } }, "documentation": "Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
Event destinations, such as Amazon Kinesis Firehose, 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.
" }, "LambdaAction": { "type": "structure", "required": [ "FunctionArn" ], "members": { "TopicArn": { "shape": "AmazonResourceName", "documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is executed. 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.
" }, "FunctionArn": { "shape": "AmazonResourceName", "documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Lambda function. An example of an Amazon Web Services Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about Amazon Web Services Lambda, see the Amazon Web Services Lambda Developer Guide.
The invocation type of the Amazon Web Services Lambda function. An invocation type of RequestResponse means that the execution of the function immediately results in a response, and a value of Event means that the function is invoked asynchronously. The default value is Event. For information about Amazon Web Services Lambda invocation types, see the Amazon Web Services Lambda Developer Guide.
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
When included in a receipt rule, this action calls an Amazon Web Services Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to call your Amazon Web Services Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.
For information about using Amazon Web Services Lambda actions in receipt rules, see the Amazon SES Developer Guide.
" }, "LastAttemptDate": { "type": "timestamp" }, "LastFreshStart": { "type": "timestamp" }, "ListConfigurationSetsRequest": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.
The number of configuration sets to return.
" } }, "documentation": "Represents a request to list the configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "ListConfigurationSetsResponse": { "type": "structure", "members": { "ConfigurationSets": { "shape": "ConfigurationSets", "documentation": "A list of configuration sets.
" }, "NextToken": { "shape": "NextToken", "documentation": "A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets.
A list of configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "ListCustomVerificationEmailTemplatesRequest": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "An array the contains the name and creation time stamp for each template in your Amazon SES account.
" }, "MaxResults": { "shape": "MaxResults", "documentation": "The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation returns up to 50 results.
" } }, "documentation": "Represents a request to list the existing custom verification email templates for your account.
For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.
" }, "ListCustomVerificationEmailTemplatesResponse": { "type": "structure", "members": { "CustomVerificationEmailTemplates": { "shape": "CustomVerificationEmailTemplates", "documentation": "A list of the custom verification email templates that exist in your account.
" }, "NextToken": { "shape": "NextToken", "documentation": "A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom verification email templates.
A paginated list of custom verification email templates.
" }, "ListIdentitiesRequest": { "type": "structure", "members": { "IdentityType": { "shape": "IdentityType", "documentation": "The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities are listed.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token to use for pagination.
" }, "MaxItems": { "shape": "MaxItems", "documentation": "The maximum number of identities per page. Possible values are 1-1000 inclusive.
" } }, "documentation": "Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.
" }, "ListIdentitiesResponse": { "type": "structure", "required": [ "Identities" ], "members": { "Identities": { "shape": "IdentityList", "documentation": "A list of identities.
" }, "NextToken": { "shape": "NextToken", "documentation": "The token used for pagination.
" } }, "documentation": "A list of all identities that you have attempted to verify under your Amazon Web Services account, regardless of verification status.
" }, "ListIdentityPoliciesRequest": { "type": "structure", "required": [ "Identity" ], "members": { "Identity": { "shape": "Identity", "documentation": "The identity that is associated with the policy for which the policies are listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
" } }, "documentation": "Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
" }, "ListIdentityPoliciesResponse": { "type": "structure", "required": [ "PolicyNames" ], "members": { "PolicyNames": { "shape": "PolicyNameList", "documentation": "A list of names of policies that apply to the specified identity.
" } }, "documentation": "A list of names of sending authorization policies that apply to an identity.
" }, "ListReceiptFiltersRequest": { "type": "structure", "members": {}, "documentation": "Represents a request to list the IP address filters that exist under your Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "ListReceiptFiltersResponse": { "type": "structure", "members": { "Filters": { "shape": "ReceiptFilterList", "documentation": "A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.
" } }, "documentation": "A list of IP address filters that exist under your Amazon Web Services account.
" }, "ListReceiptRuleSetsRequest": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.
Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.
" }, "ListReceiptRuleSetsResponse": { "type": "structure", "members": { "RuleSets": { "shape": "ReceiptRuleSetsLists", "documentation": "The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.
" }, "NextToken": { "shape": "NextToken", "documentation": "A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.
A list of receipt rule sets that exist under your Amazon Web Services account.
" }, "ListTemplatesRequest": { "type": "structure", "members": { "NextToken": { "shape": "NextToken", "documentation": "A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.
The maximum number of templates to return. This value must be at least 1 and less than or equal to 100. If more than 100 items are requested, the page size will automatically set to 100. If you do not specify a value, 10 is the default page size.
" } } }, "ListTemplatesResponse": { "type": "structure", "members": { "TemplatesMetadata": { "shape": "TemplateMetadataList", "documentation": "An array the contains the name and creation time stamp for each template in your Amazon SES account.
" }, "NextToken": { "shape": "NextToken", "documentation": "A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next set of email templates within your page size.
A list of email addresses that have been verified.
" } }, "documentation": "A list of email addresses that you have verified with Amazon SES under your Amazon Web Services account.
" }, "MailFromDomainAttributes": { "type": "map", "key": { "shape": "Identity" }, "value": { "shape": "IdentityMailFromDomainAttributes" } }, "MailFromDomainName": { "type": "string" }, "Max24HourSend": { "type": "double" }, "MaxItems": { "type": "integer" }, "MaxResults": { "type": "integer", "box": true, "max": 50, "min": 1 }, "MaxSendRate": { "type": "double" }, "Message": { "type": "structure", "required": [ "Subject", "Body" ], "members": { "Subject": { "shape": "Content", "documentation": "The subject of the message: A short summary of the content, which appears in the recipient's inbox.
" }, "Body": { "shape": "Body", "documentation": "The message body.
" } }, "documentation": "Represents the message to be sent, composed of a subject and a body.
" }, "MessageData": { "type": "string" }, "MessageDsn": { "type": "structure", "required": [ "ReportingMta" ], "members": { "ReportingMta": { "shape": "ReportingMta", "documentation": "The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com.
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
" }, "ExtensionFields": { "shape": "ExtensionFieldList", "documentation": "Additional X-headers to include in the DSN.
" } }, "documentation": "Message-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.
" }, "MessageId": { "type": "string" }, "MessageTag": { "type": "structure", "required": [ "Name", "Value" ], "members": { "Name": { "shape": "MessageTagName", "documentation": "The name of the tag. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 256 characters or fewer.
The value of the tag. The value must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain 256 characters or fewer.
Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.
" }, "MessageTagList": { "type": "list", "member": { "shape": "MessageTag" } }, "MessageTagName": { "type": "string" }, "MessageTagValue": { "type": "string" }, "NextToken": { "type": "string" }, "NotificationAttributes": { "type": "map", "key": { "shape": "Identity" }, "value": { "shape": "IdentityNotificationAttributes" } }, "NotificationTopic": { "type": "string" }, "NotificationType": { "type": "string", "enum": [ "Bounce", "Complaint", "Delivery" ] }, "Policy": { "type": "string", "min": 1 }, "PolicyMap": { "type": "map", "key": { "shape": "PolicyName" }, "value": { "shape": "Policy" } }, "PolicyName": { "type": "string", "max": 64, "min": 1 }, "PolicyNameList": { "type": "list", "member": { "shape": "PolicyName" } }, "PutConfigurationSetDeliveryOptionsRequest": { "type": "structure", "required": [ "ConfigurationSetName" ], "members": { "ConfigurationSetName": { "shape": "ConfigurationSetName", "documentation": "The name of the configuration set.
" }, "DeliveryOptions": { "shape": "DeliveryOptions", "documentation": "Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
" } }, "documentation": "A request to modify the delivery options for a configuration set.
" }, "PutConfigurationSetDeliveryOptionsResponse": { "type": "structure", "members": {}, "documentation": "An HTTP 200 response if the request succeeds, or an error message if the request fails.
" }, "PutIdentityPolicyRequest": { "type": "structure", "required": [ "Identity", "PolicyName", "Policy" ], "members": { "Identity": { "shape": "Identity", "documentation": "The identity to which that the policy applies. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.
To successfully call this operation, you must own the identity.
" }, "PolicyName": { "shape": "PolicyName", "documentation": "The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
" }, "Policy": { "shape": "Policy", "documentation": "The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
" } }, "documentation": "Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
" }, "PutIdentityPolicyResponse": { "type": "structure", "members": {}, "documentation": "An empty element returned on a successful request.
" }, "RawMessage": { "type": "structure", "required": [ "Data" ], "members": { "Data": { "shape": "RawMessageData", "documentation": "The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an Amazon Web Services SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\" addresses. For more information, see the documentation for SendRawEmail.
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide.
" } }, "documentation": "Represents the raw data of the message.
" }, "RawMessageData": { "type": "blob" }, "ReceiptAction": { "type": "structure", "members": { "S3Action": { "shape": "S3Action", "documentation": "Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
" }, "BounceAction": { "shape": "BounceAction", "documentation": "Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
" }, "WorkmailAction": { "shape": "WorkmailAction", "documentation": "Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
" }, "LambdaAction": { "shape": "LambdaAction", "documentation": "Calls an Amazon Web Services Lambda function, and optionally, publishes a notification to Amazon SNS.
" }, "StopAction": { "shape": "StopAction", "documentation": "Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
" }, "AddHeaderAction": { "shape": "AddHeaderAction", "documentation": "Adds a header to the received email.
" }, "SNSAction": { "shape": "SNSAction", "documentation": "Publishes the email content within a notification to Amazon SNS.
" } }, "documentation": "An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
" }, "ReceiptActionsList": { "type": "list", "member": { "shape": "ReceiptAction" } }, "ReceiptFilter": { "type": "structure", "required": [ "Name", "IpFilter" ], "members": { "Name": { "shape": "ReceiptFilterName", "documentation": "The name of the IP address filter. 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.
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
" } }, "documentation": "A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
" }, "ReceiptFilterList": { "type": "list", "member": { "shape": "ReceiptFilter" } }, "ReceiptFilterName": { "type": "string" }, "ReceiptFilterPolicy": { "type": "string", "enum": [ "Block", "Allow" ] }, "ReceiptIpFilter": { "type": "structure", "required": [ "Policy", "Cidr" ], "members": { "Policy": { "shape": "ReceiptFilterPolicy", "documentation": "Indicates whether to block or allow incoming mail from the specified IP addresses.
" }, "Cidr": { "shape": "Cidr", "documentation": "A single IP address or a range of IP addresses to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.
" } }, "documentation": "A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide.
" }, "ReceiptRule": { "type": "structure", "required": [ "Name" ], "members": { "Name": { "shape": "ReceiptRuleName", "documentation": "The name of the receipt rule. The name must meet the following requirements:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).
Start and end with a letter or number.
Contain 64 characters or fewer.
If true, the receipt rule is active. The default value is false.
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.
" }, "Actions": { "shape": "ReceiptActionsList", "documentation": "An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
" }, "ScanEnabled": { "shape": "Enabled", "documentation": "If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide.
" }, "ReceiptRuleName": { "type": "string" }, "ReceiptRuleNamesList": { "type": "list", "member": { "shape": "ReceiptRuleName" } }, "ReceiptRuleSetMetadata": { "type": "structure", "members": { "Name": { "shape": "ReceiptRuleSetName", "documentation": "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.
" }, "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 }, "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.
" }, "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:
" }