2026/05/29 - Amazon Simple Email Service - 1 new9 updated api methods
Changes This release introduces support for Tenant Suppression Lists
Configure the suppression list preferences for a tenant. Use this operation to enable or disable tenant-level suppression, or to change the suppressed reasons for a tenant.
When you set the suppression scope to TENANT, Amazon SES maintains a separate suppression list for the tenant. When you set the scope to ACCOUNT, the tenant uses the account-level suppression list.
See also: AWS API Documentation
Request Syntax
client.put_tenant_suppression_attributes(
TenantName='string',
SuppressedReasons=[
'BOUNCE'|'COMPLAINT',
],
SuppressionScope='ACCOUNT'|'TENANT'
)
string
[REQUIRED]
The name of the tenant to configure suppression list preferences for.
list
A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following:
COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.
BOUNCE – Amazon SES adds an email address to the suppression list 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 or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant because a message sent to that address results in a hard bounce.
string
The suppression scope for the tenant. Specify TENANT to use the tenant's own suppression list, or ACCOUNT to use the account-level suppression list.
dict
Response Syntax
{}
Response Structure
(dict) --
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
{'SuppressionOptions': {'SuppressionScope': 'ACCOUNT | TENANT'}}
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',
],
'SuppressionScope': 'ACCOUNT'|'TENANT',
'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 the configuration set. You can optionally include a SuppressionScope to override the tenant or account suppression scope for emails sent using this configuration set.
SuppressedReasons (list) --
A list that contains the reasons that email addresses are automatically added to the suppression list for your account or for a specific tenant. This list can contain any or all of the following:
COMPLAINT – Amazon SES adds an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant 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 or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant because a message sent to that address results in a hard bounce.
SuppressionScope (string) --
The suppression scope for the configuration set. This overrides the tenant or account suppression scope for emails sent using this configuration set. Can be one of the following:
TENANT – Use the tenant's suppression list.
ACCOUNT – Use the account-level suppression list.
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.
{'SuppressionAttributes': {'SuppressedReasons': ['BOUNCE | COMPLAINT'],
'SuppressionScope': 'ACCOUNT | TENANT'}}
Create a tenant.
Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.
You can optionally specify SuppressionAttributes to configure tenant-level suppression at creation time. When tenant-level suppression is enabled, Amazon SES maintains a separate suppression list for the tenant instead of using the account-level suppression list.
See also: AWS API Documentation
Request Syntax
client.create_tenant(
TenantName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SuppressionAttributes={
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
],
'SuppressionScope': 'ACCOUNT'|'TENANT'
}
)
string
[REQUIRED]
The name of the tenant to create. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
list
An array of objects that define the tags (keys and values) to associate with the tenant
(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 the tenant. Use this to configure tenant-level suppression at creation time.
SuppressedReasons (list) --
A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following:
COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.
BOUNCE – Amazon SES adds an email address to the suppression list 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 or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant because a message sent to that address results in a hard bounce.
SuppressionScope (string) --
The suppression scope for the tenant. Can be one of the following:
TENANT – The tenant uses its own suppression list.
ACCOUNT – The tenant uses the account-level suppression list.
dict
Response Syntax
{
'TenantName': 'string',
'TenantId': 'string',
'TenantArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SendingStatus': 'ENABLED'|'REINSTATED'|'DISABLED',
'SuppressionAttributes': {
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
],
'SuppressionScope': 'ACCOUNT'|'TENANT'
}
}
Response Structure
(dict) --
Information about a newly created tenant.
TenantName (string) --
The name of the tenant.
TenantId (string) --
A unique identifier for the tenant.
TenantArn (string) --
The Amazon Resource Name (ARN) of the tenant.
CreatedTimestamp (datetime) --
The date and time when the tenant was created.
Tags (list) --
An array of objects that define the tags (keys and values) associated with the tenant.
(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.
SendingStatus (string) --
The status of email sending capability for the tenant.
SuppressionAttributes (dict) --
An object that contains the suppression list preferences for a tenant.
SuppressedReasons (list) --
A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following:
COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.
BOUNCE – Amazon SES adds an email address to the suppression list 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 or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant because a message sent to that address results in a hard bounce.
SuppressionScope (string) --
The suppression scope for the tenant. Can be one of the following:
TENANT – The tenant uses its own suppression list.
ACCOUNT – The tenant uses the account-level suppression list.
{'TenantName': 'string'}
Removes an email address from the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is removed from the account-level suppression list.
See also: AWS API Documentation
Request Syntax
client.delete_suppressed_destination(
EmailAddress='string',
TenantName='string'
)
string
[REQUIRED]
The suppressed email destination to remove from the suppression list for your account or for the specified tenant.
string
The name of the tenant whose suppression list you want to remove the address from. If you omit this parameter, the address is removed from the account-level suppression list.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
{'SuppressionOptions': {'SuppressionScope': 'ACCOUNT | TENANT'}}
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',
],
'SuppressionScope': 'ACCOUNT'|'TENANT',
'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 or for a specific tenant.
SuppressedReasons (list) --
A list that contains the reasons that email addresses are automatically added to the suppression list for your account or for a specific tenant. This list can contain any or all of the following:
COMPLAINT – Amazon SES adds an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant 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 or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant because a message sent to that address results in a hard bounce.
SuppressionScope (string) --
The suppression scope for the configuration set. This overrides the tenant or account suppression scope for emails sent using this configuration set. Can be one of the following:
TENANT – Use the tenant's suppression list.
ACCOUNT – Use the account-level suppression list.
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.
{'TenantName': 'string'}
Response {'SuppressedDestination': {'TenantName': 'string'}}
Retrieves information about a specific email address that's on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.
See also: AWS API Documentation
Request Syntax
client.get_suppressed_destination(
EmailAddress='string',
TenantName='string'
)
string
[REQUIRED]
The email address that's on the suppression list for your account or for the specified tenant.
string
The name of the tenant whose suppression list you want to query. If you omit this parameter, the operation targets the account-level suppression list.
dict
Response Syntax
{
'SuppressedDestination': {
'EmailAddress': 'string',
'Reason': 'BOUNCE'|'COMPLAINT',
'LastUpdateTime': datetime(2015, 1, 1),
'Attributes': {
'MessageId': 'string',
'FeedbackId': 'string'
},
'TenantName': 'string'
}
}
Response Structure
(dict) --
Information about the suppressed email address.
SuppressedDestination (dict) --
An object containing information about the suppressed email address.
EmailAddress (string) --
The email address that is on the suppression list for your account or for a specific tenant.
Reason (string) --
The reason that the address was added to the suppression list for your account or for a specific tenant.
LastUpdateTime (datetime) --
The date and time when the suppressed destination was last updated, shown in Unix time format.
Attributes (dict) --
An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account or for a specific tenant.
MessageId (string) --
The unique identifier of the email message that caused the email address to be added to the suppression list for your account or for a specific tenant.
FeedbackId (string) --
A unique identifier that's generated when an email address is added to the suppression list for your account or for a specific tenant.
TenantName (string) --
The name of the tenant that the suppressed destination belongs to. This field is present only when the suppressed destination is on a tenant's suppression list.
{'Tenant': {'SuppressionAttributes': {'SuppressedReasons': ['BOUNCE | '
'COMPLAINT'],
'SuppressionScope': 'ACCOUNT | TENANT'}}}
Get information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, sending status, and suppression attributes.
See also: AWS API Documentation
Request Syntax
client.get_tenant(
TenantName='string'
)
string
[REQUIRED]
The name of the tenant to retrieve information about.
dict
Response Syntax
{
'Tenant': {
'TenantName': 'string',
'TenantId': 'string',
'TenantArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SendingStatus': 'ENABLED'|'REINSTATED'|'DISABLED',
'SuppressionAttributes': {
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
],
'SuppressionScope': 'ACCOUNT'|'TENANT'
}
}
}
Response Structure
(dict) --
Information about a specific tenant.
Tenant (dict) --
A structure that contains details about the tenant.
TenantName (string) --
The name of the tenant.
TenantId (string) --
A unique identifier for the tenant.
TenantArn (string) --
The Amazon Resource Name (ARN) of the tenant.
CreatedTimestamp (datetime) --
The date and time when the tenant was created.
Tags (list) --
An array of objects that define the tags (keys and values) associated with the tenant.
(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.
SendingStatus (string) --
The status of sending capability for the tenant.
SuppressionAttributes (dict) --
An object that contains information about the suppression list preferences for the tenant.
SuppressedReasons (list) --
A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following:
COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.
BOUNCE – Amazon SES adds an email address to the suppression list 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 or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant because a message sent to that address results in a hard bounce.
SuppressionScope (string) --
The suppression scope for the tenant. Can be one of the following:
TENANT – The tenant uses its own suppression list.
ACCOUNT – The tenant uses the account-level suppression list.
{'TenantName': 'string'}
Retrieves a list of email addresses that are on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.
See also: AWS API Documentation
Request Syntax
client.list_suppressed_destinations(
TenantName='string',
Reasons=[
'BOUNCE'|'COMPLAINT',
],
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
NextToken='string',
PageSize=123
)
string
The name of the tenant whose suppression list you want to retrieve. If you omit this parameter, the operation targets the account-level suppression list.
list
The factors that caused the email address to be added to the suppression list for your account or for a specific tenant.
(string) --
The reason that the address was added to the suppression list for your account or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant because a message sent to that address results in a hard bounce.
datetime
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.
datetime
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.
string
A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.
integer
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.
dict
Response Syntax
{
'SuppressedDestinationSummaries': [
{
'EmailAddress': 'string',
'Reason': 'BOUNCE'|'COMPLAINT',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of suppressed email addresses.
SuppressedDestinationSummaries (list) --
A list of summaries, each containing a summary for a suppressed email destination.
(dict) --
A summary that describes the suppressed email address.
EmailAddress (string) --
The email address that's on the suppression list for your account or for a specific tenant.
Reason (string) --
The reason that the address was added to the suppression list for your account or for a specific tenant.
LastUpdateTime (datetime) --
The date and time when the suppressed destination was last updated, shown in Unix time format.
NextToken (string) --
A token that indicates that there are additional email addresses on the suppression list for your account or for the specified tenant. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.
{'SuppressionScope': 'ACCOUNT | TENANT'}
Specify the suppression list preferences for a configuration set. You can also use this operation to specify a SuppressionScope to override the suppression scope of the tenant or account for emails sent using this configuration set.
See also: AWS API Documentation
Request Syntax
client.put_configuration_set_suppression_options(
ConfigurationSetName='string',
SuppressionScope='ACCOUNT'|'TENANT',
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.
string
The suppression scope for the configuration set. This overrides the tenant or account suppression scope for emails sent using this configuration set. Can be one of the following:
TENANT – Use the tenant's suppression list.
ACCOUNT – Use the account-level suppression list.
list
A list that contains the reasons that email addresses are automatically added to the suppression list for your account or for a specific tenant. This list can contain any or all of the following:
COMPLAINT – Amazon SES adds an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant 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 or for a specific tenant. The value can be one of the following:
COMPLAINT – Amazon SES added an email address to the suppression list for your account or for a specific tenant 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 or for a specific tenant 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.
{'TenantName': 'string'}
Adds an email address to the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the address is added to the account-level suppression list.
See also: AWS API Documentation
Request Syntax
client.put_suppressed_destination(
EmailAddress='string',
Reason='BOUNCE'|'COMPLAINT',
TenantName='string'
)
string
[REQUIRED]
The email address that should be added to the suppression list for your account or for the specified tenant.
string
[REQUIRED]
The factors that should cause the email address to be added to the suppression list for your account or for the specified tenant.
string
The name of the tenant whose suppression list you want to add the address to. If you omit this parameter, the address is added to the account-level suppression list.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.