2022/10/31 - Amazon Simple Email Service - 4 new 3 updated api methods
Changes This release includes support for interacting with the Virtual Deliverability Manager, allowing you to opt in/out of the feature and to retrieve recommendations and metric data.
Retrieves batches of metric data collected based on your sending activity.
You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second (cumulative).
See also: AWS API Documentation
Request Syntax
client.batch_get_metric_data(
Queries=[
{
'Id': 'string',
'Namespace': 'VDM',
'Metric': 'SEND'|'COMPLAINT'|'PERMANENT_BOUNCE'|'TRANSIENT_BOUNCE'|'OPEN'|'CLICK'|'DELIVERY'|'DELIVERY_OPEN'|'DELIVERY_CLICK'|'DELIVERY_COMPLAINT',
'Dimensions': {
'string': 'string'
},
'StartDate': datetime(2015, 1, 1),
'EndDate': datetime(2015, 1, 1)
},
]
)
list
[REQUIRED]
A list of queries for metrics to be retrieved.
(dict) --
Represents a single metric data query to include in a batch.
Id (string) -- [REQUIRED]
The query identifier.
Namespace (string) -- [REQUIRED]
The query namespace - e.g. VDM
Metric (string) -- [REQUIRED]
The queried metric. This can be one of the following:
SEND – Emails sent eligible for tracking in the VDM dashboard. This excludes emails sent to the mailbox simulator and emails addressed to more than one recipient.
COMPLAINT – Complaints received for your account. This excludes complaints from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient
PERMANENT_BOUNCE – Permanent bounces - i.e. feedback received for emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those originating from your account-level suppression list (if enabled), and those for emails addressed to more than one recipient.
TRANSIENT_BOUNCE – Transient bounces - i.e. feedback received for delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the mailbox simulator, and those for emails addressed to more than one recipient.
OPEN – Unique open events for emails including open trackers. Excludes opens for emails addressed to more than one recipient.
CLICK – Unique click events for emails including wrapped links. Excludes clicks for emails addressed to more than one recipient.
DELIVERY – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator and for emails addressed to more than one recipient.
DELIVERY_OPEN – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without open trackers.
DELIVERY_CLICK – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails without click trackers.
DELIVERY_COMPLAINT – Successful deliveries for email sending attempts. Excludes deliveries to the mailbox simulator, for emails addressed to more than one recipient, and emails addressed to recipients hosted by ISPs with which Amazon SES does not have a feedback loop agreement.
Dimensions (dict) --
An object that contains mapping between MetricDimensionName and MetricDimensionValue to filter metrics by.
(string) --
The BatchGetMetricDataQuery dimension name. This can be one of the following:
EMAIL_IDENTITY – The email identity used when sending messages.
CONFIGURATION_SET – The configuration set used when sending messages (if one was used).
ISP – The recipient ISP (e.g. Gmail , Yahoo , etc.).
(string) --
StartDate (datetime) -- [REQUIRED]
Represents the start date for the query interval.
EndDate (datetime) -- [REQUIRED]
Represents the end date for the query interval.
dict
Response Syntax
{
'Results': [
{
'Id': 'string',
'Timestamps': [
datetime(2015, 1, 1),
],
'Values': [
123,
]
},
],
'Errors': [
{
'Id': 'string',
'Code': 'INTERNAL_FAILURE'|'ACCESS_DENIED',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Represents the result of processing your metric data batch request
Results (list) --
A list of successfully retrieved MetricDataResult .
(dict) --
The result of a single metric data query.
Id (string) --
The query identifier.
Timestamps (list) --
A list of timestamps for the metric data results.
(datetime) --
Values (list) --
A list of values (cumulative / sum) for the metric data results.
(integer) --
Errors (list) --
A list of MetricDataError encountered while processing your metric data batch request.
(dict) --
An error corresponding to the unsuccessful processing of a single metric data query.
Id (string) --
The query identifier.
Code (string) --
The query error code. Can be one of:
INTERNAL_FAILURE – Amazon SES has failed to process one of the queries.
ACCESS_DENIED – You have insufficient access to retrieve metrics based on the given query.
Message (string) --
The error message associated with the current query error.
Lists the recommendations present in your Amazon SES account in the current Amazon Web Services Region.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
client.list_recommendations(
Filter={
'string': 'string'
},
NextToken='string',
PageSize=123
)
dict
Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE
(string) --
The ListRecommendations filter type. This can be one of the following:
TYPE – The recommendation type, with values like DKIM , SPF or DMARC .
IMPACT – The recommendation impact, with values like HIGH or LOW .
STATUS – The recommendation status, with values like OPEN or FIXED .
RESOURCE_ARN – The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com .
(string) --
string
A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.
integer
The number of results to show in a single call to ListRecommendations . 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 100.
dict
Response Syntax
{
'Recommendations': [
{
'ResourceArn': 'string',
'Type': 'DKIM'|'DMARC'|'SPF',
'Description': 'string',
'Status': 'OPEN'|'FIXED',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'Impact': 'LOW'|'HIGH'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the response to your request to retrieve the list of recommendations for your account.
Recommendations (list) --
The recommendations applicable to your account.
(dict) --
A recommendation generated for your account.
ResourceArn (string) --
The resource affected by the recommendation, with values like arn:aws:ses:us-east-1:123456789012:identity/example.com .
Type (string) --
The recommendation type, with values like DKIM , SPF or DMARC .
Description (string) --
The recommendation description / disambiguator - e.g. DKIM1 and DKIM2 are different recommendations about your DKIM setup.
Status (string) --
The recommendation status, with values like OPEN or FIXED .
CreatedTimestamp (datetime) --
The first time this issue was encountered and the recommendation was generated.
LastUpdatedTimestamp (datetime) --
The last time the recommendation was updated.
Impact (string) --
The recommendation impact, with values like HIGH or LOW .
NextToken (string) --
A string token indicating that there might be additional recommendations available to be listed. Use the token provided in the ListRecommendationsResponse to use in the subsequent call to ListRecommendations with the same parameters to retrieve the next page of recommendations.
Update your Amazon SES account VDM attributes.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
client.put_account_vdm_attributes(
VdmAttributes={
'VdmEnabled': 'ENABLED'|'DISABLED',
'DashboardAttributes': {
'EngagementMetrics': 'ENABLED'|'DISABLED'
},
'GuardianAttributes': {
'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
}
}
)
dict
[REQUIRED]
The VDM attributes that you wish to apply to your Amazon SES account.
VdmEnabled (string) -- [REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
(dict) --
Specify VDM preferences for email that you send using the configuration set.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
client.put_configuration_set_vdm_options(
ConfigurationSetName='string',
VdmOptions={
'DashboardOptions': {
'EngagementMetrics': 'ENABLED'|'DISABLED'
},
'GuardianOptions': {
'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
}
}
)
string
[REQUIRED]
The name of the configuration set.
dict
The VDM options to apply to 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
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
{'VdmOptions': {'DashboardOptions': {'EngagementMetrics': 'ENABLED | DISABLED'},
'GuardianOptions': {'OptimizedSharedDelivery': 'ENABLED | '
'DISABLED'}}}
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'
},
DeliveryOptions={
'TlsPolicy': 'REQUIRE'|'OPTIONAL',
'SendingPoolName': 'string'
},
ReputationOptions={
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
},
SendingOptions={
'SendingEnabled': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SuppressionOptions={
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
]
},
VdmOptions={
'DashboardOptions': {
'EngagementMetrics': 'ENABLED'|'DISABLED'
},
'GuardianOptions': {
'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
}
}
)
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.
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.
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.
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
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
{'VdmAttributes': {'DashboardAttributes': {'EngagementMetrics': 'ENABLED | '
'DISABLED'},
'GuardianAttributes': {'OptimizedSharedDelivery': 'ENABLED '
'| '
'DISABLED'},
'VdmEnabled': 'ENABLED | DISABLED'}}
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',
]
},
'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. 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 (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.
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.
{'VdmOptions': {'DashboardOptions': {'EngagementMetrics': 'ENABLED | DISABLED'},
'GuardianOptions': {'OptimizedSharedDelivery': 'ENABLED | '
'DISABLED'}}}
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'
},
'DeliveryOptions': {
'TlsPolicy': 'REQUIRE'|'OPTIONAL',
'SendingPoolName': 'string'
},
'ReputationOptions': {
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
},
'SendingOptions': {
'SendingEnabled': True|False
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SuppressionOptions': {
'SuppressedReasons': [
'BOUNCE'|'COMPLAINT',
]
},
'VdmOptions': {
'DashboardOptions': {
'EngagementMetrics': 'ENABLED'|'DISABLED'
},
'GuardianOptions': {
'OptimizedSharedDelivery': 'ENABLED'|'DISABLED'
}
}
}
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.
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.
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.
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.