Amazon Simple Email Service
This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.
For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.
License: Apache 2.0 License
Resources
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 AWS 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateConfigurationSetEventDestinationRequest
|
object |
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 AWS 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. |
Properties
EventDestination
|
EventDestination |
An object that describes the AWS service that email sending event information will be published to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfigurationSetName
|
ConfigurationSetName |
The name of the configuration set that the event destination should be associated with. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateConfigurationSetEventDestinationResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
EventDestinationAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidCloudWatchDestinationException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidFirehoseDestinationException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSNSDestinationException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateConfigurationSetRequest
|
object |
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. |
Properties
ConfigurationSet
|
ConfigurationSet |
A data structure that contains the name of the configuration set. |
||||||||||||||
Properties
|
||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateConfigurationSetResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidConfigurationSetException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateConfigurationSetTrackingOptionsRequest
|
object |
Represents a request to create an open and click tracking option object in a configuration set. |
Properties
TrackingOptions
|
TrackingOptions | |||||||||||||||
Properties
|
||||||||||||||||
ConfigurationSetName
|
ConfigurationSetName |
The name of the configuration set that the tracking options should be associated with. |
||||||||||||||
|
||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateConfigurationSetTrackingOptionsResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
TrackingOptionsAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidTrackingOptionsException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateCustomVerificationEmailTemplateRequest
|
object |
Represents a request to create a custom verification email template. |
Properties
FailureRedirectionURL
|
FailureRedirectionURL |
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. |
||||
|
||||||
SuccessRedirectionURL
|
SuccessRedirectionURL |
The URL that the recipient of the verification email is sent to if his or her address is successfully verified. |
||||
|
||||||
TemplateContent
|
TemplateContent |
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. |
||||
|
||||||
TemplateSubject
|
Subject |
The subject line of the custom verification email. |
||||
|
||||||
FromEmailAddress
|
FromAddress |
The email address that the custom verification email is sent from. |
||||
|
||||||
TemplateName
|
TemplateName |
The name of the custom verification email template. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CustomVerificationEmailTemplateAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
FromEmailAddressNotVerifiedException
|
Body
| Name | Data Type | Description |
|---|---|---|
CustomVerificationEmailInvalidContentException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateReceiptFilterRequest
|
object |
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. |
Properties
Filter
|
ReceiptFilter |
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. |
||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||
Examples
{
"Filter": {
"IpFilter": {
"Cidr": "1.2.3.4\/24",
"Policy": "Allow"
},
"Name": "MyFilter"
}
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateReceiptFilterResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
AlreadyExistsException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateReceiptRuleRequest
|
object |
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. |
Properties
Rule
|
ReceiptRule |
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
After
|
ReceiptRuleName |
The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RuleSetName
|
ReceiptRuleSetName |
The name of the rule set that the receipt rule will be added to. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"After": "",
"Rule": {
"Actions": [
{
"S3Action": {
"BucketName": "MyBucket",
"ObjectKeyPrefix": "email"
}
}
],
"Enabled": true,
"Name": "MyRule",
"ScanEnabled": true,
"TlsPolicy": "Optional"
},
"RuleSetName": "MyRuleSet"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateReceiptRuleResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSnsTopicException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidS3ConfigurationException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidLambdaFunctionException
|
Body
| Name | Data Type | Description |
|---|---|---|
AlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleSetDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateReceiptRuleSetRequest
|
object |
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. |
Properties
RuleSetName
|
ReceiptRuleSetName |
The name of the rule set to create. The name must:
|
||||
|
||||||
Examples
{
"RuleSetName": "MyRuleSet"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateReceiptRuleSetResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
AlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateTemplateRequest
|
object |
Represents a request to create an email template. For more information, see the Amazon SES Developer Guide. |
Properties
Template
|
Template |
The content of the email, composed of a subject line, an HTML part, and a text-only part. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateTemplateResponse
|
object |
Body
| Name | Data Type | Description |
|---|---|---|
AlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidTemplateException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConfigurationSetEventDestinationRequest
|
object |
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. |
Properties
EventDestinationName
|
EventDestinationName |
The name of the event destination to delete. |
||||
|
||||||
ConfigurationSetName
|
ConfigurationSetName |
The name of the configuration set from which to delete the event destination. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConfigurationSetEventDestinationResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
EventDestinationDoesNotExistException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConfigurationSetRequest
|
object |
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. |
Properties
ConfigurationSetName
|
ConfigurationSetName |
The name of the configuration set to delete. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConfigurationSetResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetDoesNotExistException
|
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 will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConfigurationSetTrackingOptionsRequest
|
object |
Represents a request to delete open and click tracking options in a configuration set. |
Properties
ConfigurationSetName
|
ConfigurationSetName |
The name of the configuration set from which you want to delete the tracking options. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteConfigurationSetTrackingOptionsResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
TrackingOptionsDoesNotExistException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteCustomVerificationEmailTemplateRequest
|
object |
Represents a request to delete an existing custom verification email template. |
Properties
TemplateName
|
TemplateName |
The name of the custom verification email template that you want to delete. |
||||
|
||||||
Responses
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteIdentityRequest
|
object |
Represents a request to delete one of your Amazon SES identities (an email address or domain). |
Properties
Identity
|
Identity |
The identity to be removed from the list of identities for the AWS Account. |
||||
|
||||||
Examples
{
"Identity": "user@example.com"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteIdentityResponse
|
object |
An empty element returned on a successful request. |
Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
This API is for the identity owner only. If you have not verified the identity, this API will return 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteIdentityPolicyRequest
|
object |
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. |
Properties
PolicyName
|
PolicyName |
The name of the policy to be deleted. |
||||
|
||||||
Identity
|
Identity |
The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: To successfully call this API, you must own the identity. |
||||
|
||||||
Examples
{
"Identity": "user@example.com",
"PolicyName": "MyPolicy"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteIdentityPolicyResponse
|
object |
An empty element returned on a successful request. |
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteReceiptFilterRequest
|
object |
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. |
Properties
FilterName
|
ReceiptFilterName |
The name of the IP address filter to delete. |
||||
|
||||||
Examples
{
"FilterName": "MyFilter"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteReceiptFilterResponse
|
object |
An empty element returned on a successful request. |
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteReceiptRuleRequest
|
object |
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. |
Properties
RuleName
|
ReceiptRuleName |
The name of the receipt rule to delete. |
||||
|
||||||
RuleSetName
|
ReceiptRuleSetName |
The name of the receipt rule set that contains the receipt rule to delete. |
||||
|
||||||
Examples
{
"RuleName": "MyRule",
"RuleSetName": "MyRuleSet"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteReceiptRuleResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
RuleSetDoesNotExistException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteReceiptRuleSetRequest
|
object |
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. |
Properties
RuleSetName
|
ReceiptRuleSetName |
The name of the receipt rule set to delete. |
||||
|
||||||
Examples
{
"RuleSetName": "MyRuleSet"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteReceiptRuleSetResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
CannotDeleteException
|
Deletes an email template.
You can execute this operation no more than once per second.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteTemplateRequest
|
object |
Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide. |
Properties
TemplateName
|
TemplateName |
The name of the template to be deleted. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteTemplateResponse
|
object |
Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteVerifiedEmailAddressRequest
|
object |
Represents a request to delete an email address from the list of email addresses you have attempted to verify under your AWS account. |
Properties
EmailAddress
|
Address |
An email address to be removed from the list of verified addresses. |
||||
|
||||||
Examples
{
"EmailAddress": "user@example.com"
}Responses
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeActiveReceiptRuleSetRequest
|
object |
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. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeActiveReceiptRuleSetResponse
|
object |
Represents the metadata and receipt rules for the receipt rule set that is currently active. |
Properties
Rules
|
ReceiptRulesList |
The receipt rules that belong to the active rule set. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Metadata
|
ReceiptRuleSetMetadata |
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. |
|||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
Examples
{
"Metadata": {
"CreatedTimestamp": "2016-07-15T16:25:59.607Z",
"Name": "default-rule-set"
},
"Rules": [
{
"Actions": [
{
"S3Action": {
"BucketName": "MyBucket",
"ObjectKeyPrefix": "email"
}
}
],
"Enabled": true,
"Name": "MyRule",
"ScanEnabled": true,
"TlsPolicy": "Optional"
}
]
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeConfigurationSetRequest
|
object |
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. |
Properties
ConfigurationSetAttributeNames
|
ConfigurationSetAttributeList |
A list of configuration set attributes to return. |
|||||||||||
|
|||||||||||||
ConfigurationSetName
|
ConfigurationSetName |
The name of the configuration set to describe. |
|||||||||||
|
|||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeConfigurationSetResponse
|
object |
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. |
Properties
ReputationOptions
|
ReputationOptions |
An object that represents the reputation settings for the configuration set. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
TrackingOptions
|
TrackingOptions |
The name of the custom open and click tracking domain associated with the configuration set. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
EventDestinations
|
EventDestinations |
A list of event destinations associated with the configuration set. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
ConfigurationSet
|
ConfigurationSet |
The configuration set object associated with the specified configuration set. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetDoesNotExistException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeReceiptRuleRequest
|
object |
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. |
Properties
RuleName
|
ReceiptRuleName |
The name of the receipt rule. |
||||
|
||||||
RuleSetName
|
ReceiptRuleSetName |
The name of the receipt rule set that the receipt rule belongs to. |
||||
|
||||||
Examples
{
"RuleName": "MyRule",
"RuleSetName": "MyRuleSet"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeReceiptRuleResponse
|
object |
Represents the details of a receipt rule. |
Properties
Rule
|
ReceiptRule |
A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Rule": {
"Actions": [
{
"S3Action": {
"BucketName": "MyBucket",
"ObjectKeyPrefix": "email"
}
}
],
"Enabled": true,
"Name": "MyRule",
"ScanEnabled": true,
"TlsPolicy": "Optional"
}
}Body
| Name | Data Type | Description |
|---|---|---|
RuleDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleSetDoesNotExistException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeReceiptRuleSetRequest
|
object |
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. |
Properties
RuleSetName
|
ReceiptRuleSetName |
The name of the receipt rule set to describe. |
||||
|
||||||
Examples
{
"RuleSetName": "MyRuleSet"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeReceiptRuleSetResponse
|
object |
Represents the details of the specified receipt rule set. |
Properties
Rules
|
ReceiptRulesList |
A list of the receipt rules that belong to the specified receipt rule set. |
|||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Metadata
|
ReceiptRuleSetMetadata |
The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created. |
|||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
Examples
{
"Metadata": {
"CreatedTimestamp": "2016-07-15T16:25:59.607Z",
"Name": "MyRuleSet"
},
"Rules": [
{
"Actions": [
{
"S3Action": {
"BucketName": "MyBucket",
"ObjectKeyPrefix": "email"
}
}
],
"Enabled": true,
"Name": "MyRule",
"ScanEnabled": true,
"TlsPolicy": "Optional"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
RuleSetDoesNotExistException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetAccountSendingEnabledResponse
|
object |
Represents a request to return the email sending status for your Amazon SES account in the current AWS Region. |
Properties
Enabled
|
Enabled |
Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region. |
||||
|
||||||
Examples
{
"Enabled": true
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetCustomVerificationEmailTemplateRequest
|
object |
Represents a request to retrieve an existing custom verification email template. |
Properties
TemplateName
|
TemplateName |
The name of the custom verification email template that you want to retrieve. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetCustomVerificationEmailTemplateResponse
|
object |
The content of the custom verification email template. |
Properties
FailureRedirectionURL
|
FailureRedirectionURL |
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified. |
||||
|
||||||
SuccessRedirectionURL
|
SuccessRedirectionURL |
The URL that the recipient of the verification email is sent to if his or her address is successfully verified. |
||||
|
||||||
TemplateContent
|
TemplateContent |
The content of the custom verification email. |
||||
|
||||||
TemplateSubject
|
Subject |
The subject line of the custom verification email. |
||||
|
||||||
FromEmailAddress
|
FromAddress |
The email address that the custom verification email is sent from. |
||||
|
||||||
TemplateName
|
TemplateName |
The name of the custom verification email template. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
CustomVerificationEmailTemplateDoesNotExistException
|
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityDkimAttributesRequest
|
object |
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. |
Properties
Identities
|
IdentityList |
A list of one or more verified identities - email addresses, domains, or both. |
|||||||||||
|
|||||||||||||
Examples
{
"Identities": [
"example.com",
"user@example.com"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityDkimAttributesResponse
|
object |
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. |
Properties
DkimAttributes
|
DkimAttributes |
The DKIM attributes for an email address or a domain. |
||||
|
||||||
Examples
{
"DkimAttributes": {
"example.com": {
"DkimEnabled": true,
"DkimTokens": [
"EXAMPLEjcs5xoyqytjsotsijas7236gr",
"EXAMPLEjr76cvoc6mysspnioorxsn6ep",
"EXAMPLEkbmkqkhlm2lyz77ppkulerm4k"
],
"DkimVerificationStatus": "Success"
},
"user@example.com": {
"DkimEnabled": false,
"DkimVerificationStatus": "NotStarted"
}
}
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityMailFromDomainAttributesRequest
|
object |
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. |
Properties
Identities
|
IdentityList |
A list of one or more identities. |
|||||||||||
|
|||||||||||||
Examples
{
"Identities": [
"example.com"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityMailFromDomainAttributesResponse
|
object |
Represents the custom MAIL FROM attributes for a list of identities. |
Properties
MailFromDomainAttributes
|
MailFromDomainAttributes |
A map of identities to custom MAIL FROM attributes. |
||||
|
||||||
Examples
{
"MailFromDomainAttributes": {
"example.com": {
"BehaviorOnMXFailure": "UseDefaultValue",
"MailFromDomain": "bounces.example.com",
"MailFromDomainStatus": "Success"
}
}
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityNotificationAttributesRequest
|
object |
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. |
Properties
Identities
|
IdentityList |
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: code>user@example.com</code, |
|||||||||||
|
|||||||||||||
Examples
{
"Identities": [
"example.com"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityNotificationAttributesResponse
|
object |
Represents the notification attributes for a list of identities. |
Properties
NotificationAttributes
|
NotificationAttributes |
A map of Identity to IdentityNotificationAttributes. |
||||
|
||||||
Examples
{
"NotificationAttributes": {
"example.com": {
"BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
"ComplaintTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
"DeliveryTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
"ForwardingEnabled": true,
"HeadersInBounceNotificationsEnabled": false,
"HeadersInComplaintNotificationsEnabled": false,
"HeadersInDeliveryNotificationsEnabled": false
}
}
}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 API is for the identity owner only. If you have not verified the identity, this API will return 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityPoliciesRequest
|
object |
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. |
Properties
PolicyNames
|
PolicyNameList |
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 |
|||||||||||
|
|||||||||||||
Identity
|
Identity |
The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: To successfully call this API, you must own the identity. |
|||||||||||
|
|||||||||||||
Examples
{
"Identity": "example.com",
"PolicyNames": [
"MyPolicy"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityPoliciesResponse
|
object |
Represents the requested sending authorization policies. |
Properties
Policies
|
PolicyMap |
A map of policy names to policies. |
||||
|
||||||
Examples
{
"Policies": {
"MyPolicy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity\/example.com\"}]}"
}
}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, if you still want 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, if you still want 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityVerificationAttributesRequest
|
object |
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. |
Properties
Identities
|
IdentityList |
A list of identities. |
|||||||||||
|
|||||||||||||
Examples
{
"Identities": [
"example.com"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetIdentityVerificationAttributesResponse
|
object |
The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token. |
Properties
VerificationAttributes
|
VerificationAttributes |
A map of Identities to IdentityVerificationAttributes objects. |
||||
|
||||||
Examples
{
"VerificationAttributes": {
"example.com": {
"VerificationStatus": "Success",
"VerificationToken": "EXAMPLE3VYb9EDI2nTOQRi\/Tf6MI\/6bD6THIGiP1MVY="
}
}
}Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetSendQuotaResponse
|
object |
Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours. |
Properties
SentLast24Hours
|
SentLast24Hours |
The number of emails sent during the previous 24 hours. |
||||
|
||||||
MaxSendRate
|
MaxSendRate |
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. |
||||
|
||||||
Max24HourSend
|
Max24HourSend |
The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota. |
||||
|
||||||
Examples
{
"Max24HourSend": 200,
"MaxSendRate": 1,
"SentLast24Hours": 1
}Provides sending statistics for the current AWS 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetSendStatisticsResponse
|
object |
Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES. |
Properties
SendDataPoints
|
SendDataPointList |
A list of data points, each of which represents 15 minutes of activity. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Examples
{
"SendDataPoints": [
{
"Bounces": 0,
"Complaints": 0,
"DeliveryAttempts": 5,
"Rejects": 0,
"Timestamp": "2016-07-13T22:43:00Z"
},
{
"Bounces": 0,
"Complaints": 0,
"DeliveryAttempts": 3,
"Rejects": 0,
"Timestamp": "2016-07-13T23:13:00Z"
},
{
"Bounces": 0,
"Complaints": 0,
"DeliveryAttempts": 1,
"Rejects": 0,
"Timestamp": "2016-07-13T21:13:00Z"
}
]
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetTemplateRequest
|
object |
Properties
TemplateName
|
TemplateName |
The name of the template you want to retrieve. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetTemplateResponse
|
object |
Properties
Template
|
Template | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
TemplateDoesNotExistException
|
Provides a list of the configuration sets associated with your Amazon SES account in the current AWS 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 will return 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 will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListConfigurationSetsRequest
|
object |
Represents a request to list the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. |
Properties
MaxItems
|
MaxItems |
The number of configuration sets to return. |
||||
|
||||||
NextToken
|
NextToken |
A token returned from a previous call to |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListConfigurationSetsResponse
|
object |
A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide. |
Properties
NextToken
|
NextToken |
A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of |
||||||||||||||
|
||||||||||||||||
ConfigurationSets
|
ConfigurationSets |
A list of configuration sets. |
||||||||||||||
|
||||||||||||||||
Lists the existing custom verification email templates for your account in the current AWS 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
MaxResults
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListCustomVerificationEmailTemplatesRequest
|
object |
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. |
Properties
MaxResults
|
MaxResults |
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 will return up to 50 results. |
||||
|
||||||
NextToken
|
NextToken |
An array the contains the name and creation time stamp for each template in your Amazon SES account. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListCustomVerificationEmailTemplatesResponse
|
object |
A paginated list of custom verification email templates. |
Properties
NextToken
|
NextToken |
A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
CustomVerificationEmailTemplates
|
CustomVerificationEmailTemplates |
A list of the custom verification email templates that exist in your account. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.
You can execute this operation no more than once per second.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
MaxItems
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListIdentitiesRequest
|
object |
Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status. |
Properties
MaxItems
|
MaxItems |
The maximum number of identities per page. Possible values are 1-1000 inclusive. |
||||
|
||||||
NextToken
|
NextToken |
The token to use for pagination. |
||||
|
||||||
IdentityType
|
IdentityType |
The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed. |
||||
|
||||||
Examples
{
"IdentityType": "EmailAddress",
"MaxItems": 123,
"NextToken": ""
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListIdentitiesResponse
|
object |
A list of all identities that you have attempted to verify under your AWS account, regardless of verification status. |
Properties
NextToken
|
NextToken |
The token used for pagination. |
|||||||||||
|
|||||||||||||
Identities
|
IdentityList |
A list of identities. |
|||||||||||
|
|||||||||||||
Examples
{
"Identities": [
"user@example.com"
],
"NextToken": ""
}Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.
This API is for the identity owner only. If you have not verified the identity, this API will return 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListIdentityPoliciesRequest
|
object |
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. |
Properties
Identity
|
Identity |
The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: To successfully call this API, you must own the identity. |
||||
|
||||||
Examples
{
"Identity": "example.com"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListIdentityPoliciesResponse
|
object |
A list of names of sending authorization policies that apply to an identity. |
Properties
PolicyNames
|
PolicyNameList |
A list of names of policies that apply to the specified identity. |
|||||||||||
|
|||||||||||||
Examples
{
"PolicyNames": [
"MyPolicy"
]
}Lists the IP address filters associated with your AWS account in the current AWS 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListReceiptFiltersRequest
|
object |
Represents a request to list the IP address filters that exist under your AWS account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListReceiptFiltersResponse
|
object |
A list of IP address filters that exist under your AWS account. |
Properties
Filters
|
ReceiptFilterList |
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. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"Filters": [
{
"IpFilter": {
"Cidr": "1.2.3.4\/24",
"Policy": "Block"
},
"Name": "MyFilter"
}
]
}Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListReceiptRuleSetsRequest
|
object |
Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide. |
Properties
NextToken
|
NextToken |
A token returned from a previous call to |
||||
|
||||||
Examples
{
"NextToken": ""
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListReceiptRuleSetsResponse
|
object |
A list of receipt rule sets that exist under your AWS account. |
Properties
NextToken
|
NextToken |
A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of |
|||||||||||||||||
|
|||||||||||||||||||
RuleSets
|
ReceiptRuleSetsLists |
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. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"NextToken": "",
"RuleSets": [
{
"CreatedTimestamp": "2016-07-15T16:25:59.607Z",
"Name": "MyRuleSet"
}
]
}Lists the email templates present in your Amazon SES account in the current AWS Region.
You can execute this operation no more than once per second.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListTemplatesRequest
|
object |
Properties
MaxItems
|
MaxItems |
The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results. |
||||
|
||||||
NextToken
|
NextToken |
A token returned from a previous call to |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListTemplatesResponse
|
object |
Properties
NextToken
|
NextToken |
A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to |
|||||||||||||||||
|
|||||||||||||||||||
TemplatesMetadata
|
TemplateMetadataList |
An array the contains the name and creation time stamp for each template in your Amazon SES account. |
|||||||||||||||||
|
|||||||||||||||||||
Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListVerifiedEmailAddressesResponse
|
object |
A list of email addresses that you have verified with Amazon SES under your AWS account. |
Properties
VerifiedEmailAddresses
|
AddressList |
A list of email addresses that have been verified. |
|||||||||||
|
|||||||||||||
Examples
{
"VerifiedEmailAddresses": [
"user1@example.com",
"user2@example.com"
]
}Adds or updates a sending authorization policy for the specified identity (an email address or a domain).
This API is for the identity owner only. If you have not verified the identity, this API will return 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutIdentityPolicyRequest
|
object |
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. |
Properties
Policy
|
Policy |
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. |
||||
|
||||||
PolicyName
|
PolicyName |
The name of the policy. The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores. |
||||
|
||||||
Identity
|
Identity |
The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: To successfully call this API, you must own the identity. |
||||
|
||||||
Examples
{
"Identity": "example.com",
"Policy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity\/example.com\"}]}",
"PolicyName": "MyPolicy"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
PutIdentityPolicyResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
InvalidPolicyException
|
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, this API will return an 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ReorderReceiptRuleSetRequest
|
object |
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. |
Properties
RuleNames
|
ReceiptRuleNamesList |
A list of the specified receipt rule set's receipt rules in the order that you want to put them. |
|||||||||||
|
|||||||||||||
RuleSetName
|
ReceiptRuleSetName |
The name of the receipt rule set to reorder. |
|||||||||||
|
|||||||||||||
Examples
{
"RuleNames": [
"MyRule",
"MyOtherRule"
],
"RuleSetName": "MyRuleSet"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ReorderReceiptRuleSetResponse
|
object |
An empty element returned on a successful request. |
Body
| Name | Data Type | Description |
|---|---|---|
RuleSetDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
RuleDoesNotExistException
|
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
You cannot use this API 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
SendBounceRequest
|
object |
Represents a request to send a bounce message to the sender of an email you received through Amazon SES. |
Properties
BounceSenderArn
|
AmazonResourceName |
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. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
BouncedRecipientInfoList
|
BouncedRecipientInfoList |
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 |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
MessageDsn
|
MessageDsn |
Message-related DSN fields. If not specified, Amazon SES will choose the values. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Explanation
|
Explanation |
Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
BounceSender
|
Address |
The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
OriginalMessageId
|
MessageId |
The message ID of the message to be bounced. |
||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
SendBounceResponse
|
object |
Represents a unique message ID. |
Properties
MessageId
|
MessageId |
The message ID of the bounce message. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
MessageRejected
|
Composes an email message to multiple destinations. The message body is created using an email template.
In order to send email using the SendBulkTemplatedEmail operation, your call to the API 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.
-
Each
Destinationparameter 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 will be 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
SendBulkTemplatedEmailoperation several times to send the message to each group. -
The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
SendBulkTemplatedEmailRequest
|
object |
Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide. |
Properties
Destinations
|
BulkEmailDestinationList |
One or more |
||||||||||||||||||||
|
||||||||||||||||||||||
DefaultTemplateData
|
TemplateData |
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. |
||||||||||||||||||||
|
||||||||||||||||||||||
TemplateArn
|
AmazonResourceName |
The ARN of the template to use when sending this email. |
||||||||||||||||||||
|
||||||||||||||||||||||
Template
|
TemplateName |
The template to use when sending this email. |
||||||||||||||||||||
|
||||||||||||||||||||||
DefaultTags
|
MessageTagList |
A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using |
||||||||||||||||||||
|
||||||||||||||||||||||
ConfigurationSetName
|
ConfigurationSetName |
The name of the configuration set to use when you send an email using |
||||||||||||||||||||
|
||||||||||||||||||||||
ReturnPathArn
|
AmazonResourceName |
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 For example, if the owner of For more information about sending authorization, see the Amazon SES Developer Guide. |
||||||||||||||||||||
|
||||||||||||||||||||||
ReturnPath
|
Address |
The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the |
||||||||||||||||||||
|
||||||||||||||||||||||
ReplyToAddresses
|
AddressList |
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply. |
||||||||||||||||||||
|
||||||||||||||||||||||
SourceArn
|
AmazonResourceName |
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 For example, if the owner of For more information about sending authorization, see the Amazon SES Developer Guide. |
||||||||||||||||||||
|
||||||||||||||||||||||
Source
|
Address |
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 Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: |
||||||||||||||||||||
|
||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
SendBulkTemplatedEmailResponse
|
object |
Properties
Status
|
BulkEmailDestinationStatusList |
The unique message identifier returned from the |
||||||||||||||||||||
|
||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
MessageRejected
|
Body
| Name | Data Type | Description |
|---|---|---|
MailFromDomainNotVerifiedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
TemplateDoesNotExistException
|
Body
| Name | Data Type | Description |
|---|---|---|
ConfigurationSetSendingPausedException
|
Body
| Name | Data Type | Description |
|---|---|---|
AccountSendingPausedException
|
Adds an email address to the list of identities for your Amazon SES account in the current AWS 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
SendCustomVerificationEmailRequest
|
object |
Represents a request to send a custom verification email to a specified recipient. |
Properties
ConfigurationSetName
|
ConfigurationSetName |
Name of a configuration set to use when sending the verification email. |
||||
|
||||||
TemplateName
|
TemplateName |
The name of the custom verification email template to use when sending the verification email. |
||||
|
||||||
EmailAddress
|
Address |
The email address to verify. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
SendCustomVerificationEmailResponse
|
object |
The response received when attempting to send the custom verification email. |
Properties
MessageId
|
MessageId |
The unique message identifier returned from the |
|