Package-level declarations

Types

Link copied to clipboard

Indicates that email sending is disabled for your entire Amazon SES account.

Link copied to clipboard

When included in a receipt rule, this action adds a header to the received email.

Link copied to clipboard

Indicates that a resource could not be created because of a naming conflict.

Link copied to clipboard
sealed class BehaviorOnMxFailure
Link copied to clipboard
class 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.

Link copied to clipboard

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).

Link copied to clipboard

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

Link copied to clipboard
sealed class BounceType
Link copied to clipboard

An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.

Link copied to clipboard

An object that contains the response from the SendBulkTemplatedEmail operation.

Link copied to clipboard
sealed class BulkEmailStatus
Link copied to clipboard

Indicates that the delete operation could not be completed.

Link copied to clipboard

Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.

Link copied to clipboard

Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

Link copied to clipboard

The name of the configuration set.

Link copied to clipboard

Indicates that the configuration set could not be created because of a naming conflict.

Link copied to clipboard
Link copied to clipboard

Indicates that the configuration set does not exist.

Link copied to clipboard

Indicates that email sending is disabled for the configuration set.

Link copied to clipboard

When included in a receipt rule, this action parses the received message and starts an email contact in Amazon Connect on your behalf.

Link copied to clipboard
class Content

Represents textual data, plus an optional character set specification.

Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an Amazon Web Services service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

An empty element returned on a successful request.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Represents a request to create an open and click tracking option object in a configuration set.

An empty element returned on a successful request.

Represents a request to create a custom verification email template.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard
Link copied to clipboard

Indicates that custom verification email template provided content is invalid.

Link copied to clipboard

Contains information about a custom verification email template.

Indicates that a custom verification email template with the name you specified already exists.

Indicates that a custom verification email template with the name you specified does not exist.

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.

An empty element returned on a successful request.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Represents a request to delete open and click tracking options in a configuration set.

An empty element returned on a successful request.

Represents a request to delete an existing custom verification email template.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Represents a request to delete one of your Amazon SES identities (an email address or domain).

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard
Link copied to clipboard

Represents a request to delete an email address from the list of email addresses you have attempted to verify under your Amazon Web Services account.

Link copied to clipboard

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

Link copied to clipboard

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.

Link copied to clipboard

Represents the metadata and receipt rules for the receipt rule set that is currently active.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Represents the details of a receipt rule.

Link copied to clipboard

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.

Link copied to clipboard

Represents the details of the specified receipt rule set.

Link copied to clipboard

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Link copied to clipboard
Link copied to clipboard
sealed class DsnAction
Link copied to clipboard

Contains information about an event destination.

Link copied to clipboard

Indicates that the event destination could not be created because of a naming conflict.

Link copied to clipboard

Indicates that the event destination does not exist.

Link copied to clipboard
sealed class EventType
Link copied to clipboard

Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

Link copied to clipboard

Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.

Link copied to clipboard

Represents a request to return the email sending status for your Amazon SES account in the current Amazon Web Services Region.

Represents a request to retrieve an existing custom verification email template.

The content of the custom verification email template.

Link copied to clipboard

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.

Link copied to clipboard

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.

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.

Represents the custom MAIL FROM attributes for a list of identities.

Link copied to clipboard

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.

Represents the notification attributes for a list of identities.

Link copied to clipboard

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.

Link copied to clipboard

Represents the requested sending authorization policies.

Link copied to clipboard

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.

The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

Link copied to clipboard
Link copied to clipboard

Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.

Link copied to clipboard
Link copied to clipboard

Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the DKIM attributes of a verified email address or a domain.

Link copied to clipboard

Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).

Link copied to clipboard

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.

Link copied to clipboard
sealed class IdentityType
Link copied to clipboard

Represents the verification attributes of a single identity.

Link copied to clipboard

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

Link copied to clipboard

Indicates that the configuration set is invalid. See the error message for details.

Link copied to clipboard

Indicates that provided delivery option is invalid.

Link copied to clipboard

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

Link copied to clipboard

Indicates that the provided Amazon Web Services Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Link copied to clipboard

Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

Link copied to clipboard

Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.

Link copied to clipboard

Indicates that the provided Amazon S3 bucket or Amazon Web Services KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Link copied to clipboard

Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.

Link copied to clipboard

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

Link copied to clipboard

Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.

Link copied to clipboard

Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:

Link copied to clipboard
sealed class InvocationType
Link copied to clipboard

Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Link copied to clipboard

When included in a receipt rule, this action calls an Amazon Web Services Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

Link copied to clipboard

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

Link copied to clipboard

Represents a request to list the configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Link copied to clipboard

A list of configuration sets associated with your Amazon Web Services account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

Represents a request to list the existing custom verification email templates for your account.

A paginated list of custom verification email templates.

Link copied to clipboard

Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your Amazon Web Services account, regardless of verification status.

Link copied to clipboard

A list of all identities that you have attempted to verify under your Amazon Web Services account, regardless of verification status.

Link copied to clipboard

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.

Link copied to clipboard

A list of names of sending authorization policies that apply to an identity.

Link copied to clipboard

Represents a request to list the IP address filters that exist under your Amazon Web Services account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

A list of IP address filters that exist under your Amazon Web Services account.

Link copied to clipboard

Represents a request to list the receipt rule sets that exist under your Amazon Web Services account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

A list of receipt rule sets that exist under your Amazon Web Services account.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A list of email addresses that you have verified with Amazon SES under your Amazon Web Services account.

Link copied to clipboard

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

Link copied to clipboard
class Message

Represents the message to be sent, composed of a subject and a body.

Link copied to clipboard

Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

Link copied to clipboard

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

Link copied to clipboard

Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.

Link copied to clipboard

Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.

Link copied to clipboard
sealed class NotificationType
Link copied to clipboard

Indicates that the account has not been granted production access.

A request to modify the delivery options for a configuration set.

An HTTP 200 response if the request succeeds, or an error message if the request fails.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Represents the raw data of the message.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
sealed class ReceiptFilterPolicy
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Information about a receipt rule set.

Link copied to clipboard

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

Link copied to clipboard

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.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Contains information about the reputation settings for a configuration set.

Link copied to clipboard

Indicates that the provided receipt rule does not exist.

Link copied to clipboard

Indicates that the provided receipt rule set does not exist.

Link copied to clipboard
class 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).

Link copied to clipboard

Represents a request to send a bounce message to the sender of an email you received through Amazon SES.

Link copied to clipboard

Represents a unique message ID.

Link copied to clipboard

Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

Represents a request to send a custom verification email to a specified recipient.

Link copied to clipboard

The response received when attempting to send the custom verification email.

Link copied to clipboard

Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.

Link copied to clipboard

Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

Represents a unique message ID.

Link copied to clipboard

Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

Represents a unique message ID.

Link copied to clipboard

Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

Base class for all service related exceptions thrown by the Ses client

Link copied to clipboard

Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.

An empty element returned on a successful request.

Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.

An empty element returned on a successful request.

Link copied to clipboard

Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or delivery notifications for emails sent with that identity as the source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard
class 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.

Link copied to clipboard
sealed class SnsActionEncoding
Link copied to clipboard

Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

Link copied to clipboard

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).

Link copied to clipboard
sealed class StopScope
Link copied to clipboard
class Template

The content of the email, composed of a subject line and either an HTML part or a text-only part.

Link copied to clipboard

Indicates that the Template object you specified does not exist in your Amazon SES account.

Link copied to clipboard

Contains information about an email template.

Link copied to clipboard
Link copied to clipboard
sealed class TlsPolicy
Link copied to clipboard

A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

Link copied to clipboard

Indicates that the configuration set you specified already contains a TrackingOptions object.

Link copied to clipboard

Indicates that the TrackingOptions object you specified does not exist.

Link copied to clipboard

Represents a request to enable or disable the email sending capabilities for your entire Amazon SES account.

Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

An empty element returned on a successful request.

Represents a request to modify the reputation metric publishing settings for a configuration set.

Represents a request to enable or disable the email sending capabilities for a specific configuration set.

Represents a request to update the tracking options for a configuration set.

An empty element returned on a successful request.

Represents a request to update an existing custom verification email template.

Link copied to clipboard

Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class VerificationStatus
Link copied to clipboard

Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

Link copied to clipboard

Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.

Link copied to clipboard

Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.

Link copied to clipboard

Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.

Link copied to clipboard

Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

Link copied to clipboard

Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

Link copied to clipboard

An empty element returned on a successful request.

Link copied to clipboard

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up manually, because Amazon WorkMail adds the rule automatically during its setup procedure.