sesv2-2019-09-27 library

Classes

AccountDetails
An object that contains information about your account details.
AwsClientCredentials
AWS credentials.
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.
BulkEmailContent
An object that contains the body of the message. You can specify a template message.
BulkEmailEntry
BulkEmailEntryResult
The result of the SendBulkEmail operation of each specified BulkEmailEntry.
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.
Contact
A contact is the end-user who is receiving the email.
ContactList
A list that contains contacts that have subscribed to a particular topic or topics.
ContactListDestination
An object that contains details about the action of a contact list.
Content
An object that represents the content of the email, and optionally a character set specification.
CreateConfigurationSetEventDestinationResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateConfigurationSetResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateContactListResponse
CreateContactResponse
CreateCustomVerificationEmailTemplateResponse
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
CreateDedicatedIpPoolResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateDeliverabilityTestReportResponse
Information about the predictive inbox placement test that you created.
CreateEmailIdentityPolicyResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CreateEmailIdentityResponse
If the email identity is a domain, this object contains information about the DKIM verification status for the domain.
CreateEmailTemplateResponse
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
CreateImportJobResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
CustomVerificationEmailTemplateMetadata
Contains information about a custom verification email template.
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.
DeleteConfigurationSetEventDestinationResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteConfigurationSetResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteContactListResponse
DeleteContactResponse
DeleteCustomVerificationEmailTemplateResponse
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
DeleteDedicatedIpPoolResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteEmailIdentityPolicyResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteEmailIdentityResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
DeleteEmailTemplateResponse
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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.
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.
EmailTemplateContent
The content of the email, composed of a subject line, an HTML part, and a text-only part.
EmailTemplateMetadata
Contains information about an email template.
EventDestination
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.
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.
FailureInfo
An object that contains the failure details about an import job.
GetAccountResponse
A list of details about the email-sending capabilities of your Amazon SES account in the current AWS Region.
GetBlacklistReportsResponse
An object that contains information about blacklist events.
GetConfigurationSetEventDestinationsResponse
Information about an event destination for a configuration set.
GetConfigurationSetResponse
Information about a configuration set.
GetContactListResponse
GetContactResponse
GetCustomVerificationEmailTemplateResponse
The following elements are returned by the service.
GetDedicatedIpResponse
Information about a dedicated IP address.
GetDedicatedIpsResponse
Information about the dedicated IP addresses that are associated with your AWS account.
GetDeliverabilityDashboardOptionsResponse
An object that shows the status of the Deliverability dashboard.
GetDeliverabilityTestReportResponse
The results of the predictive inbox placement test.
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.
GetDomainStatisticsReportResponse
An object that includes statistics that are related to the domain that you specified.
GetEmailIdentityPoliciesResponse
Identity policies associated with email identity.
GetEmailIdentityResponse
Details about an email identity.
GetEmailTemplateResponse
The following element is returned by the service.
GetImportJobResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
GetSuppressedDestinationResponse
Information about the suppressed email address.
IdentityInfo
Information about an email identity.
ImportDataSource
An object that contains details about the data source of the import job.
ImportDestination
An object that contains details about the resource destination the import job is going to target.
ImportJobSummary
A summary of the import job.
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.
ListConfigurationSetsResponse
A list of configuration sets in your Amazon SES account in the current AWS Region.
ListContactListsResponse
ListContactsFilter
A filter that can be applied to a list of contacts.
ListContactsResponse
ListCustomVerificationEmailTemplatesResponse
The following elements are returned by the service.
ListDedicatedIpPoolsResponse
A list of dedicated IP pools.
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.
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.
ListEmailIdentitiesResponse
A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.
ListEmailTemplatesResponse
The following elements are returned by the service.
ListImportJobsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
ListManagementOptions
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
ListSuppressedDestinationsResponse
A list of suppressed email addresses.
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.
PutAccountDedicatedIpWarmupAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutAccountDetailsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutAccountSendingAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutAccountSuppressionAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetDeliveryOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetReputationOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetSendingOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetSuppressionOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutConfigurationSetTrackingOptionsResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutDedicatedIpInPoolResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutDedicatedIpWarmupAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutDeliverabilityDashboardOptionResponse
A response that indicates whether the Deliverability dashboard is enabled.
PutEmailIdentityDkimAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutEmailIdentityDkimSigningAttributesResponse
If the action is successful, the service sends back an HTTP 200 response.
PutEmailIdentityFeedbackAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
PutEmailIdentityMailFromAttributesResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
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.
ReplacementEmailContent
The ReplaceEmailContent object to be used for a specific BulkEmailEntry. The ReplacementTemplate can be specified within this object.
ReplacementTemplate
An object which contains ReplacementTemplateData to be used for a specific BulkEmailEntry.
ReputationOptions
Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
ReviewDetails
An object that contains information about your account details review.
SendBulkEmailResponse
The following data is returned in JSON format by the service.
SendCustomVerificationEmailResponse
The following element is returned by the service.
SendEmailResponse
A unique message ID that you receive when an email is accepted for sending.
SendingOptions
Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
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.
SESV2
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.
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.
SuppressionListDestination
An object that contains details about the action of suppression list.
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.
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.
TestRenderEmailTemplateResponse
The following element is returned by the service.
Topic
An interest group, theme, or label within a list. Lists can have multiple topics.
TopicFilter
Used for filtering by a specific topic preference.
TopicPreference
The contact's preference for being opted-in to or opted-out of a topic.
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.
UntagResourceResponse
UpdateConfigurationSetEventDestinationResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
UpdateContactListResponse
UpdateContactResponse
UpdateCustomVerificationEmailTemplateResponse
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
UpdateEmailIdentityPolicyResponse
An HTTP 200 response if the request succeeds, or an error message if the request fails.
UpdateEmailTemplateResponse
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
VolumeStatistics
An object that contains information about the amount of email that was delivered to recipients.

Enums

BehaviorOnMxFailure
The action that you want 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.
BulkEmailStatus
ContactLanguage
ContactListImportAction
DataFormat
The data format of the import job's data source.
DeliverabilityDashboardAccountStatus
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.
DeliverabilityTestStatus
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.
DimensionValueSource
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. If you want 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. If you want to use your own email headers, choose emailHeader. If you want to use link tags, choose linkTags.
DkimSigningAttributesOrigin
DkimStatus
The DKIM authentication status of the identity. The status can be one of the following:
EventType
An email sending event type. For example, email sends, opens, and bounces are all email events.
IdentityType
The email identity type. The identity type can be one of the following:
ImportDestinationType
The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.
JobStatus
The status of the import job.
MailFromDomainStatus
The status of the MAIL FROM domain. This status can have the following values:
MailType
ReviewStatus
SubscriptionStatus
SuppressionListImportAction
The type of action that you want to perform on the address. Acceptable values:
SuppressionListReason
The reason that the address was added to the suppression list for your account. The value can be one of the following:
TlsPolicy
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.
WarmupStatus
The warmup status of a dedicated IP.

Extensions

BehaviorOnMxFailureFromString on String
BehaviorOnMxFailureValueExtension on BehaviorOnMxFailure
BulkEmailStatusFromString on String
BulkEmailStatusValueExtension on BulkEmailStatus
ContactLanguageFromString on String
ContactLanguageValueExtension on ContactLanguage
ContactListImportActionFromString on String
ContactListImportActionValueExtension on ContactListImportAction
DataFormatFromString on String
DataFormatValueExtension on DataFormat
DeliverabilityDashboardAccountStatusFromString on String
DeliverabilityDashboardAccountStatusValueExtension on DeliverabilityDashboardAccountStatus
DeliverabilityTestStatusFromString on String
DeliverabilityTestStatusValueExtension on DeliverabilityTestStatus
DimensionValueSourceFromString on String
DimensionValueSourceValueExtension on DimensionValueSource
DkimSigningAttributesOriginFromString on String
DkimSigningAttributesOriginValueExtension on DkimSigningAttributesOrigin
DkimStatusFromString on String
DkimStatusValueExtension on DkimStatus
EventTypeFromString on String
EventTypeValueExtension on EventType
IdentityTypeFromString on String
IdentityTypeValueExtension on IdentityType
ImportDestinationTypeFromString on String
ImportDestinationTypeValueExtension on ImportDestinationType
JobStatusFromString on String
JobStatusValueExtension on JobStatus
MailFromDomainStatusFromString on String
MailFromDomainStatusValueExtension on MailFromDomainStatus
MailTypeFromString on String
MailTypeValueExtension on MailType
ReviewStatusFromString on String
ReviewStatusValueExtension on ReviewStatus
SubscriptionStatusFromString on String
SubscriptionStatusValueExtension on SubscriptionStatus
SuppressionListImportActionFromString on String
SuppressionListImportActionValueExtension on SuppressionListImportAction
SuppressionListReasonFromString on String
SuppressionListReasonValueExtension on SuppressionListReason
TlsPolicyFromString on String
TlsPolicyValueExtension on TlsPolicy
WarmupStatusFromString on String
WarmupStatusValueExtension on WarmupStatus