String mailType
The type of email your account is sending. The mail type can be one of the following:
MARKETING
– Most of your sending traffic is to keep your customers informed of your latest offering.
TRANSACTIONAL
– Most of your sending traffic is to communicate during a transaction with a customer.
String websiteURL
The URL of your website. This information helps us better understand the type of content that you plan to send.
String contactLanguage
The language you would prefer for the case. The contact language can be one of ENGLISH
or
JAPANESE
.
String useCaseDescription
A description of the types of email that you plan to send.
List<E> additionalContactEmailAddresses
Additional email addresses where updates are sent about your account review process.
ReviewDetails reviewDetails
Information about the review of the latest details you submitted.
String rblName
The name of the blacklist that the IP address appears on.
Date listingTime
The time when the blacklisting event occurred, shown in Unix time format.
String description
Additional information about the blacklisting event, as provided by the blacklist maintainer.
Content text
An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
Content html
An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
Template template
The template to use for the bulk email message.
Destination destination
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.
List<E> replacementTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendBulkTemplatedEmail
operation. Tags correspond to characteristics of the email that you define,
so that you can publish email sending events.
ReplacementEmailContent replacementEmailContent
The ReplacementEmailContent
associated with a BulkEmailEntry
.
String status
The status of a message sent using the SendBulkTemplatedEmail
operation.
Possible values for this parameter include:
SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
MESSAGE_REJECTED: The message was rejected because it contained a virus.
MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.
CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.
TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.
ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.
ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.
ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.
CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.
FAILED: Amazon SES was unable to process your request. See the error message for additional information.
String error
A description of an error that prevented a message being sent using the SendBulkTemplatedEmail
operation.
String messageId
The unique message identifier returned from the SendBulkTemplatedEmail
operation.
String dimensionName
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
String dimensionValueSource
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
.
String defaultDimensionValue
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
String emailAddress
The contact's email address.
List<E> topicPreferences
The contact's preference for being opted-in to or opted-out of a topic.
List<E> topicDefaultPreferences
The default topic preferences applied to the contact.
Boolean unsubscribeAll
A boolean value status noting if the contact is unsubscribed from all contact list topics.
Date lastUpdatedTimestamp
A timestamp noting the last time the contact's information was updated.
String contactListName
The name of the contact list.
String contactListImportAction
>The type of action to perform on the addresses. The following are the possible values:
PUT: add the addresses to the contact list. If the record already exists, it will override it with the new value.
DELETE: remove the addresses from the contact list.
String data
The content of the message itself.
String charset
The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII
by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For
example, you could specify UTF-8
, ISO-8859-1
, or Shift_JIS
.
String configurationSetName
The name of the configuration set .
String eventDestinationName
A name that identifies the event destination within the configuration set.
EventDestinationDefinition eventDestination
An object that defines the event destination.
String configurationSetName
The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
TrackingOptions trackingOptions
An object that defines the open and click tracking options for emails that you send using the configuration set.
DeliveryOptions deliveryOptions
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
ReputationOptions reputationOptions
An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
SendingOptions sendingOptions
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
List<E> tags
An array of objects that define the tags (keys and values) to associate with the configuration set.
SuppressionOptions suppressionOptions
String contactListName
The name of the contact list.
List<E> topics
An interest group, theme, or label within a list. A contact list can have multiple topics.
String description
A description of what the contact list is about.
List<E> tags
The tags associated with a contact list.
String contactListName
The name of the contact list to which the contact should be added.
String emailAddress
The contact's email address.
List<E> topicPreferences
The contact's preferences for being opted-in to or opted-out of topics.
Boolean unsubscribeAll
A boolean value status noting if the contact is unsubscribed from all contact list topics.
String attributesData
The attribute data attached to a contact.
String templateName
The name of the custom verification email template.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String templateContent
The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
String reportName
A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.
String fromEmailAddress
The email address that the predictive inbox placement test email was sent from.
EmailContent content
The HTML body of the message that you sent when you performed the predictive inbox placement test.
List<E> tags
An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
String reportId
A unique string that identifies the predictive inbox placement test.
String deliverabilityTestStatus
The status of the 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
to view the results of the test.
String emailIdentity
The email identity.
String policyName
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
String policy
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
String emailIdentity
The email address or domain to verify.
List<E> tags
An array of objects that define the tags (keys and values) to associate with the email identity.
DkimSigningAttributes dkimSigningAttributes
If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.
You can only specify this object if the email identity is a domain, as opposed to an address.
String configurationSetName
The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.
String identityType
The email identity type. Note: the MANAGED_DOMAIN
identity type is not supported.
Boolean verifiedForSendingStatus
Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
DkimAttributes dkimAttributes
An object that contains information about the DKIM attributes for the identity.
String templateName
The name of the template.
EmailTemplateContent templateContent
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
ImportDestination importDestination
The destination for the import job.
ImportDataSource importDataSource
The data source for the import job.
String jobId
A string that represents the import job ID.
String templateName
The name of the custom verification email template.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
Date startDate
The date that the DailyVolume metrics apply to, in Unix time.
VolumeStatistics volumeStatistics
An object that contains inbox placement metrics for a specific day in the analysis period.
List<E> domainIspPlacements
An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
String ip
An IPv4 address.
String warmupStatus
The warm-up status of a dedicated IP address. The status can have one of the following values:
IN_PROGRESS
– The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
DONE
– The dedicated IP warm-up process is complete, and the IP address is ready to use.
Integer warmupPercentage
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
String poolName
The name of the dedicated IP pool that the IP address is associated with.
String configurationSetName
The name of the configuration set.
String contactListName
The name of the contact list.
String templateName
The name of the custom verification email template that you want to delete.
String poolName
The name of the dedicated IP pool that you want to delete.
String emailIdentity
The identity (that is, the email address or domain) to delete.
String templateName
The name of the template to be deleted.
String emailAddress
The suppressed email destination to remove from the account suppression list.
String reportId
A unique string that identifies the predictive inbox placement test.
String reportName
A name that helps you identify a predictive inbox placement test report.
String subject
The subject line for an email that you submitted in a predictive inbox placement test.
String fromEmailAddress
The sender address that you specified for the predictive inbox placement test.
Date createDate
The date and time when the predictive inbox placement test was created, in Unix time format.
String deliverabilityTestStatus
The status of the 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
to view the results of the test.
String 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.
String sendingPoolName
The name of the dedicated IP pool to associate with the configuration set.
List<E> toAddresses
An array that contains the email addresses of the "To" recipients for the email.
List<E> ccAddresses
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
List<E> bccAddresses
An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
Boolean signingEnabled
If the value is true
, then the messages that you send from the identity are signed using DKIM. If
the value is false
, then the messages that you send from the identity aren't DKIM-signed.
String status
Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
PENDING
– The verification process was initiated, but Amazon SES hasn't yet detected the DKIM
records in the DNS configuration for the domain.
SUCCESS
– The verification process completed successfully.
FAILED
– The verification process failed. This typically occurs when Amazon SES fails to find the
DKIM records in the DNS configuration of the domain.
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the DKIM
authentication status of the domain.
NOT_STARTED
– The DKIM verification process hasn't been initiated for the domain.
List<E> tokens
If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
String signingAttributesOrigin
A string that indicates how DKIM was configured for the identity. These are the possible values:
AWS_SES
– Indicates that DKIM was configured for the identity by using Easy DKIM.
EXTERNAL
– Indicates that DKIM was configured for the identity by using Bring Your Own DKIM
(BYODKIM).
String nextSigningKeyLength
[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
String currentSigningKeyLength
[Easy DKIM] The key length of the DKIM key pair in use.
Date lastKeyGenerationTimestamp
[Easy DKIM] The last time a key pair was generated for this identity.
String domainSigningSelector
[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
String domainSigningPrivateKey
[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.
The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
String nextSigningKeyLength
[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
String campaignId
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
String imageUrl
The URL of an image that contains a snapshot of the email message that was sent.
String subject
The subject line, or title, of the email message.
String fromAddress
The verified email address that the email message was sent from.
List<E> sendingIps
The IP addresses that were used to send the email message.
Date firstSeenDateTime
The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
Date lastSeenDateTime
The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
Long inboxCount
The number of email messages that were delivered to recipients’ inboxes.
Long spamCount
The number of email messages that were delivered to recipients' spam or junk mail folders.
Double readRate
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
Double deleteRate
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
Double readDeleteRate
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
Long projectedVolume
The projected number of recipients that the email message was sent to.
List<E> esps
The major email providers who handled the email message.
String domain
A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription.
Date subscriptionStartDate
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
InboxPlacementTrackingOption inboxPlacementTrackingOption
An object that contains information about the inbox placement data settings for the domain.
String ispName
The name of the email provider that the inbox placement data applies to.
Long inboxRawCount
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
Long spamRawCount
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
Double inboxPercentage
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
Double spamPercentage
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
Message simple
The simple email message. The message consists of a subject and a message body.
RawMessage raw
The raw email message. The message has to meet the following criteria:
The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
If you include attachments, they must be in a file format that the Amazon SES API v2 supports.
The entire message must be Base64 encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
Template template
The template to use for the email message.
String name
A name that identifies the event destination.
Boolean enabled
If true
, the event destination is enabled. When the event destination is enabled, the specified
event types are sent to the destinations in this EventDestinationDefinition
.
If false
, the event destination is disabled. When the event destination is disabled, events aren't
sent to the specified destinations.
List<E> matchingEventTypes
The types of events that Amazon SES sends to the specified event destinations.
KinesisFirehoseDestination 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.
CloudWatchDestination 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.
SnsDestination 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.
PinpointDestination 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.
Boolean enabled
If true
, the event destination is enabled. When the event destination is enabled, the specified
event types are sent to the destinations in this EventDestinationDefinition
.
If false
, the event destination is disabled. When the event destination is disabled, events aren't
sent to the specified destinations.
List<E> matchingEventTypes
An array that specifies which events the Amazon SES API v2 should send to the destinations in this
EventDestinationDefinition
.
KinesisFirehoseDestination 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.
CloudWatchDestination 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.
SnsDestination 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.
PinpointDestination 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.
Boolean dedicatedIpAutoWarmupEnabled
Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
String enforcementStatus
The reputation status of your Amazon SES account. The status can be one of the following:
HEALTHY
– There are no reputation-related issues that currently impact your account.
PROBATION
– We've identified potential issues with your Amazon SES account. We're placing your
account under review while you work on correcting these issues.
SHUTDOWN
– Your account's ability to send email is currently paused because of an issue with the
email sent from your account. When you correct the issue, you can contact us and request that your account's
ability to send email is resumed.
Boolean productionAccessEnabled
Indicates whether or not your account has production access in the current Amazon Web Services Region.
If the value is false
, then your account is in the sandbox. When your account is in the
sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send
in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your
maximum sending rate) is 1.
If the value is true
, then your account has production access. When your account has production
access, you can send email to any address. The sending quota and maximum sending rate for your account vary based
on your specific use case.
SendQuota sendQuota
An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.
Boolean sendingEnabled
Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.
SuppressionAttributes suppressionAttributes
An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
AccountDetails details
An object that defines your account details.
String configurationSetName
The name of the configuration set that contains the event destination.
String configurationSetName
The name of the configuration set.
String configurationSetName
The name of the configuration set.
TrackingOptions trackingOptions
An object that defines the open and click tracking options for emails that you send using the configuration set.
DeliveryOptions deliveryOptions
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
ReputationOptions reputationOptions
An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
SendingOptions sendingOptions
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
List<E> tags
An array of objects that define the tags (keys and values) that are associated with the configuration set.
SuppressionOptions suppressionOptions
An object that contains information about the suppression list preferences for your account.
String contactListName
The name of the contact list.
String contactListName
The name of the contact list.
List<E> topics
An interest group, theme, or label within a list. A contact list can have multiple topics.
String description
A description of what the contact list is about.
Date createdTimestamp
A timestamp noting when the contact list was created.
Date lastUpdatedTimestamp
A timestamp noting the last time the contact list was updated.
List<E> tags
The tags associated with a contact list.
String contactListName
The name of the contact list to which the contact belongs.
String emailAddress
The contact's email addres.
List<E> topicPreferences
The contact's preference for being opted-in to or opted-out of a topic.>
List<E> topicDefaultPreferences
The default topic preferences applied to the contact.
Boolean unsubscribeAll
A boolean value status noting if the contact is unsubscribed from all contact list topics.
String attributesData
The attribute data attached to a contact.
Date createdTimestamp
A timestamp noting when the contact was created.
Date lastUpdatedTimestamp
A timestamp noting the last time the contact's information was updated.
String templateName
The name of the custom verification email template that you want to retrieve.
String templateName
The name of the custom verification email template.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String templateContent
The content of the custom verification email.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
String ip
The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Web Services account.
DedicatedIp dedicatedIp
An object that contains information about a dedicated IP address.
String poolName
The name of the IP pool that the dedicated IP address is associated with.
String nextToken
A token returned from a previous call to GetDedicatedIps
to indicate the position of the dedicated
IP pool in the list of IP pools.
Integer pageSize
The number of results to show in a single call to GetDedicatedIpsRequest
. If the number of results
is larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
List<E> dedicatedIps
A list of dedicated IP addresses that are associated with your Amazon Web Services account.
String nextToken
A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses,
issue another request to GetDedicatedIps
, passing this token in the NextToken
parameter.
Boolean dashboardEnabled
Specifies whether the Deliverability dashboard is enabled. If this value is true
, the dashboard is
enabled.
Date subscriptionExpiryDate
The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.
String accountStatus
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.
List<E> activeSubscribedDomains
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.
List<E> pendingExpirationSubscribedDomains
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.
String reportId
A unique string that identifies the predictive inbox placement test.
DeliverabilityTestReport deliverabilityTestReport
An object that contains the results of the predictive inbox placement test.
PlacementStatistics overallPlacement
An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
List<E> ispPlacements
An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
String message
An object that contains the message that you sent when you performed this predictive inbox placement test.
List<E> tags
An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
String campaignId
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
DomainDeliverabilityCampaign domainDeliverabilityCampaign
An object that contains the deliverability data for the campaign.
String domain
The domain that you want to obtain deliverability metrics for.
Date startDate
The first day (in Unix time) that you want to obtain domain deliverability metrics for.
Date endDate
The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate
that you specify has to be less than or equal to 30 days after the StartDate
.
OverallVolume overallVolume
An object that contains deliverability metrics for the domain that you specified. The data in this object is a
summary of all of the data that was collected from the StartDate
to the EndDate
.
List<E> dailyVolumes
An object that contains deliverability metrics for the domain that you specified. This object contains data for
each day, starting on the StartDate
and ending on the EndDate
.
String emailIdentity
The email identity.
String emailIdentity
The email identity.
String identityType
The email identity type. Note: the MANAGED_DOMAIN
identity type is not supported.
Boolean feedbackForwardingStatus
The feedback forwarding configuration for the identity.
If the value is true
, you receive email notifications when bounce or complaint events occur. These
notifications are sent to the address that you specified in the Return-Path
header of the original
email.
You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
Boolean verifiedForSendingStatus
Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
DkimAttributes dkimAttributes
An object that contains information about the DKIM attributes for the identity.
MailFromAttributes mailFromAttributes
An object that contains information about the Mail-From attributes for the email identity.
Map<K,V> policies
A map of policy names to policies.
List<E> tags
An array of objects that define the tags (keys and values) that are associated with the email identity.
String configurationSetName
The configuration set used by default when sending from this identity.
String templateName
The name of the template.
String templateName
The name of the template.
EmailTemplateContent templateContent
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
String jobId
The ID of the import job.
String jobId
A string that represents the import job ID.
ImportDestination importDestination
The destination of the import job.
ImportDataSource importDataSource
The data source of the import job.
FailureInfo failureInfo
The failure details about an import job.
String jobStatus
The status of the import job.
Date createdTimestamp
The time stamp of when the import job was created.
Date completedTimestamp
The time stamp of when the import job was completed.
Integer processedRecordsCount
The current number of records processed.
Integer failedRecordsCount
The number of records that failed processing because of invalid input or other reasons.
String emailAddress
The email address that's on the account suppression list.
SuppressedDestination suppressedDestination
An object containing information about the suppressed email address.
String identityType
The email identity type. Note: the MANAGED_DOMAIN
type is not supported for email identity types.
String identityName
The address or domain of the identity.
Boolean sendingEnabled
Indicates whether or not you can send email from the identity.
An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.
SuppressionListDestination suppressionListDestination
An object that contains the action of the import job towards suppression list.
ContactListDestination contactListDestination
An object that contains the action of the import job towards a contact list.
String jobId
ImportDestination importDestination
String jobStatus
Date createdTimestamp
The date and time when the import job was created.
String ispName
The name of the email provider that the inbox placement data applies to.
PlacementStatistics placementStatistics
An object that contains inbox placement metrics for a specific email provider.
String iamRoleArn
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
String deliveryStreamArn
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
String nextToken
A token returned from a previous call to ListConfigurationSets
to indicate the position in the list
of configuration sets.
Integer pageSize
The number of results to show in a single call to ListConfigurationSets
. If the number of results is
larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
List<E> configurationSets
An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region.
String nextToken
A token that indicates that there are additional configuration sets to list. To view additional configuration
sets, issue another request to ListConfigurationSets
, and pass this token in the
NextToken
parameter.
Integer pageSize
Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact
lists exist beyond the specified limit, the NextToken
element is sent in the response. Use the
NextToken
value in subsequent requests to retrieve additional lists.
String nextToken
A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.
List<E> contactLists
The available contact lists.
String nextToken
A string token indicating that there might be additional contact lists available to be listed. Copy this token to
a subsequent call to ListContactLists
with the same parameters to retrieve the next page of contact
lists.
String filteredStatus
The status by which you are filtering: OPT_IN
or OPT_OUT
.
TopicFilter topicFilter
Used for filtering by a specific topic preference.
String contactListName
The name of the contact list.
ListContactsFilter filter
A filter that can be applied to a list of contacts.
Integer pageSize
The number of contacts that may be returned at once, which is dependent on if there are more or less contacts
than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the
specified limit, the NextToken
element is sent in the response. Use the NextToken
value
in subsequent requests to retrieve additional contacts.
String nextToken
A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.
List<E> contacts
The contacts present in a specific contact list.
String nextToken
A string token indicating that there might be additional contacts available to be listed. Copy this token to a
subsequent call to ListContacts
with the same parameters to retrieve the next page of contacts.
String nextToken
A token returned from a previous call to ListCustomVerificationEmailTemplates
to indicate the
position in the list of custom verification email templates.
Integer pageSize
The number of results to show in a single call to ListCustomVerificationEmailTemplates
. If the
number of results is larger than the number you specified in this parameter, then the response includes a
NextToken
element, which you can use to obtain additional results.
The value you specify has to be at least 1, and can be no more than 50.
List<E> customVerificationEmailTemplates
A list of the custom verification email templates that exist in your account.
String nextToken
A token indicating that there are additional custom verification email templates available to be listed. Pass
this token to a subsequent call to ListCustomVerificationEmailTemplates
to retrieve the next 50
custom verification email templates.
String nextToken
A token returned from a previous call to ListDedicatedIpPools
to indicate the position in the list
of dedicated IP pools.
Integer pageSize
The number of results to show in a single call to ListDedicatedIpPools
. If the number of results is
larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
List<E> dedicatedIpPools
A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in the current Region.
String nextToken
A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another
request to ListDedicatedIpPools
, passing this token in the NextToken
parameter.
String nextToken
A token returned from a previous call to ListDeliverabilityTestReports
to indicate the position in
the list of predictive inbox placement tests.
Integer pageSize
The number of results to show in a single call to ListDeliverabilityTestReports
. If the number of
results is larger than the number you specified in this parameter, then the response includes a
NextToken
element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
List<E> deliverabilityTestReports
An object that contains a lists of predictive inbox placement tests that you've performed.
String nextToken
A token that indicates that there are additional predictive inbox placement tests to list. To view additional
predictive inbox placement tests, issue another request to ListDeliverabilityTestReports
, and pass
this token in the NextToken
parameter.
Date startDate
The first day, in Unix time format, that you want to obtain deliverability data for.
Date endDate
The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less
than or equal to 30 days after the value of the StartDate
parameter.
String subscribedDomain
The domain to obtain deliverability data for.
String nextToken
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns
operation.
This token indicates the position of a campaign in the list of campaigns.
Integer pageSize
The maximum number of results to include in response to a single call to the
ListDomainDeliverabilityCampaigns
operation. If the number of results is larger than the number that
you specify in this parameter, the response includes a NextToken
element, which you can use to
obtain additional results.
List<E> domainDeliverabilityCampaigns
An array of responses, one for each campaign that used the domain to send email during the specified time range.
String nextToken
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns
operation.
This token indicates the position of the campaign in the list of campaigns.
String nextToken
A token returned from a previous call to ListEmailIdentities
to indicate the position in the list of
identities.
Integer pageSize
The number of results to show in a single call to ListEmailIdentities
. If the number of results is
larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
List<E> emailIdentities
An array that includes all of the email identities associated with your Amazon Web Services account.
String nextToken
A token that indicates that there are additional configuration sets to list. To view additional configuration
sets, issue another request to ListEmailIdentities
, and pass this token in the
NextToken
parameter.
String nextToken
A token returned from a previous call to ListEmailTemplates
to indicate the position in the list of
email templates.
Integer pageSize
The number of results to show in a single call to ListEmailTemplates
. If the number of results is
larger than the number you specified in this parameter, then the response includes a NextToken
element, which you can use to obtain additional results.
The value you specify has to be at least 1, and can be no more than 10.
List<E> templatesMetadata
An array the contains the name and creation time stamp for each template in your Amazon SES account.
String nextToken
A token indicating that there are additional email templates available to be listed. Pass this token to a
subsequent ListEmailTemplates
call to retrieve the next 10 email templates.
String importDestinationType
The destination of the import job, which can be used to list import jobs that have a certain
ImportDestinationType
.
String nextToken
A string token indicating that there might be additional import jobs available to be listed. Copy this token to a
subsequent call to ListImportJobs
with the same parameters to retrieve the next page of import jobs.
Integer pageSize
Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import
jobs exist beyond the specified limit, the NextToken
element is sent in the response. Use the
NextToken
value in subsequent requests to retrieve additional addresses.
List<E> importJobs
A list of the import job summaries.
String nextToken
A string token indicating that there might be additional import jobs available to be listed. Copy this token to a
subsequent call to ListImportJobs
with the same parameters to retrieve the next page of import jobs.
List<E> reasons
The factors that caused the email address to be added to .
Date startDate
Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date. The date that you specify should be in Unix time format.
Date endDate
Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date. The date that you specify should be in Unix time format.
String nextToken
A token returned from a previous call to ListSuppressedDestinations
to indicate the position in the
list of suppressed email addresses.
Integer pageSize
The number of results to show in a single call to ListSuppressedDestinations
. If the number of
results is larger than the number you specified in this parameter, then the response includes a
NextToken
element, which you can use to obtain additional results.
List<E> suppressedDestinationSummaries
A list of summaries, each containing a summary for a suppressed email destination.
String nextToken
A token that indicates that there are additional email addresses on the suppression list for your account. To
view additional suppressed addresses, issue another request to ListSuppressedDestinations
, and pass
this token in the NextToken
parameter.
String resourceArn
The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.
String mailFromDomain
The name of a domain that an email identity uses as a custom MAIL FROM domain.
String mailFromDomainStatus
The status of the MAIL FROM domain. This status can have the following values:
PENDING
– Amazon SES hasn't started searching for the MX record yet.
SUCCESS
– Amazon SES detected the required MX record for the MAIL FROM domain.
FAILED
– Amazon SES can't find the required MX record, or the record no longer exists.
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon SES from determining the
status of the MAIL FROM domain.
String behaviorOnMxFailure
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.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending
,
Failed
, and TemporaryFailure
states.
Content subject
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.
Body body
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
String name
The name of the message tag. The message tag name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
String value
The value of the message tag. The message tag value has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
VolumeStatistics volumeStatistics
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
Double readRatePercent
The percentage of emails that were sent from the domain that were read by their recipients.
List<E> domainIspPlacements
An object that contains inbox and junk mail placement metrics for individual email providers.
String applicationArn
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
Double inboxPercentage
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
Double spamPercentage
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
Double missingPercentage
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
Double spfPercentage
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
Double dkimPercentage
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
Boolean autoWarmupEnabled
Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon
SES account in the current Amazon Web Services Region. Set to true
to enable the automatic warm-up
feature, or set to false
to disable it.
String mailType
The type of email your account will send.
String websiteURL
The URL of your website. This information helps us better understand the type of content that you plan to send.
String contactLanguage
The language you would prefer to be contacted with.
String useCaseDescription
A description of the types of email that you plan to send.
List<E> additionalContactEmailAddresses
Additional email addresses that you would like to be notified regarding Amazon SES matters.
Boolean productionAccessEnabled
Indicates whether or not your account should have production access in the current Amazon Web Services Region.
If the value is false
, then your account is in the sandbox. When your account is in the
sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send
in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your
maximum sending rate) is 1.
If the value is true
, then your account has production access. When your account has production
access, you can send email to any address. The sending quota and maximum sending rate for your account vary based
on your specific use case.
Boolean sendingEnabled
Enables or disables your account's ability to send email. Set to true
to enable email sending, or
set to false
to disable email sending.
If Amazon Web Services paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
List<E> suppressedReasons
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:
COMPLAINT
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a complaint.
BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a hard bounce.
String configurationSetName
The name of the configuration set to associate with a dedicated IP pool.
String 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.
String sendingPoolName
The name of the dedicated IP pool to associate with the configuration set.
String configurationSetName
The name of the configuration set to change the suppression list preferences for.
List<E> suppressedReasons
A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:
COMPLAINT
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a complaint.
BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a hard bounce.
String ip
The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Web Services account.
String destinationPoolName
The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
Boolean dashboardEnabled
Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to
true
.
List<E> subscribedDomains
An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
String emailIdentity
The email identity.
Boolean signingEnabled
Sets the DKIM signing configuration for the identity.
When you set this value true
, then the messages that are sent from the identity are signed using
DKIM. If you set this value to false
, your messages are sent without DKIM signing.
String emailIdentity
The email identity.
String signingAttributesOrigin
The method to use to configure DKIM for the identity. There are the following possible values:
AWS_SES
– Configure DKIM for the identity by using Easy DKIM.
EXTERNAL
– Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).
DkimSigningAttributes signingAttributes
An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
String dkimStatus
The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your 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.
The status can be one of the following:
PENDING
– The verification process was initiated, but Amazon SES hasn't yet detected the DKIM
records in the DNS configuration for the domain.
SUCCESS
– The verification process completed successfully.
FAILED
– The verification process failed. This typically occurs when Amazon SES fails to find the
DKIM records in the DNS configuration of the domain.
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the DKIM
authentication status of the domain.
NOT_STARTED
– The DKIM verification process hasn't been initiated for the domain.
List<E> dkimTokens
If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
String emailIdentity
The email identity.
Boolean emailForwardingEnabled
Sets the feedback forwarding configuration for the identity.
If the value is true
, you receive email notifications when bounce or complaint events occur. These
notifications are sent to the address that you specified in the Return-Path
header of the original
email.
You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
String emailIdentity
The verified email identity.
String mailFromDomain
The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
It has to be a subdomain of the verified identity.
It can't be used to receive email.
It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
String behaviorOnMxFailure
The action to take if the required MX record isn't 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.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending
,
Failed
, and TemporaryFailure
states.
ByteBuffer data
The raw email message. The message has to meet the following criteria:
The message has to contain a header and a body, separated by one blank line.
All of the required header fields must be present in the message.
Each part of a multipart MIME message must be formatted properly.
Attachments must be in a file format that the Amazon SES supports.
The entire message must be Base64 encoded.
If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.
ReplacementTemplate replacementTemplate
The ReplacementTemplate
associated with ReplacementEmailContent
.
String replacementTemplateData
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
Boolean reputationMetricsEnabled
If true
, tracking of reputation metrics is enabled for the configuration set. If false
,
tracking of reputation metrics is disabled for the configuration set.
Date lastFreshStart
The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.
String status
The status of the latest review of your account. The status can be one of the following:
PENDING
– We have received your appeal and are in the process of reviewing it.
GRANTED
– Your appeal has been reviewed and your production access has been granted.
DENIED
– Your appeal has been reviewed and your production access has been denied.
FAILED
– An internal error occurred and we didn't receive your appeal. You can submit your appeal
again.
String caseId
The associated support center case ID (if any).
String fromEmailAddress
The email address to use as the "From" address for the email. The address that you specify has to be verified.
String fromEmailAddressIdentityArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the
sending authorization policy that permits you to use the email address specified in the
FromEmailAddress
parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would specify the
FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
FromEmailAddress
to be [email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
List<E> replyToAddresses
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
String feedbackForwardingEmailAddress
The address that you want bounce and complaint notifications to be sent to.
String feedbackForwardingEmailAddressIdentityArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the
sending authorization policy that permits you to use the email address specified in the
FeedbackForwardingEmailAddress
parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would specify the
FeedbackForwardingEmailAddressIdentityArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress
to
be [email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
List<E> defaultEmailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendEmail
operation. Tags correspond to characteristics of the email that you define, so that you
can publish email sending events.
BulkEmailContent defaultContent
An object that contains the body of the message. You can specify a template message.
List<E> bulkEmailEntries
The list of bulk email entry objects.
String configurationSetName
The name of the configuration set to use when sending the email.
String emailAddress
The email address to verify.
String templateName
The name of the custom verification email template to use when sending the verification email.
String configurationSetName
Name of a configuration set to use when sending the verification email.
String messageId
The unique message identifier returned from the SendCustomVerificationEmail
operation.
String fromEmailAddress
The email address to use as the "From" address for the email. The address that you specify has to be verified.
String fromEmailAddressIdentityArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the
sending authorization policy that permits you to use the email address specified in the
FromEmailAddress
parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would specify the
FromEmailAddressIdentityArn
to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the
FromEmailAddress
to be [email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
For Raw emails, the FromEmailAddressIdentityArn
value overrides the X-SES-SOURCE-ARN and
X-SES-FROM-ARN headers specified in raw email message content.
Destination destination
An object that contains the recipients of the email message.
List<E> replyToAddresses
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
String feedbackForwardingEmailAddress
The address that you want bounce and complaint notifications to be sent to.
String feedbackForwardingEmailAddressIdentityArn
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the
sending authorization policy that permits you to use the email address specified in the
FeedbackForwardingEmailAddress
parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com)
attaches a policy to it that authorizes you to use [email protected], then you would specify the
FeedbackForwardingEmailAddressIdentityArn
to be
arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress
to
be [email protected].
For more information about sending authorization, see the Amazon SES Developer Guide.
EmailContent content
An object that contains the body of the message. You can send either a Simple message Raw message or a template Message.
List<E> emailTags
A list of tags, in the form of name/value pairs, to apply to an email that you send using the
SendEmail
operation. Tags correspond to characteristics of the email that you define, so that you
can publish email sending events.
String configurationSetName
The name of the configuration set to use when sending the email.
ListManagementOptions 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.
String messageId
A unique identifier for the message that is generated when the message is accepted.
It's possible for Amazon SES to accept a message without sending it. This can happen when the message that you're trying to send has an attachment contains a virus, or when you send a templated email that contains invalid personalization content, for example.
Boolean sendingEnabled
If true
, email sending is enabled for the configuration set. If false
, email sending is
disabled for the configuration set.
Double max24HourSend
The maximum number of emails that you can send in the current Amazon Web Services Region over a 24-hour period. This value is also called your sending quota.
Double maxSendRate
The maximum number of emails that you can send per second in the current Amazon Web Services Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate.
Double sentLast24Hours
The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the past 24 hours.
String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
String emailAddress
The email address that is on the suppression list for your account.
String reason
The reason that the address was added to the suppression list for your account.
Date lastUpdateTime
The date and time when the suppressed destination was last updated, shown in Unix time format.
SuppressedDestinationAttributes attributes
An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account.
String emailAddress
The email address that's on the suppression list for your account.
String reason
The reason that the address was added to the suppression list for your account.
Date lastUpdateTime
The date and time when the suppressed destination was last updated, shown in Unix time format.
List<E> suppressedReasons
A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:
COMPLAINT
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a complaint.
BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a hard bounce.
String suppressionListImportAction
The type of action to perform on the address. The following are possible values:
PUT: add the addresses to the suppression list. If the record already exists, it will override it with the new value.
DELETE: remove the addresses from the suppression list.
List<E> suppressedReasons
A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:
COMPLAINT
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a complaint.
BOUNCE
– Amazon SES adds an email address to the suppression list for your account when a message
sent to that address results in a hard bounce.
String key
One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
String value
The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.
String resourceArn
The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
List<E> tags
A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key
)
and an associated tag value (Value
). The maximum length of a tag key is 128 characters. The maximum
length of a tag value is 256 characters.
String templateName
The name of the template. You will refer to this name when you send email using the
SendTemplatedEmail
or SendBulkTemplatedEmail
operations.
String templateArn
The Amazon Resource Name (ARN) of the template.
String templateData
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
String renderedTemplate
The complete MIME message rendered by applying the data in the TemplateData
parameter to the
template specified in the TemplateName parameter.
String topicName
The name of the topic.
String displayName
The name of the topic the contact will see.
String description
A description of what the topic is about, which the contact will see.
String defaultSubscriptionStatus
The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
String topicName
The name of a topic on which you wish to apply the filter.
Boolean useDefaultIfPreferenceUnavailable
Notes that the default subscription status should be applied to a contact because the contact has not noted their preference for subscribing to a topic.
String customRedirectDomain
The domain to use for tracking open and click events.
String resourceArn
The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.
List<E> tagKeys
The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
To remove more than one tag from the resource, append the TagKeys
parameter and argument for each
additional tag to remove, separated by an ampersand. For example:
/v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
String configurationSetName
The name of the configuration set that contains the event destination to modify.
String eventDestinationName
The name of the event destination.
EventDestinationDefinition eventDestination
An object that defines the event destination.
String contactListName
The name of the contact list.
String emailAddress
The contact's email addres.
List<E> topicPreferences
The contact's preference for being opted-in to or opted-out of a topic.
Boolean unsubscribeAll
A boolean value status noting if the contact is unsubscribed from all contact list topics.
String attributesData
The attribute data attached to a contact.
String templateName
The name of the custom verification email template that you want to update.
String fromEmailAddress
The email address that the custom verification email is sent from.
String templateSubject
The subject line of the custom verification email.
String templateContent
The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.
String successRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
String failureRedirectionURL
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
String emailIdentity
The email identity.
String policyName
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
String policy
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
String templateName
The name of the template.
EmailTemplateContent templateContent
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
Long inboxRawCount
The total number of emails that arrived in recipients' inboxes.
Long spamRawCount
The total number of emails that arrived in recipients' spam or junk mail folders.
Long projectedInbox
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
Long projectedSpam
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
Copyright © 2021. All rights reserved.