2025/12/18 - Amazon Simple Email Service - 1 new9 updated api methods
Changes Amazon SES introduces Email Validation feature which checks email addresses for syntax errors, domain validity, and risky addresses to help maintain deliverability and protect sender reputation. SES also adds resource tagging and ABAC support for EmailTemplates and CustomVerificationEmailTemplates.
Provides validation insights about a specific email address, including syntax validation, DNS record checks, mailbox existence, and other deliverability factors.
See also: AWS API Documentation
Request Syntax
client.get_email_address_insights(
EmailAddress='string'
)
string
[REQUIRED]
The email address to analyze for validation insights.
dict
Response Syntax
{
'MailboxValidation': {
'IsValid': {
'ConfidenceVerdict': 'LOW'|'MEDIUM'|'HIGH'
},
'Evaluations': {
'HasValidSyntax': {
'ConfidenceVerdict': 'LOW'|'MEDIUM'|'HIGH'
},
'HasValidDnsRecords': {
'ConfidenceVerdict': 'LOW'|'MEDIUM'|'HIGH'
},
'MailboxExists': {
'ConfidenceVerdict': 'LOW'|'MEDIUM'|'HIGH'
},
'IsRoleAddress': {
'ConfidenceVerdict': 'LOW'|'MEDIUM'|'HIGH'
},
'IsDisposable': {
'ConfidenceVerdict': 'LOW'|'MEDIUM'|'HIGH'
},
'IsRandomInput': {
'ConfidenceVerdict': 'LOW'|'MEDIUM'|'HIGH'
}
}
}
}
Response Structure
(dict) --
Validation insights about an email address.
MailboxValidation (dict) --
Detailed validation results for the email address.
IsValid (dict) --
Overall validity assessment with a confidence verdict.
ConfidenceVerdict (string) --
The confidence level of the validation verdict.
Evaluations (dict) --
Specific validation checks performed on the email address.
HasValidSyntax (dict) --
Checks that the email address follows proper RFC standards and contains valid characters in the correct format.
ConfidenceVerdict (string) --
The confidence level of the validation verdict.
HasValidDnsRecords (dict) --
Checks that the domain exists, has valid DNS records, and is configured to receive email.
ConfidenceVerdict (string) --
The confidence level of the validation verdict.
MailboxExists (dict) --
Checks that the mailbox exists and can receive messages without actually sending an email.
ConfidenceVerdict (string) --
The confidence level of the validation verdict.
IsRoleAddress (dict) --
Identifies role-based addresses (such as admin@, support@, or info@) that may have lower engagement rates.
ConfidenceVerdict (string) --
The confidence level of the validation verdict.
IsDisposable (dict) --
Checks disposable or temporary email addresses that could negatively impact your sender reputation.
ConfidenceVerdict (string) --
The confidence level of the validation verdict.
IsRandomInput (dict) --
Checks if the input appears to be random text.
ConfidenceVerdict (string) --
The confidence level of the validation verdict.
{'SuppressionOptions': {'ValidationOptions': {'ConditionThreshold': {'ConditionThresholdEnabled': 'ENABLED '
'| '
'DISABLED',
'OverallConfidenceThreshold': {'ConfidenceVerdictThreshold': 'MEDIUM '
'| '
'HIGH '
'| '
'MANAGED'}}}}}
Create a configuration set. Configuration sets are groups of rules that you can apply to the emails that you send. You apply a configuration set to an email by specifying the name of the configuration set when you call the Amazon SES API v2. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
See also: AWS API Documentation
Request Syntax
client.create_configuration_set(
ConfigurationSetName='string',
TrackingOptions={
'CustomRedirectDomain': 'string',
'HttpsPolicy': 'REQUIRE'|'REQUIRE_OPEN_ONLY'|'OPTIONAL'
},
DeliveryOptions={
'TlsPolicy': 'REQUIRE'|'OPTIONAL',
'SendingPoolName': 'string',
'MaxDeliverySeconds': 123
},
ReputationOptions={
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
},
SendingOptions={
'SendingEnabled': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SuppressionOptions={
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
],
'ValidationOptions': {
'ConditionThreshold': {
'ConditionThresholdEnabled': 'ENABLED'|'DISABLED',
'OverallConfidenceThreshold': {
'ConfidenceVerdictThreshold': 'MEDIUM'|'HIGH'|'MANAGED'
}
}
}
},
VdmOptions={
'DashboardOptions': {
'EngagementMetrics': 'ENABLED'|'DISABLED'
},
'GuardianOptions': {
'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
}
},
ArchivingOptions={
'ArchiveArn': 'string'
}
)
string
[REQUIRED]
The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
dict
An object that defines the open and click tracking options for emails that you send using the configuration set.
CustomRedirectDomain (string) -- [REQUIRED]
The domain to use for tracking open and click events.
HttpsPolicy (string) --
The https policy to use for tracking open and click events.
dict
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
TlsPolicy (string) --
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.
SendingPoolName (string) --
The name of the dedicated IP pool to associate with the configuration set.
MaxDeliverySeconds (integer) --
The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email. If specified, the value must greater than or equal to 300 seconds (5 minutes) and less than or equal to 50400 seconds (840 minutes).
dict
An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
ReputationMetricsEnabled (boolean) --
If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
LastFreshStart (datetime) --
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.
dict
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
SendingEnabled (boolean) --
If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
list
An array of objects that define the tags (keys and values) to associate with the configuration set.
(dict) --
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
Key (string) -- [REQUIRED]
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.
Value (string) -- [REQUIRED]
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.
dict
An object that contains information about the suppression list preferences for your account.
SuppressedReasons (list) --
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) --
The reason that the address was added to the suppression list for your account. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.
BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.
ValidationOptions (dict) --
Contains validation options for email address suppression.
ConditionThreshold (dict) -- [REQUIRED]
Specifies the condition threshold settings for suppression validation.
ConditionThresholdEnabled (string) -- [REQUIRED]
Indicates whether Auto Validation is enabled for suppression. Set to ENABLED to enable the Auto Validation feature, or set to DISABLED to disable it.
OverallConfidenceThreshold (dict) --
The overall confidence threshold used to determine suppression decisions.
ConfidenceVerdictThreshold (string) -- [REQUIRED]
The confidence level threshold for suppression decisions.
dict
An object that defines the VDM options for emails that you send using the configuration set.
DashboardOptions (dict) --
Specifies additional settings for your VDM configuration as applicable to the Dashboard.
EngagementMetrics (string) --
Specifies the status of your VDM engagement metrics collection. Can be one of the following:
ENABLED – Amazon SES enables engagement metrics for the configuration set.
DISABLED – Amazon SES disables engagement metrics for the configuration set.
GuardianOptions (dict) --
Specifies additional settings for your VDM configuration as applicable to the Guardian.
OptimizedSharedDelivery (string) --
Specifies the status of your VDM optimized shared delivery. Can be one of the following:
ENABLED – Amazon SES enables optimized shared delivery for the configuration set.
DISABLED – Amazon SES disables optimized shared delivery for the configuration set.
dict
An object that defines the MailManager archiving options for emails that you send using the configuration set.
ArchiveArn (string) --
The Amazon Resource Name (ARN) of the MailManager archive where the Amazon SES API v2 will archive sent emails.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a new custom verification email template.
For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
client.create_custom_verification_email_template(
TemplateName='string',
FromEmailAddress='string',
TemplateSubject='string',
TemplateContent='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SuccessRedirectionURL='string',
FailureRedirectionURL='string'
)
string
[REQUIRED]
The name of the custom verification email template.
string
[REQUIRED]
The email address that the custom verification email is sent from.
string
[REQUIRED]
The subject line of the custom verification email.
string
[REQUIRED]
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.
list
An array of objects that define the tags (keys and values) to associate with the custom verification email template.
(dict) --
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
Key (string) -- [REQUIRED]
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.
Value (string) -- [REQUIRED]
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
[REQUIRED]
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
string
[REQUIRED]
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
dict
Response Syntax
{}
Response Structure
(dict) --
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
client.create_email_template(
TemplateName='string',
TemplateContent={
'Subject': 'string',
'Text': 'string',
'Html': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the template.
dict
[REQUIRED]
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
Subject (string) --
The subject line of the email.
Text (string) --
The email body that will be visible to recipients whose email clients do not display HTML.
Html (string) --
The HTML body of the email.
list
An array of objects that define the tags (keys and values) to associate with the email template.
(dict) --
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
Key (string) -- [REQUIRED]
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.
Value (string) -- [REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
(dict) --
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
{'SuppressionAttributes': {'ValidationAttributes': {'ConditionThreshold': {'ConditionThresholdEnabled': 'ENABLED '
'| '
'DISABLED',
'OverallConfidenceThreshold': {'ConfidenceVerdictThreshold': 'MEDIUM '
'| '
'HIGH '
'| '
'MANAGED'}}}}}
Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.get_account()
dict
Response Syntax
{
'DedicatedIpAutoWarmupEnabled': True|False,
'EnforcementStatus': 'string',
'ProductionAccessEnabled': True|False,
'SendQuota': {
'Max24HourSend': 123.0,
'MaxSendRate': 123.0,
'SentLast24Hours': 123.0
},
'SendingEnabled': True|False,
'SuppressionAttributes': {
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
],
'ValidationAttributes': {
'ConditionThreshold': {
'ConditionThresholdEnabled': 'ENABLED'|'DISABLED',
'OverallConfidenceThreshold': {
'ConfidenceVerdictThreshold': 'MEDIUM'|'HIGH'|'MANAGED'
}
}
}
},
'Details': {
'MailType': 'MARKETING'|'TRANSACTIONAL',
'WebsiteURL': 'string',
'ContactLanguage': 'EN'|'JA',
'UseCaseDescription': 'string',
'AdditionalContactEmailAddresses': [
'string',
],
'ReviewDetails': {
'Status': 'PENDING'|'FAILED'|'GRANTED'|'DENIED',
'CaseId': 'string'
}
},
'VdmAttributes': {
'VdmEnabled': 'ENABLED'|'DISABLED',
'DashboardAttributes': {
'EngagementMetrics': 'ENABLED'|'DISABLED'
},
'GuardianAttributes': {
'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
}
}
}
Response Structure
(dict) --
A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region.
DedicatedIpAutoWarmupEnabled (boolean) --
Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
EnforcementStatus (string) --
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.
ProductionAccessEnabled (boolean) --
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.
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 (dict) --
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.
Max24HourSend (float) --
The maximum number of emails that you can send in the current Amazon Web Services Region over a 24-hour period. A value of -1 signifies an unlimited quota. (This value is also referred to as your sending quota.)
MaxSendRate (float) --
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.
SentLast24Hours (float) --
The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the past 24 hours.
SendingEnabled (boolean) --
Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.
SuppressionAttributes (dict) --
An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
SuppressedReasons (list) --
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) --
The reason that the address was added to the suppression list for your account. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.
BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.
ValidationAttributes (dict) --
Structure containing validation attributes used for suppressing sending to specific destination on account level.
ConditionThreshold (dict) --
Specifies the condition threshold settings for account-level suppression.
ConditionThresholdEnabled (string) --
Indicates whether Auto Validation is enabled for suppression. Set to ENABLED to enable the Auto Validation feature, or set to DISABLED to disable it.
OverallConfidenceThreshold (dict) --
The overall confidence threshold used to determine suppression decisions.
ConfidenceVerdictThreshold (string) --
The confidence level threshold for suppression decisions.
Details (dict) --
An object that defines your account details.
MailType (string) --
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.
WebsiteURL (string) --
The URL of your website. This information helps us better understand the type of content that you plan to send.
ContactLanguage (string) --
The language you would prefer for the case. The contact language can be one of ENGLISH or JAPANESE.
UseCaseDescription (string) --
A description of the types of email that you plan to send.
AdditionalContactEmailAddresses (list) --
Additional email addresses where updates are sent about your account review process.
(string) --
ReviewDetails (dict) --
Information about the review of the latest details you submitted.
Status (string) --
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.
CaseId (string) --
The associated support center case ID (if any).
VdmAttributes (dict) --
The VDM attributes that apply to your Amazon SES account.
VdmEnabled (string) --
Specifies the status of your VDM configuration. Can be one of the following:
ENABLED – Amazon SES enables VDM for your account.
DISABLED – Amazon SES disables VDM for your account.
DashboardAttributes (dict) --
Specifies additional settings for your VDM configuration as applicable to the Dashboard.
EngagementMetrics (string) --
Specifies the status of your VDM engagement metrics collection. Can be one of the following:
ENABLED – Amazon SES enables engagement metrics for your account.
DISABLED – Amazon SES disables engagement metrics for your account.
GuardianAttributes (dict) --
Specifies additional settings for your VDM configuration as applicable to the Guardian.
OptimizedSharedDelivery (string) --
Specifies the status of your VDM optimized shared delivery. Can be one of the following:
ENABLED – Amazon SES enables optimized shared delivery for your account.
DISABLED – Amazon SES disables optimized shared delivery for your account.
{'SuppressionOptions': {'ValidationOptions': {'ConditionThreshold': {'ConditionThresholdEnabled': 'ENABLED '
'| '
'DISABLED',
'OverallConfidenceThreshold': {'ConfidenceVerdictThreshold': 'MEDIUM '
'| '
'HIGH '
'| '
'MANAGED'}}}}}
Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.
Configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.
See also: AWS API Documentation
Request Syntax
client.get_configuration_set(
ConfigurationSetName='string'
)
string
[REQUIRED]
The name of the configuration set.
dict
Response Syntax
{
'ConfigurationSetName': 'string',
'TrackingOptions': {
'CustomRedirectDomain': 'string',
'HttpsPolicy': 'REQUIRE'|'REQUIRE_OPEN_ONLY'|'OPTIONAL'
},
'DeliveryOptions': {
'TlsPolicy': 'REQUIRE'|'OPTIONAL',
'SendingPoolName': 'string',
'MaxDeliverySeconds': 123
},
'ReputationOptions': {
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
},
'SendingOptions': {
'SendingEnabled': True|False
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SuppressionOptions': {
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
],
'ValidationOptions': {
'ConditionThreshold': {
'ConditionThresholdEnabled': 'ENABLED'|'DISABLED',
'OverallConfidenceThreshold': {
'ConfidenceVerdictThreshold': 'MEDIUM'|'HIGH'|'MANAGED'
}
}
}
},
'VdmOptions': {
'DashboardOptions': {
'EngagementMetrics': 'ENABLED'|'DISABLED'
},
'GuardianOptions': {
'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
}
},
'ArchivingOptions': {
'ArchiveArn': 'string'
}
}
Response Structure
(dict) --
Information about a configuration set.
ConfigurationSetName (string) --
The name of the configuration set.
TrackingOptions (dict) --
An object that defines the open and click tracking options for emails that you send using the configuration set.
CustomRedirectDomain (string) --
The domain to use for tracking open and click events.
HttpsPolicy (string) --
The https policy to use for tracking open and click events.
DeliveryOptions (dict) --
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
TlsPolicy (string) --
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.
SendingPoolName (string) --
The name of the dedicated IP pool to associate with the configuration set.
MaxDeliverySeconds (integer) --
The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email. If specified, the value must greater than or equal to 300 seconds (5 minutes) and less than or equal to 50400 seconds (840 minutes).
ReputationOptions (dict) --
An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
ReputationMetricsEnabled (boolean) --
If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.
LastFreshStart (datetime) --
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.
SendingOptions (dict) --
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
SendingEnabled (boolean) --
If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.
Tags (list) --
An array of objects that define the tags (keys and values) that are associated with the configuration set.
(dict) --
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
Key (string) --
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.
Value (string) --
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.
SuppressionOptions (dict) --
An object that contains information about the suppression list preferences for your account.
SuppressedReasons (list) --
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) --
The reason that the address was added to the suppression list for your account. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.
BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.
ValidationOptions (dict) --
Contains validation options for email address suppression.
ConditionThreshold (dict) --
Specifies the condition threshold settings for suppression validation.
ConditionThresholdEnabled (string) --
Indicates whether Auto Validation is enabled for suppression. Set to ENABLED to enable the Auto Validation feature, or set to DISABLED to disable it.
OverallConfidenceThreshold (dict) --
The overall confidence threshold used to determine suppression decisions.
ConfidenceVerdictThreshold (string) --
The confidence level threshold for suppression decisions.
VdmOptions (dict) --
An object that contains information about the VDM preferences for your configuration set.
DashboardOptions (dict) --
Specifies additional settings for your VDM configuration as applicable to the Dashboard.
EngagementMetrics (string) --
Specifies the status of your VDM engagement metrics collection. Can be one of the following:
ENABLED – Amazon SES enables engagement metrics for the configuration set.
DISABLED – Amazon SES disables engagement metrics for the configuration set.
GuardianOptions (dict) --
Specifies additional settings for your VDM configuration as applicable to the Guardian.
OptimizedSharedDelivery (string) --
Specifies the status of your VDM optimized shared delivery. Can be one of the following:
ENABLED – Amazon SES enables optimized shared delivery for the configuration set.
DISABLED – Amazon SES disables optimized shared delivery for the configuration set.
ArchivingOptions (dict) --
An object that defines the MailManager archive where sent emails are archived that you send using the configuration set.
ArchiveArn (string) --
The Amazon Resource Name (ARN) of the MailManager archive where the Amazon SES API v2 will archive sent emails.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Returns the custom email verification template for the template name you specify.
For more information about custom verification email templates, see Using custom verification email templates in the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
client.get_custom_verification_email_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the custom verification email template that you want to retrieve.
dict
Response Syntax
{
'TemplateName': 'string',
'FromEmailAddress': 'string',
'TemplateSubject': 'string',
'TemplateContent': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SuccessRedirectionURL': 'string',
'FailureRedirectionURL': 'string'
}
Response Structure
(dict) --
The following elements are returned by the service.
TemplateName (string) --
The name of the custom verification email template.
FromEmailAddress (string) --
The email address that the custom verification email is sent from.
TemplateSubject (string) --
The subject line of the custom verification email.
TemplateContent (string) --
The content of the custom verification email.
Tags (list) --
An array of objects that define the tags (keys and values) that are associated with the custom verification email template.
(dict) --
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
Key (string) --
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.
Value (string) --
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.
SuccessRedirectionURL (string) --
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
FailureRedirectionURL (string) --
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Displays the template object (which includes the subject line, HTML part and text part) for the template you specify.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
client.get_email_template(
TemplateName='string'
)
string
[REQUIRED]
The name of the template.
dict
Response Syntax
{
'TemplateName': 'string',
'TemplateContent': {
'Subject': 'string',
'Text': 'string',
'Html': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
The following element is returned by the service.
TemplateName (string) --
The name of the template.
TemplateContent (dict) --
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
Subject (string) --
The subject line of the email.
Text (string) --
The email body that will be visible to recipients whose email clients do not display HTML.
Html (string) --
The HTML body of the email.
Tags (list) --
An array of objects that define the tags (keys and values) that are associated with the email template.
(dict) --
An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.
Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:
Tag keys and values are case sensitive.
For each associated resource, each tag key must be unique and it can have only one value.
The aws: prefix is reserved for use by Amazon Web Services; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.
You can associate tags with public or shared resources, but the tags are available only for your Amazon Web Services account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified Amazon Web Services Region for your Amazon Web Services account.
Key (string) --
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.
Value (string) --
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.
{'ValidationAttributes': {'ConditionThreshold': {'ConditionThresholdEnabled': 'ENABLED '
'| '
'DISABLED',
'OverallConfidenceThreshold': {'ConfidenceVerdictThreshold': 'MEDIUM '
'| '
'HIGH '
'| '
'MANAGED'}}}}
Change the settings for the account-level suppression list.
See also: AWS API Documentation
Request Syntax
client.put_account_suppression_attributes(
SuppressedReasons=[
'BOUNCE'|'COMPLAINT',
],
ValidationAttributes={
'ConditionThreshold': {
'ConditionThresholdEnabled': 'ENABLED'|'DISABLED',
'OverallConfidenceThreshold': {
'ConfidenceVerdictThreshold': 'MEDIUM'|'HIGH'|'MANAGED'
}
}
}
)
list
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) --
The reason that the address was added to the suppression list for your account. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.
BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.
dict
An object that contains additional suppression attributes for your account.
ConditionThreshold (dict) -- [REQUIRED]
Specifies the condition threshold settings for account-level suppression.
ConditionThresholdEnabled (string) -- [REQUIRED]
Indicates whether Auto Validation is enabled for suppression. Set to ENABLED to enable the Auto Validation feature, or set to DISABLED to disable it.
OverallConfidenceThreshold (dict) --
The overall confidence threshold used to determine suppression decisions.
ConfidenceVerdictThreshold (string) -- [REQUIRED]
The confidence level threshold for suppression decisions.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
{'ValidationOptions': {'ConditionThreshold': {'ConditionThresholdEnabled': 'ENABLED '
'| '
'DISABLED',
'OverallConfidenceThreshold': {'ConfidenceVerdictThreshold': 'MEDIUM '
'| '
'HIGH '
'| '
'MANAGED'}}}}
Specify the account suppression list preferences for a configuration set.
See also: AWS API Documentation
Request Syntax
client.put_configuration_set_suppression_options(
ConfigurationSetName='string',
SuppressedReasons=[
'BOUNCE'|'COMPLAINT',
],
ValidationOptions={
'ConditionThreshold': {
'ConditionThresholdEnabled': 'ENABLED'|'DISABLED',
'OverallConfidenceThreshold': {
'ConfidenceVerdictThreshold': 'MEDIUM'|'HIGH'|'MANAGED'
}
}
}
)
string
[REQUIRED]
The name of the configuration set to change the suppression list preferences for.
list
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) --
The reason that the address was added to the suppression list for your account. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.
BOUNCE – Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.
dict
An object that contains information about the email address suppression preferences for the configuration set in the current Amazon Web Services Region.
ConditionThreshold (dict) -- [REQUIRED]
Specifies the condition threshold settings for suppression validation.
ConditionThresholdEnabled (string) -- [REQUIRED]
Indicates whether Auto Validation is enabled for suppression. Set to ENABLED to enable the Auto Validation feature, or set to DISABLED to disable it.
OverallConfidenceThreshold (dict) --
The overall confidence threshold used to determine suppression decisions.
ConfidenceVerdictThreshold (string) -- [REQUIRED]
The confidence level threshold for suppression decisions.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.