Package-level declarations
Types
An object that contains information about your account details.
The message can't be sent because the account's ability to send email has been permanently restricted.
The resource specified in your request already exists.
The input you provided is invalid.
Represents a single metric data query to include in a batch.
Represents a request to retrieve a batch of metric data.
Represents the result of processing your metric data batch request
The action to take if the required MX record can't be found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
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.
Represents a request to cancel an export job using the export job ID.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
The resource is being modified by another operation or thread.
If there is already an ongoing account details update under review.
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.
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.
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 export job from a data source to a data destination.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
An object containing additional settings for your VDM configuration as applicable to the Dashboard.
An object containing additional settings for your VDM configuration as applicable to the Dashboard.
The data format of a file, can be one of the following:
Contains information about a dedicated IP address that is associated with your Amazon SES account.
Contains information about a dedicated IP pool.
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.
The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.
An object that contains metadata related to a predictive inbox placement test.
The status of a predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport operation to view the results of the test.
The type of delivery events:
Used to associate a configuration set with a dedicated IP pool.
An object that describes the recipients for an email.
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.
An object that contains information about the DKIM authentication status for an email identity.
An object that contains configuration for Bring Your Own DKIM (BYODKIM), or, for Easy DKIM
The DKIM authentication status of the identity. The status can be one of the following:
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.
An email's insights contain metadata and delivery information about a specific email.
The content of the email, composed of a subject line, an HTML part, and a text-only part.
Contains information about an email template.
The type of delivery events:
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.
Contains a Bounce object if the event type is BOUNCE. Contains a Complaint object if the event type is COMPLAINT.
An object that contains details about the data source of the export job. It can only contain one of MetricsDataSource or MessageInsightsDataSource object.
An object that contains details about the destination of the export job.
A summary of the export job.
An object that contains a mapping between a Metric and MetricAggregation.
The type of data source of an export, can be one of the following:
Statistics about the execution of an export job.
An object that contains the failure details about a 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 Amazon Web Services 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 pool.
The following element is 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 Amazon Web Services account.
Retrieve information about the status of the Deliverability dashboard for your Amazon Web Services 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.
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 to retrieve information about an export job using the export job ID.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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 return information about a message.
Information about a message.
A request to retrieve information about an email address that's on the suppression list for your account.
Information about the suppressed email address.
An object containing additional settings for your VDM configuration as applicable to the Guardian.
An object containing additional settings for your VDM configuration as applicable to the Guardian.
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.
The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.
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 Amazon Web Services account. This data is available only if you enabled the Deliverability dashboard for the domain.
An object containing details about a specific event.
The request couldn't be processed because an error occurred with the Amazon SES API v2.
The specified request includes an invalid or expired token.
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.
There are too many instances of the specified resource type.
A request to obtain a list of configuration sets for your Amazon SES account in the current Amazon Web Services Region.
A list of configuration sets in your Amazon SES account in the current Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region. For more information, see the Amazon SES Developer Guide.
The following elements are returned by the service.
Represents a request to list all export jobs with filters.
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
The ListRecommendations filter type. This can be one of the following:
Represents a request to list the existing recommendations for your account.
Contains the response to your request to retrieve the list of recommendations for your account.
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.
The message can't be sent because the sending domain isn't verified.
The status of the MAIL FROM domain. This status can have the following values:
An object that contains filters applied when performing the Message Insights export.
An object containing Message Insights filters.
The message can't be sent because it contains invalid content.
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.
The aggregation to apply to a metric, can be one of the following:
An error corresponding to the unsuccessful processing of a single metric data query.
The result of a single metric data query.
The BatchGetMetricDataQuery dimension name. This can be one of the following:
An object that contains details about the data source for the metrics export.
The resource you attempted to access doesn't exist.
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 submit new account VDM attributes.
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 add specific VDM settings 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 convert a dedicated IP pool to a different scaling mode.
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.
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.
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.
A recommendation generated for your account.
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 Amazon Web Services 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.
Used to enable or disable email sending for messages that use this configuration set in the current Amazon Web Services Region.
The message can't be sent because the account's ability to send email is currently paused.
Base class for all service related exceptions thrown by the SesV2 client
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 Amazon Web Services Region.
An object that contains details about the action of suppression list.
The type of action to perform on the address. The following are possible values:
The reason that the address was added to the suppression list for your account. The value can be one of the following:
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.
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.
The following element is returned by the service.
Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.
Too many requests have been made to the operation.
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.
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.
The VDM attributes that apply to your Amazon SES account.
An object that defines the VDM settings that apply to emails that you send using the configuration set.
An object that contains additional information about the verification status for the identity.
An object that contains information about the amount of email that was delivered to recipients.
The warmup status of a dedicated IP.