AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AddHeaderAction |
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. |
|
AlreadyExistsException | SimpleEmailService exception | |
Body | 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 |
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. |
|
BouncedRecipientInfo |
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. |
|
CannotDeleteException | SimpleEmailService exception | |
CloneReceiptRuleSetRequest |
Container for the parameters to the CloneReceiptRuleSet operation.
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. This action is throttled at one request per second. |
|
CloneReceiptRuleSetResponse | Configuration for accessing Amazon CloneReceiptRuleSet service | |
CloneReceiptRuleSetResult | ||
Content |
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. |
|
CreateReceiptFilterRequest |
Container for the parameters to the CreateReceiptFilter operation.
Creates a new IP address filter.
For information about setting up IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
CreateReceiptFilterResponse | Configuration for accessing Amazon CreateReceiptFilter service | |
CreateReceiptFilterResult | ||
CreateReceiptRuleRequest |
Container for the parameters to the CreateReceiptRule operation.
Creates a receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
CreateReceiptRuleResponse | Configuration for accessing Amazon CreateReceiptRule service | |
CreateReceiptRuleResult | ||
CreateReceiptRuleSetRequest |
Container for the parameters to the CreateReceiptRuleSet operation.
Creates an empty receipt rule set.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
CreateReceiptRuleSetResponse | Configuration for accessing Amazon CreateReceiptRuleSet service | |
CreateReceiptRuleSetResult | ||
DeleteIdentityPolicyRequest |
Container for the parameters to the DeleteIdentityPolicy operation.
Deletes the specified sending authorization policy for the given identity (email address
or domain). This API returns successfully even if a policy with the specified name
does not exist.
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. This action is throttled at one request per second. |
|
DeleteIdentityPolicyResponse | Configuration for accessing Amazon DeleteIdentityPolicy service | |
DeleteIdentityPolicyResult | ||
DeleteIdentityRequest |
Container for the parameters to the DeleteIdentity operation.
Deletes the specified identity (email address or domain) from the list of verified
identities.
This action is throttled at one request per second. |
|
DeleteIdentityResponse | Configuration for accessing Amazon DeleteIdentity service | |
DeleteIdentityResult | ||
DeleteReceiptFilterRequest |
Container for the parameters to the DeleteReceiptFilter operation.
Deletes the specified IP address filter.
For information about managing IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
DeleteReceiptFilterResponse | Configuration for accessing Amazon DeleteReceiptFilter service | |
DeleteReceiptFilterResult | ||
DeleteReceiptRuleRequest |
Container for the parameters to the DeleteReceiptRule operation.
Deletes the specified receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
DeleteReceiptRuleResponse | Configuration for accessing Amazon DeleteReceiptRule service | |
DeleteReceiptRuleResult | ||
DeleteReceiptRuleSetRequest |
Container for the parameters to the DeleteReceiptRuleSet operation.
Deletes the specified receipt rule set and all of the receipt rules it contains.
For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
DeleteReceiptRuleSetResponse | Configuration for accessing Amazon DeleteReceiptRuleSet service | |
DeleteReceiptRuleSetResult | ||
DeleteVerifiedEmailAddressRequest |
Container for the parameters to the DeleteVerifiedEmailAddress operation.
Deletes the specified email address from the list of verified addresses.
This action is throttled at one request per second. |
|
DeleteVerifiedEmailAddressResponse | ||
DescribeActiveReceiptRuleSetRequest |
Container for the parameters to the DescribeActiveReceiptRuleSet operation.
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. This action is throttled at one request per second. |
|
DescribeActiveReceiptRuleSetResponse | Configuration for accessing Amazon DescribeActiveReceiptRuleSet service | |
DescribeActiveReceiptRuleSetResult | ||
DescribeReceiptRuleRequest |
Container for the parameters to the DescribeReceiptRule operation.
Returns the details of the specified receipt rule.
For information about setting up receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
DescribeReceiptRuleResponse | Configuration for accessing Amazon DescribeReceiptRule service | |
DescribeReceiptRuleResult | ||
DescribeReceiptRuleSetRequest |
Container for the parameters to the DescribeReceiptRuleSet operation.
Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
DescribeReceiptRuleSetResponse | Configuration for accessing Amazon DescribeReceiptRuleSet service | |
DescribeReceiptRuleSetResult | ||
Destination |
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
By default, the string must be 7-bit ASCII. If the text must contain any other characters,
then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string.
MIME encoded-word syntax uses the following form: |
|
ExtensionField |
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. |
|
GetIdentityDkimAttributesRequest |
Container for the parameters to the GetIdentityDkimAttributes operation.
Returns the current status of Easy DKIM signing for an entity. For domain name identities,
this action 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 action takes a list of identities as input and returns the following information for each:
This action 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. |
|
GetIdentityDkimAttributesResponse | Configuration for accessing Amazon GetIdentityDkimAttributes service | |
GetIdentityDkimAttributesResult | ||
GetIdentityNotificationAttributesRequest |
Container for the parameters to the GetIdentityNotificationAttributes operation.
Given a list of verified identities (email addresses and/or domains), returns a structure
describing identity notification attributes.
This action 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. |
|
GetIdentityNotificationAttributesResponse | Configuration for accessing Amazon GetIdentityNotificationAttributes service | |
GetIdentityNotificationAttributesResult | ||
GetIdentityPoliciesRequest |
Container for the parameters to the GetIdentityPolicies operation.
Returns the requested sending authorization policies for the given identity (email
address or 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.
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. This action is throttled at one request per second. |
|
GetIdentityPoliciesResponse | Configuration for accessing Amazon GetIdentityPolicies service | |
GetIdentityPoliciesResult | ||
GetIdentityVerificationAttributesRequest |
Container for the parameters to the GetIdentityVerificationAttributes operation.
Given a list of identities (email addresses and/or domains), returns the verification
status and (for domain identities) the verification token for each identity.
This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time. |
|
GetIdentityVerificationAttributesResponse | Configuration for accessing Amazon GetIdentityVerificationAttributes service | |
GetIdentityVerificationAttributesResult | ||
GetSendQuotaRequest |
Container for the parameters to the GetSendQuota operation.
Returns the user's current sending limits.
This action is throttled at one request per second. |
|
GetSendQuotaResponse | Configuration for accessing Amazon GetSendQuota service | |
GetSendQuotaResult | ||
GetSendStatisticsRequest |
Container for the parameters to the GetSendStatistics operation.
Returns the user's sending statistics. 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 interval. This action is throttled at one request per second. |
|
GetSendStatisticsResponse | Configuration for accessing Amazon GetSendStatistics service | |
GetSendStatisticsResult | ||
IdentityDkimAttributes | Represents the DKIM attributes of a verified email address or a domain. | |
IdentityNotificationAttributes | 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. | |
IdentityVerificationAttributes | Represents the verification attributes of a single identity. | |
InvalidLambdaFunctionException | SimpleEmailService exception | |
InvalidPolicyException | SimpleEmailService exception | |
InvalidS3ConfigurationException | SimpleEmailService exception | |
InvalidSnsTopicException | SimpleEmailService exception | |
LambdaAction |
When included in a receipt rule, this action calls an AWS Lambda function and, optionally,
publishes a notification to Amazon Simple Notification Service (Amazon SNS).
To enable Amazon SES to call your AWS 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 AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide. |
|
LimitExceededException | SimpleEmailService exception | |
ListIdentitiesRequest |
Container for the parameters to the ListIdentities operation.
Returns a list containing all of the identities (email addresses and domains) for
a specific AWS Account, regardless of verification status.
This action is throttled at one request per second. |
|
ListIdentitiesResponse | Configuration for accessing Amazon ListIdentities service | |
ListIdentitiesResult | ||
ListIdentityPoliciesRequest |
Container for the parameters to the ListIdentityPolicies operation.
Returns a list of sending authorization policies that are attached to the given identity
(email address or domain). This API returns only a list. If you want the actual policy
content, you can use GetIdentityPolicies .
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. This action is throttled at one request per second. |
|
ListIdentityPoliciesResponse | Configuration for accessing Amazon ListIdentityPolicies service | |
ListIdentityPoliciesResult | ||
ListReceiptFiltersRequest |
Container for the parameters to the ListReceiptFilters operation.
Lists the IP address filters associated with your account.
For information about managing IP address filters, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
ListReceiptFiltersResponse | Configuration for accessing Amazon ListReceiptFilters service | |
ListReceiptFiltersResult | ||
ListReceiptRuleSetsRequest |
Container for the parameters to the ListReceiptRuleSets operation.
Lists the receipt rule sets that exist under your AWS account. 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. This action is throttled at one request per second. |
|
ListReceiptRuleSetsResponse | Configuration for accessing Amazon ListReceiptRuleSets service | |
ListReceiptRuleSetsResult | ||
ListVerifiedEmailAddressesRequest |
Container for the parameters to the ListVerifiedEmailAddresses operation.
Returns a list containing all of the email addresses that have been verified.
This action is throttled at one request per second. |
|
ListVerifiedEmailAddressesResponse | Configuration for accessing Amazon ListVerifiedEmailAddresses service | |
ListVerifiedEmailAddressesResult | ||
Message | Represents the message to be sent, composed of a subject and a body. | |
MessageDsn |
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. |
|
MessageRejectedException | SimpleEmailService exception | |
PutIdentityPolicyRequest |
Container for the parameters to the PutIdentityPolicy operation.
Adds or updates a sending authorization policy for the specified identity (email address
or domain).
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. This action is throttled at one request per second. |
|
PutIdentityPolicyResponse | Configuration for accessing Amazon PutIdentityPolicy service | |
PutIdentityPolicyResult | ||
RawMessage | Represents the raw data of the message. | |
ReceiptAction |
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. |
|
ReceiptFilter |
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. |
|
ReceiptIpFilter |
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 |
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 to which it applies. 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. |
|
ReceiptRuleSetMetadata |
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. |
|
RecipientDsnFields |
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. |
|
ReorderReceiptRuleSetRequest |
Container for the parameters to the ReorderReceiptRuleSet operation.
Reorders the receipt rules within a receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
ReorderReceiptRuleSetResponse | Configuration for accessing Amazon ReorderReceiptRuleSet service | |
ReorderReceiptRuleSetResult | ||
RuleDoesNotExistException | SimpleEmailService exception | |
RuleSetDoesNotExistException | SimpleEmailService exception | |
S3Action |
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 AWS 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 giving permissions, see the Amazon SES Developer Guide. For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide. |
|
SendBounceRequest |
Container for the parameters to the SendBounce operation.
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.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
SendBounceResponse | Configuration for accessing Amazon SendBounce service | |
SendBounceResult | ||
SendDataPoint |
Represents sending statistics data. Each SendDataPoint contains statistics
for a 15-minute period of sending activity.
|
|
SendEmailRequest |
Container for the parameters to the SendEmail operation.
Composes an email message based on input data, and then immediately queues the message
for sending.
There are several important points to know about
|
|
SendEmailResponse | Configuration for accessing Amazon SendEmail service | |
SendEmailResult | ||
SendRawEmailRequest |
Container for the parameters to the SendRawEmail operation.
Sends an email message, with header and content specified by the client. The SendRawEmail
action is useful for sending multipart MIME emails. The raw text of the message must
comply with Internet email standards; otherwise, the message cannot be sent.
There are several important points to know about
|
|
SendRawEmailResponse | Configuration for accessing Amazon SendRawEmail service | |
SendRawEmailResult | ||
SetActiveReceiptRuleSetRequest |
Container for the parameters to the SetActiveReceiptRuleSet operation.
Sets the specified receipt rule set as the active receipt rule set.
For information about managing receipt rule sets, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
SetActiveReceiptRuleSetResponse | Configuration for accessing Amazon SetActiveReceiptRuleSet service | |
SetActiveReceiptRuleSetResult | ||
SetIdentityDkimEnabledRequest |
Container for the parameters to the SetIdentityDkimEnabled operation.
Enables or disables Easy DKIM signing of email sent from an identity:
For email addresses (e.g., This action is throttled at one request per second. For more information about Easy DKIM signing, go to the Amazon SES Developer Guide. |
|
SetIdentityDkimEnabledResponse | Configuration for accessing Amazon SetIdentityDkimEnabled service | |
SetIdentityDkimEnabledResult | ||
SetIdentityFeedbackForwardingEnabledRequest |
Container for the parameters to the SetIdentityFeedbackForwardingEnabled operation.
Given an identity (email address or 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.
This action is throttled at one request per second. For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide. |
|
SetIdentityFeedbackForwardingEnabledResponse | Configuration for accessing Amazon SetIdentityFeedbackForwardingEnabled service | |
SetIdentityFeedbackForwardingEnabledResult | ||
SetIdentityNotificationTopicRequest |
Container for the parameters to the SetIdentityNotificationTopic operation.
Given an identity (email address or domain), sets the Amazon Simple Notification Service
(Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery
notifications for emails sent with that identity as the Source .
SetIdentityFeedbackForwardingEnabled .
This action is throttled at one request per second. For more information about feedback notification, see the Amazon SES Developer Guide. |
|
SetIdentityNotificationTopicResponse | Configuration for accessing Amazon SetIdentityNotificationTopic service | |
SetIdentityNotificationTopicResult | ||
SetReceiptRulePositionRequest |
Container for the parameters to the SetReceiptRulePosition operation.
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. This action is throttled at one request per second. |
|
SetReceiptRulePositionResponse | Configuration for accessing Amazon SetReceiptRulePosition service | |
SetReceiptRulePositionResult | ||
SNSAction |
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. For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide. |
|
StopAction |
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. |
|
UpdateReceiptRuleRequest |
Container for the parameters to the UpdateReceiptRule operation.
Updates a receipt rule.
For information about managing receipt rules, see the Amazon SES Developer Guide. This action is throttled at one request per second. |
|
UpdateReceiptRuleResponse | Configuration for accessing Amazon UpdateReceiptRule service | |
UpdateReceiptRuleResult | ||
VerifyDomainDkimRequest |
Container for the parameters to the VerifyDomainDkim operation.
Returns a set of DKIM tokens for a domain. DKIM tokens are character strings
that represent your domain's identity. Using these tokens, you will need to create
DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web
Services will eventually detect that you have updated your DNS records; this detection
process may take up to 72 hours. Upon successful detection, Amazon SES will be able
to DKIM-sign email originating from that domain.
This action is throttled at one request per second.
To enable or disable Easy DKIM signing for a domain, use the For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide. |
|
VerifyDomainDkimResponse | Configuration for accessing Amazon VerifyDomainDkim service | |
VerifyDomainDkimResult | ||
VerifyDomainIdentityRequest |
Container for the parameters to the VerifyDomainIdentity operation.
Verifies a domain.
This action is throttled at one request per second. |
|
VerifyDomainIdentityResponse | Configuration for accessing Amazon VerifyDomainIdentity service | |
VerifyDomainIdentityResult | ||
VerifyEmailAddressRequest |
Container for the parameters to the VerifyEmailAddress operation.
Verifies an email address. This action causes a confirmation email message to be sent
to the specified address.
This action is throttled at one request per second. |
|
VerifyEmailAddressResponse | ||
VerifyEmailIdentityRequest |
Container for the parameters to the VerifyEmailIdentity operation.
Verifies an email address. This action causes a confirmation email message to be sent
to the specified address.
This action is throttled at one request per second. |
|
VerifyEmailIdentityResponse | Configuration for accessing Amazon VerifyEmailIdentity service | |
VerifyEmailIdentityResult | ||
WorkmailAction |
When included in a receipt rule, this action calls Amazon WorkMail and, optionally,
publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will
typically not use this action directly 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. |