[][src]Crate rusoto_sesv2

Amazon SES API v2

Welcome to the Amazon SES API v2 Reference. This guide provides information about the Amazon SES API v2, including supported operations, data types, parameters, and schemas.

Amazon SES is an AWS service that you can use to send email messages to your customers.

If you're new to Amazon SES API v2, you might find it helpful to also review the Amazon Simple Email Service Developer Guide. The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.

The Amazon SES API v2 is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

If you're using the service, you're probably looking for SesV2Client and SesV2.

Structs

BlacklistEntry

An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.

Body

Represents the body of the email message.

CloudWatchDestination

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

CloudWatchDimensionConfiguration

An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.

Content

An object that represents the content of the email, and optionally a character set specification.

CreateConfigurationSetEventDestinationRequest

A request to add an event destination to a configuration set.

CreateConfigurationSetEventDestinationResponse

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

CreateConfigurationSetRequest

A request to create a configuration set.

CreateConfigurationSetResponse

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

CreateDedicatedIpPoolRequest

A request to create a new dedicated IP pool.

CreateDedicatedIpPoolResponse

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

CreateDeliverabilityTestReportRequest

A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. We send that message to special email addresses spread across several major email providers around the world. The test takes about 24 hours to complete. When the test is complete, you can use the GetDeliverabilityTestReport operation to view the results of the test.

CreateDeliverabilityTestReportResponse

Information about the predictive inbox placement test that you created.

CreateEmailIdentityRequest

A request to begin the verification process for an email identity (an email address or domain).

CreateEmailIdentityResponse

If the email identity is a domain, this object contains information about the DKIM verification status for the domain.

If the email identity is an email address, this object is empty.

DailyVolume

An object that contains information about the volume of email sent on each day of the analysis period.

DedicatedIp

Contains information about a dedicated IP address that is associated with your Amazon SES account.

To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.

DeleteConfigurationSetEventDestinationRequest

A request to delete an event destination from a configuration set.

DeleteConfigurationSetEventDestinationResponse

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

DeleteConfigurationSetRequest

A request to delete a configuration set.

DeleteConfigurationSetResponse

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

DeleteDedicatedIpPoolRequest

A request to delete a dedicated IP pool.

DeleteDedicatedIpPoolResponse

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

DeleteEmailIdentityRequest

A request to delete an existing email identity. When you delete an identity, you lose the ability to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.

DeleteEmailIdentityResponse

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

DeleteSuppressedDestinationRequest

A request to remove an email address from the suppression list for your account.

DeleteSuppressedDestinationResponse

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

DeliverabilityTestReport

An object that contains metadata related to a predictive inbox placement test.

DeliveryOptions

Used to associate a configuration set with a dedicated IP pool.

Destination

An object that describes the recipients for an email.

DkimAttributes

An object that contains information about the DKIM authentication status for an email identity.

Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity

DkimSigningAttributes

An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).

DomainDeliverabilityCampaign

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

DomainDeliverabilityTrackingOption

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

DomainIspPlacement

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

EmailContent

An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.

EventDestination

In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

EventDestinationDefinition

An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.

GetAccountRequest

A request to obtain information about the email-sending capabilities of your Amazon SES account.

GetAccountResponse

A list of details about the email-sending capabilities of your Amazon SES account in the current AWS Region.

GetBlacklistReportsRequest

A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.

GetBlacklistReportsResponse

An object that contains information about blacklist events.

GetConfigurationSetEventDestinationsRequest

A request to obtain information about the event destinations for a configuration set.

GetConfigurationSetEventDestinationsResponse

Information about an event destination for a configuration set.

GetConfigurationSetRequest

A request to obtain information about a configuration set.

GetConfigurationSetResponse

Information about a configuration set.

GetDedicatedIpRequest

A request to obtain more information about a dedicated IP address.

GetDedicatedIpResponse

Information about a dedicated IP address.

GetDedicatedIpsRequest

A request to obtain more information about dedicated IP pools.

GetDedicatedIpsResponse

Information about the dedicated IP addresses that are associated with your AWS account.

GetDeliverabilityDashboardOptionsRequest

Retrieve information about the status of the Deliverability dashboard for your AWS account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for your domains. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

GetDeliverabilityDashboardOptionsResponse

An object that shows the status of the Deliverability dashboard.

GetDeliverabilityTestReportRequest

A request to retrieve the results of a predictive inbox placement test.

GetDeliverabilityTestReportResponse

The results of the predictive inbox placement test.

GetDomainDeliverabilityCampaignRequest

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

GetDomainDeliverabilityCampaignResponse

An object that contains all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.

GetDomainStatisticsReportRequest

A request to obtain deliverability metrics for a domain.

GetDomainStatisticsReportResponse

An object that includes statistics that are related to the domain that you specified.

GetEmailIdentityRequest

A request to return details about an email identity.

GetEmailIdentityResponse

Details about an email identity.

GetSuppressedDestinationRequest

A request to retrieve information about an email address that's on the suppression list for your account.

GetSuppressedDestinationResponse

Information about the suppressed email address.

IdentityInfo

Information about an email identity.

InboxPlacementTrackingOption

An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain.

IspPlacement

An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.

KinesisFirehoseDestination

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

ListConfigurationSetsRequest

A request to obtain a list of configuration sets for your Amazon SES account in the current AWS Region.

ListConfigurationSetsResponse

A list of configuration sets in your Amazon SES account in the current AWS Region.

ListDedicatedIpPoolsRequest

A request to obtain a list of dedicated IP pools.

ListDedicatedIpPoolsResponse

A list of dedicated IP pools.

ListDeliverabilityTestReportsRequest

A request to list all of the predictive inbox placement tests that you've performed.

ListDeliverabilityTestReportsResponse

A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.

ListDomainDeliverabilityCampaignsRequest

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard.

ListDomainDeliverabilityCampaignsResponse

An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.

ListEmailIdentitiesRequest

A request to list all of the email identities associated with your AWS account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.

ListEmailIdentitiesResponse

A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.

ListSuppressedDestinationsRequest

A request to obtain a list of email destinations that are on the suppression list for your account.

ListSuppressedDestinationsResponse

A list of suppressed email addresses.

ListTagsForResourceRequest
ListTagsForResourceResponse
MailFromAttributes

A list of attributes that are associated with a MAIL FROM domain.

Message

Represents the email message that you're sending. The Message object consists of a subject line and a message body.

MessageTag

Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

OverallVolume

An object that contains information about email that was sent from the selected domain.

PinpointDestination

An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.

PlacementStatistics

An object that contains inbox placement data for an email provider.

PutAccountDedicatedIpWarmupAttributesRequest

A request to enable or disable the automatic IP address warm-up feature.

PutAccountDedicatedIpWarmupAttributesResponse

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

PutAccountSendingAttributesRequest

A request to change the ability of your account to send email.

PutAccountSendingAttributesResponse

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

PutAccountSuppressionAttributesRequest

A request to change your account's suppression preferences.

PutAccountSuppressionAttributesResponse

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

PutConfigurationSetDeliveryOptionsRequest

A request to associate a configuration set with a dedicated IP pool.

PutConfigurationSetDeliveryOptionsResponse

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

PutConfigurationSetReputationOptionsRequest

A request to enable or disable tracking of reputation metrics for a configuration set.

PutConfigurationSetReputationOptionsResponse

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

PutConfigurationSetSendingOptionsRequest

A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration set.

PutConfigurationSetSendingOptionsResponse

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

PutConfigurationSetSuppressionOptionsRequest

A request to change the account suppression list preferences for a specific configuration set.

PutConfigurationSetSuppressionOptionsResponse

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

PutConfigurationSetTrackingOptionsRequest

A request to add a custom domain for tracking open and click events to a configuration set.

PutConfigurationSetTrackingOptionsResponse

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

PutDedicatedIpInPoolRequest

A request to move a dedicated IP address to a dedicated IP pool.

PutDedicatedIpInPoolResponse

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

PutDedicatedIpWarmupAttributesRequest

A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.

PutDedicatedIpWarmupAttributesResponse

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

PutDeliverabilityDashboardOptionRequest

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon SES API v2. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

PutDeliverabilityDashboardOptionResponse

A response that indicates whether the Deliverability dashboard is enabled.

PutEmailIdentityDkimAttributesRequest

A request to enable or disable DKIM signing of email that you send from an email identity.

PutEmailIdentityDkimAttributesResponse

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

PutEmailIdentityDkimSigningAttributesRequest

A request to change the DKIM attributes for an email identity.

PutEmailIdentityDkimSigningAttributesResponse

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PutEmailIdentityFeedbackAttributesRequest

A request to set the attributes that control how bounce and complaint events are processed.

PutEmailIdentityFeedbackAttributesResponse

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

PutEmailIdentityMailFromAttributesRequest

A request to configure the custom MAIL FROM domain for a verified identity.

PutEmailIdentityMailFromAttributesResponse

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

PutSuppressedDestinationRequest

A request to add an email destination to the suppression list for your account.

PutSuppressedDestinationResponse

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

RawMessage

Represents the raw content of an email message.

ReputationOptions

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.

SendEmailRequest

A request to send an email message.

SendEmailResponse

A unique message ID that you receive when an email is accepted for sending.

SendQuota

An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current AWS Region.

SendingOptions

Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.

SesV2Client

A client for the Amazon SES V2 API.

SnsDestination

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

SuppressedDestination

An object that contains information about an email address that is on the suppression list for your account.

SuppressedDestinationAttributes

An object that contains additional attributes that are related an email address that is on the suppression list for your account.

SuppressedDestinationSummary

A summary that describes the suppressed email address.

SuppressionAttributes

An object that contains information about the email address suppression preferences for your account in the current AWS Region.

SuppressionOptions

An object that contains information about the suppression list preferences for your account.

Tag

An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

  • Tag keys and values are case sensitive.

  • For each associated resource, each tag key must be unique and it can have only one value.

  • The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

  • You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.

TagResourceRequest
TagResourceResponse
Template

An object that defines the email template to use for an email message, and the values to use for any message variables in that template. An email template is a type of message template that contains content that you want to define, save, and reuse in email messages that you send.

TrackingOptions

An object that defines the tracking options for a configuration set. When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

These images and links include references to a domain operated by AWS. You can optionally configure the Amazon SES to use a domain that you operate for these images and links.

UntagResourceRequest
UntagResourceResponse
UpdateConfigurationSetEventDestinationRequest

A request to change the settings for an event destination for a configuration set.

UpdateConfigurationSetEventDestinationResponse

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

VolumeStatistics

An object that contains information about the amount of email that was delivered to recipients.

Enums

CreateConfigurationSetError

Errors returned by CreateConfigurationSet

CreateConfigurationSetEventDestinationError

Errors returned by CreateConfigurationSetEventDestination

CreateDedicatedIpPoolError

Errors returned by CreateDedicatedIpPool

CreateDeliverabilityTestReportError

Errors returned by CreateDeliverabilityTestReport

CreateEmailIdentityError

Errors returned by CreateEmailIdentity

DeleteConfigurationSetError

Errors returned by DeleteConfigurationSet

DeleteConfigurationSetEventDestinationError

Errors returned by DeleteConfigurationSetEventDestination

DeleteDedicatedIpPoolError

Errors returned by DeleteDedicatedIpPool

DeleteEmailIdentityError

Errors returned by DeleteEmailIdentity

DeleteSuppressedDestinationError

Errors returned by DeleteSuppressedDestination

GetAccountError

Errors returned by GetAccount

GetBlacklistReportsError

Errors returned by GetBlacklistReports

GetConfigurationSetError

Errors returned by GetConfigurationSet

GetConfigurationSetEventDestinationsError

Errors returned by GetConfigurationSetEventDestinations

GetDedicatedIpError

Errors returned by GetDedicatedIp

GetDedicatedIpsError

Errors returned by GetDedicatedIps

GetDeliverabilityDashboardOptionsError

Errors returned by GetDeliverabilityDashboardOptions

GetDeliverabilityTestReportError

Errors returned by GetDeliverabilityTestReport

GetDomainDeliverabilityCampaignError

Errors returned by GetDomainDeliverabilityCampaign

GetDomainStatisticsReportError

Errors returned by GetDomainStatisticsReport

GetEmailIdentityError

Errors returned by GetEmailIdentity

GetSuppressedDestinationError

Errors returned by GetSuppressedDestination

ListConfigurationSetsError

Errors returned by ListConfigurationSets

ListDedicatedIpPoolsError

Errors returned by ListDedicatedIpPools

ListDeliverabilityTestReportsError

Errors returned by ListDeliverabilityTestReports

ListDomainDeliverabilityCampaignsError

Errors returned by ListDomainDeliverabilityCampaigns

ListEmailIdentitiesError

Errors returned by ListEmailIdentities

ListSuppressedDestinationsError

Errors returned by ListSuppressedDestinations

ListTagsForResourceError

Errors returned by ListTagsForResource

PutAccountDedicatedIpWarmupAttributesError

Errors returned by PutAccountDedicatedIpWarmupAttributes

PutAccountSendingAttributesError

Errors returned by PutAccountSendingAttributes

PutAccountSuppressionAttributesError

Errors returned by PutAccountSuppressionAttributes

PutConfigurationSetDeliveryOptionsError

Errors returned by PutConfigurationSetDeliveryOptions

PutConfigurationSetReputationOptionsError

Errors returned by PutConfigurationSetReputationOptions

PutConfigurationSetSendingOptionsError

Errors returned by PutConfigurationSetSendingOptions

PutConfigurationSetSuppressionOptionsError

Errors returned by PutConfigurationSetSuppressionOptions

PutConfigurationSetTrackingOptionsError

Errors returned by PutConfigurationSetTrackingOptions

PutDedicatedIpInPoolError

Errors returned by PutDedicatedIpInPool

PutDedicatedIpWarmupAttributesError

Errors returned by PutDedicatedIpWarmupAttributes

PutDeliverabilityDashboardOptionError

Errors returned by PutDeliverabilityDashboardOption

PutEmailIdentityDkimAttributesError

Errors returned by PutEmailIdentityDkimAttributes

PutEmailIdentityDkimSigningAttributesError

Errors returned by PutEmailIdentityDkimSigningAttributes

PutEmailIdentityFeedbackAttributesError

Errors returned by PutEmailIdentityFeedbackAttributes

PutEmailIdentityMailFromAttributesError

Errors returned by PutEmailIdentityMailFromAttributes

PutSuppressedDestinationError

Errors returned by PutSuppressedDestination

SendEmailError

Errors returned by SendEmail

TagResourceError

Errors returned by TagResource

UntagResourceError

Errors returned by UntagResource

UpdateConfigurationSetEventDestinationError

Errors returned by UpdateConfigurationSetEventDestination

Traits

SesV2

Trait representing the capabilities of the Amazon SES V2 API. Amazon SES V2 clients implement this trait.