Crate rusoto_sesv2
source · [−]Expand description
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
An object that contains information about your account details.
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
Represents the body of the email message.
An object that contains the body of the message. You can specify a template message.
The result of the SendBulkEmail operation of each specified BulkEmailEntry.
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.
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
A contact is the end-user who is receiving the email.
A list that contains contacts that have subscribed to a particular topic or topics.
An object that contains details about the action of a contact list.
An object that represents the content of the email, and optionally a character set specification.
A request to add an event destination to a configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to create a configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Represents a request to create a custom verification email template.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A request to create a new dedicated IP pool.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
Information about the predictive inbox placement test that you created.
Represents a request to create 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.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to begin the verification process for an email identity (an email address or domain).
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.
Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Represents a request to create an import job from a data source for a data destination.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Contains information about a custom verification email template.
An object that contains information about the volume of email sent on each day of the analysis period.
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.
A request to delete an event destination from a configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to delete a configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Represents a request to delete an existing custom verification email template.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A request to delete a dedicated IP pool.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A request to remove an email address from the suppression list for your account.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
An object that contains metadata related to a predictive inbox placement test.
Used to associate a configuration set with a dedicated IP pool.
An object that describes the recipients for an email.
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
An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).
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).
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.
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
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.
The content of the email, composed of a subject line, an HTML part, and a text-only part.
Contains information about an email template.
In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. 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.
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.
An object that contains the failure details about an import job.
A request to obtain information about the email-sending capabilities of your Amazon SES account.
A list of details about the email-sending capabilities of your Amazon SES account in the current AWS Region.
A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.
An object that contains information about blacklist events.
A request to obtain information about the event destinations for a configuration set.
Information about an event destination for a configuration set.
A request to obtain information about a configuration set.
Information about a configuration set.
Represents a request to retrieve an existing custom verification email template.
The following elements are returned by the service.
A request to obtain more information about a dedicated IP address.
Information about a dedicated IP address.
A request to obtain more information about dedicated IP pools.
Information about the dedicated IP addresses that are associated with your AWS account.
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.
An object that shows the status of the Deliverability dashboard.
A request to retrieve the results of a predictive inbox placement test.
The results of the predictive inbox placement test.
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).
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.
A request to obtain deliverability metrics for a domain.
An object that includes statistics that are related to the domain that you specified.
A request to return the policies of an email identity.
Identity policies associated with email identity.
A request to return details about an email identity.
Details about an email identity.
Represents a request to display the template object (which includes the subject line, HTML part and text part) for the template you specify.
The following element is returned by the service.
Represents a request for information about an import job using the import job ID.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to retrieve information about an email address that's on the suppression list for your account.
Information about the suppressed email address.
Information about an email identity.
An object that contains details about the data source of the import job.
An object that contains details about the resource destination the import job is going to target.
A summary of the import job.
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.
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
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.
A request to obtain a list of configuration sets for your Amazon SES account in the current AWS Region.
A list of configuration sets in your Amazon SES account in the current AWS Region.
A filter that can be applied to a list of contacts.
Represents a request to list the existing custom verification email templates for your account.
The following elements are returned by the service.
A request to obtain a list of dedicated IP pools.
A list of dedicated IP pools.
A request to list all of the predictive inbox placement tests that you've performed.
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
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.
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.
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.
A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.
Represents a request to list the email templates present in your Amazon SES account in the current AWS Region. For more information, see the Amazon SES Developer Guide.
The following elements are returned by the service.
Represents a request to list all of the import jobs for a data destination within the specified maximum number of import jobs.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
A request to obtain a list of email destinations that are on the suppression list for your account.
A list of suppressed email addresses.
A list of attributes that are associated with a MAIL FROM domain.
Represents the email message that you're sending. The Message object consists of a subject line and a message body.
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.
An object that contains information about email that was sent from the selected domain.
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.
An object that contains inbox placement data for an email provider.
A request to enable or disable the automatic IP address warm-up feature.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to submit new account details.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to change the ability of your account to send email.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to change your account's suppression preferences.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to associate a configuration set with a dedicated IP pool.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to enable or disable tracking of reputation metrics for a configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to enable or disable the ability of Amazon SES to send emails that use a specific configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to change the account suppression list preferences for a specific configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to add a custom domain for tracking open and click events to a configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to move a dedicated IP address to a dedicated IP pool.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
A response that indicates whether the Deliverability dashboard is enabled.
A request to associate a configuration set with an email identity.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A request to enable or disable DKIM signing of email that you send from an email identity.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to change the DKIM attributes for an email identity.
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
A request to set the attributes that control how bounce and complaint events are processed.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to configure the custom MAIL FROM domain for a verified identity.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A request to add an email destination to the suppression list for your account.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Represents the raw content of an email message.
The ReplaceEmailContent object to be used for a specific BulkEmailEntry. The ReplacementTemplate can be specified within this object.
An object which contains ReplacementTemplateData to be used for a specific BulkEmailEntry.
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
An object that contains information about your account details review.
Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.
The following data is returned in JSON format by the service.
Represents a request to send a custom verification email to a specified recipient.
The following element is returned by the service.
Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.
A unique message ID that you receive when an email is accepted for sending.
An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current AWS Region.
Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
A client for the Amazon SES V2 API.
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
An object that contains information about an email address that is on the suppression list for your account.
An object that contains additional attributes that are related an email address that is on the suppression list for your account.
A summary that describes the suppressed email address.
An object that contains information about the email address suppression preferences for your account in the current AWS Region.
An object that contains details about the action of suppression list.
An object that contains information about the suppression list preferences for your account.
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.
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.
>Represents a request to create a preview of the MIME content of an email when provided with a template and a set of replacement data.
The following element is returned by the service.
An interest group, theme, or label within a list. Lists can have multiple topics.
Used for filtering by a specific topic preference.
The contact's preference for being opted-in to or opted-out of a topic.
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.
A request to change the settings for an event destination for a configuration set.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Represents a request to update an existing custom verification email template.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Represents a request to 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.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Represents a request to update an email template. For more information, see the Amazon SES Developer Guide.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
An object that contains information about the amount of email that was delivered to recipients.
Enums
Errors returned by CreateConfigurationSet
Errors returned by CreateConfigurationSetEventDestination
Errors returned by CreateContact
Errors returned by CreateContactList
Errors returned by CreateCustomVerificationEmailTemplate
Errors returned by CreateDedicatedIpPool
Errors returned by CreateDeliverabilityTestReport
Errors returned by CreateEmailIdentity
Errors returned by CreateEmailIdentityPolicy
Errors returned by CreateEmailTemplate
Errors returned by CreateImportJob
Errors returned by DeleteConfigurationSet
Errors returned by DeleteConfigurationSetEventDestination
Errors returned by DeleteContact
Errors returned by DeleteContactList
Errors returned by DeleteCustomVerificationEmailTemplate
Errors returned by DeleteDedicatedIpPool
Errors returned by DeleteEmailIdentity
Errors returned by DeleteEmailIdentityPolicy
Errors returned by DeleteEmailTemplate
Errors returned by DeleteSuppressedDestination
Errors returned by GetAccount
Errors returned by GetBlacklistReports
Errors returned by GetConfigurationSet
Errors returned by GetConfigurationSetEventDestinations
Errors returned by GetContact
Errors returned by GetContactList
Errors returned by GetCustomVerificationEmailTemplate
Errors returned by GetDedicatedIp
Errors returned by GetDedicatedIps
Errors returned by GetDeliverabilityDashboardOptions
Errors returned by GetDeliverabilityTestReport
Errors returned by GetDomainDeliverabilityCampaign
Errors returned by GetDomainStatisticsReport
Errors returned by GetEmailIdentity
Errors returned by GetEmailIdentityPolicies
Errors returned by GetEmailTemplate
Errors returned by GetImportJob
Errors returned by GetSuppressedDestination
Errors returned by ListConfigurationSets
Errors returned by ListContactLists
Errors returned by ListContacts
Errors returned by ListCustomVerificationEmailTemplates
Errors returned by ListDedicatedIpPools
Errors returned by ListDeliverabilityTestReports
Errors returned by ListDomainDeliverabilityCampaigns
Errors returned by ListEmailIdentities
Errors returned by ListEmailTemplates
Errors returned by ListImportJobs
Errors returned by ListSuppressedDestinations
Errors returned by ListTagsForResource
Errors returned by PutAccountDedicatedIpWarmupAttributes
Errors returned by PutAccountDetails
Errors returned by PutAccountSendingAttributes
Errors returned by PutAccountSuppressionAttributes
Errors returned by PutConfigurationSetDeliveryOptions
Errors returned by PutConfigurationSetReputationOptions
Errors returned by PutConfigurationSetSendingOptions
Errors returned by PutConfigurationSetSuppressionOptions
Errors returned by PutConfigurationSetTrackingOptions
Errors returned by PutDedicatedIpInPool
Errors returned by PutDedicatedIpWarmupAttributes
Errors returned by PutDeliverabilityDashboardOption
Errors returned by PutEmailIdentityConfigurationSetAttributes
Errors returned by PutEmailIdentityDkimAttributes
Errors returned by PutEmailIdentityDkimSigningAttributes
Errors returned by PutEmailIdentityFeedbackAttributes
Errors returned by PutEmailIdentityMailFromAttributes
Errors returned by PutSuppressedDestination
Errors returned by SendBulkEmail
Errors returned by SendCustomVerificationEmail
Errors returned by SendEmail
Errors returned by TagResource
Errors returned by TestRenderEmailTemplate
Errors returned by UntagResource
Errors returned by UpdateConfigurationSetEventDestination
Errors returned by UpdateContact
Errors returned by UpdateContactList
Errors returned by UpdateCustomVerificationEmailTemplate
Errors returned by UpdateEmailIdentityPolicy
Errors returned by UpdateEmailTemplate
Traits
Trait representing the capabilities of the Amazon SES V2 API. Amazon SES V2 clients implement this trait.