Table of Contents
SESV2.Client¶A low-level client representing Amazon Simple Email Service (SES V2)
Amazon SES is an Amazon Web Services service that you can use to send email messages to your customers.
If you're new to Amazon SES API v2, you might find it helpful to review the Amazon Simple Email Service Developer Guide . The Amazon SES Developer Guide provides information and code samples that demonstrate how to use Amazon SES API v2 features programmatically.
import boto3
client = boto3.client('sesv2')
These are the available methods:
can_paginate()close()create_configuration_set()create_configuration_set_event_destination()create_contact()create_contact_list()create_custom_verification_email_template()create_dedicated_ip_pool()create_deliverability_test_report()create_email_identity()create_email_identity_policy()create_email_template()create_import_job()delete_configuration_set()delete_configuration_set_event_destination()delete_contact()delete_contact_list()delete_custom_verification_email_template()delete_dedicated_ip_pool()delete_email_identity()delete_email_identity_policy()delete_email_template()delete_suppressed_destination()get_account()get_blacklist_reports()get_configuration_set()get_configuration_set_event_destinations()get_contact()get_contact_list()get_custom_verification_email_template()get_dedicated_ip()get_dedicated_ips()get_deliverability_dashboard_options()get_deliverability_test_report()get_domain_deliverability_campaign()get_domain_statistics_report()get_email_identity()get_email_identity_policies()get_email_template()get_import_job()get_paginator()get_suppressed_destination()get_waiter()list_configuration_sets()list_contact_lists()list_contacts()list_custom_verification_email_templates()list_dedicated_ip_pools()list_deliverability_test_reports()list_domain_deliverability_campaigns()list_email_identities()list_email_templates()list_import_jobs()list_suppressed_destinations()list_tags_for_resource()put_account_dedicated_ip_warmup_attributes()put_account_details()put_account_sending_attributes()put_account_suppression_attributes()put_configuration_set_delivery_options()put_configuration_set_reputation_options()put_configuration_set_sending_options()put_configuration_set_suppression_options()put_configuration_set_tracking_options()put_dedicated_ip_in_pool()put_dedicated_ip_warmup_attributes()put_deliverability_dashboard_option()put_email_identity_configuration_set_attributes()put_email_identity_dkim_attributes()put_email_identity_dkim_signing_attributes()put_email_identity_feedback_attributes()put_email_identity_mail_from_attributes()put_suppressed_destination()send_bulk_email()send_custom_verification_email()send_email()tag_resource()test_render_email_template()untag_resource()update_configuration_set_event_destination()update_contact()update_contact_list()update_custom_verification_email_template()update_email_identity_policy()update_email_template()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_configuration_set(**kwargs)¶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
response = 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',
]
}
)
[REQUIRED]
The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.
An object that defines the open and click tracking options for emails that you send using the configuration set.
The domain to use for tracking open and click events.
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
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.
The name of the dedicated IP pool to associate with the configuration set.
An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.
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.
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
If true , email sending is enabled for the configuration set. If false , email sending is disabled for the configuration set.
An array of objects that define the tags (keys and values) to associate with the configuration set.
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:
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.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.
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.
An object that contains information about the suppression list preferences for your account.
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.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
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptioncreate_configuration_set_event_destination(**kwargs)¶Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A single configuration set can include more than one event destination.
See also: AWS API Documentation
Request Syntax
response = client.create_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
EventDestination={
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE'|'DELIVERY_DELAY'|'SUBSCRIPTION',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
}
)
[REQUIRED]
The name of the configuration set .
[REQUIRED]
A name that identifies the event destination within the configuration set.
[REQUIRED]
An object that defines the event destination.
If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .
If false , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition .
An email sending event type. For example, email sends, opens, and bounces are all email events.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag . To use your own email headers, choose emailHeader . To use link tags, choose linkTags .
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide .
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptioncreate_contact(**kwargs)¶Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.
See also: AWS API Documentation
Request Syntax
response = client.create_contact(
ContactListName='string',
EmailAddress='string',
TopicPreferences=[
{
'TopicName': 'string',
'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
UnsubscribeAll=True|False,
AttributesData='string'
)
[REQUIRED]
The name of the contact list to which the contact should be added.
[REQUIRED]
The contact's email address.
The contact's preferences for being opted-in to or opted-out of topics.
The contact's preference for being opted-in to or opted-out of a topic.
The name of the topic.
The contact's subscription status to a topic which is either OPT_IN or OPT_OUT .
dict
Response Syntax
{}
Response Structure
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.AlreadyExistsExceptioncreate_contact_list(**kwargs)¶Creates a contact list.
See also: AWS API Documentation
Request Syntax
response = client.create_contact_list(
ContactListName='string',
Topics=[
{
'TopicName': 'string',
'DisplayName': 'string',
'Description': 'string',
'DefaultSubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the contact list.
An interest group, theme, or label within a list. A contact list can have multiple topics.
An interest group, theme, or label within a list. Lists can have multiple topics.
The name of the topic.
The name of the topic the contact will see.
A description of what the topic is about, which the contact will see.
The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
The tags associated with a contact list.
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:
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.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.
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
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.LimitExceededExceptioncreate_custom_verification_email_template(**kwargs)¶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
response = client.create_custom_verification_email_template(
TemplateName='string',
FromEmailAddress='string',
TemplateSubject='string',
TemplateContent='string',
SuccessRedirectionURL='string',
FailureRedirectionURL='string'
)
[REQUIRED]
The name of the custom verification email template.
[REQUIRED]
The email address that the custom verification email is sent from.
[REQUIRED]
The subject line of the custom verification email.
[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 .
[REQUIRED]
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
[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.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptioncreate_dedicated_ip_pool(**kwargs)¶Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Web Services account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, the message is sent from one of the addresses in the associated pool.
See also: AWS API Documentation
Request Syntax
response = client.create_dedicated_ip_pool(
PoolName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the dedicated IP pool.
An object that defines the tags (keys and values) that you want to associate with the pool.
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:
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.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.
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) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptioncreate_deliverability_test_report(**kwargs)¶Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.
See also: AWS API Documentation
Request Syntax
response = client.create_deliverability_test_report(
ReportName='string',
FromEmailAddress='string',
Content={
'Simple': {
'Subject': {
'Data': 'string',
'Charset': 'string'
},
'Body': {
'Text': {
'Data': 'string',
'Charset': 'string'
},
'Html': {
'Data': 'string',
'Charset': 'string'
}
}
},
'Raw': {
'Data': b'bytes'
},
'Template': {
'TemplateName': 'string',
'TemplateArn': 'string',
'TemplateData': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The email address that the predictive inbox placement test email was sent from.
[REQUIRED]
The HTML body of the message that you sent when you performed the predictive inbox placement test.
The simple email message. The message consists of a subject and a message body.
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047 .
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The raw email message. The message has to meet the following criteria:
The raw email message. The message has to meet the following criteria:
The template to use for the email message.
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
The Amazon Resource Name (ARN) of the template.
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.
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:
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.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.
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
{
'ReportId': 'string',
'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
}
Response Structure
(dict) --
Information about the predictive inbox placement test that you created.
ReportId (string) --
A unique string that identifies the predictive inbox placement test.
DeliverabilityTestStatus (string) --
The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
Exceptions
SESV2.Client.exceptions.AccountSuspendedExceptionSESV2.Client.exceptions.SendingPausedExceptionSESV2.Client.exceptions.MessageRejectedSESV2.Client.exceptions.MailFromDomainNotVerifiedExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptioncreate_email_identity(**kwargs)¶Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.
When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.
When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM .
Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key.
When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.
Additionally, you can associate an existing configuration set with the email identity that you're verifying.
See also: AWS API Documentation
Request Syntax
response = client.create_email_identity(
EmailIdentity='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DkimSigningAttributes={
'DomainSigningSelector': 'string',
'DomainSigningPrivateKey': 'string',
'NextSigningKeyLength': 'RSA_1024_BIT'|'RSA_2048_BIT'
},
ConfigurationSetName='string'
)
[REQUIRED]
The email address or domain to verify.
An array of objects that define the tags (keys and values) to associate with the email identity.
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:
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.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.
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.
If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .
You can only specify this object if the email identity is a domain, as opposed to an address.
[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.
The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
dict
Response Syntax
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'VerifiedForSendingStatus': True|False,
'DkimAttributes': {
'SigningEnabled': True|False,
'Status': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE'|'NOT_STARTED',
'Tokens': [
'string',
],
'SigningAttributesOrigin': 'AWS_SES'|'EXTERNAL',
'NextSigningKeyLength': 'RSA_1024_BIT'|'RSA_2048_BIT',
'CurrentSigningKeyLength': 'RSA_1024_BIT'|'RSA_2048_BIT',
'LastKeyGenerationTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
If the email identity is a domain, this object contains information about the DKIM verification status for the domain.
If the email identity is an email address, this object is empty.
IdentityType (string) --
The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
VerifiedForSendingStatus (boolean) --
Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide .
DkimAttributes (dict) --
An object that contains information about the DKIM attributes for the identity.
SigningEnabled (boolean) --
If the value is true , then the messages that you send from the identity are signed using DKIM. If the value is false , then the messages that you send from the identity aren't DKIM-signed.
Status (string) --
Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.SUCCESS – The verification process completed successfully.FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.Tokens (list) --
If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
SigningAttributesOrigin (string) --
A string that indicates how DKIM was configured for the identity. These are the possible values:
AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM .EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).NextSigningKeyLength (string) --
[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
CurrentSigningKeyLength (string) --
[Easy DKIM] The key length of the DKIM key pair in use.
LastKeyGenerationTimestamp (datetime) --
[Easy DKIM] The last time a key pair was generated for this identity.
Exceptions
SESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptionSESV2.Client.exceptions.NotFoundExceptioncreate_email_identity_policy(**kwargs)¶Creates the specified sending authorization policy for the given identity (an email address or a domain).
Note
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide .
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.create_email_identity_policy(
EmailIdentity='string',
PolicyName='string',
Policy='string'
)
[REQUIRED]
The email identity.
[REQUIRED]
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
[REQUIRED]
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.BadRequestExceptioncreate_email_template(**kwargs)¶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
response = client.create_email_template(
TemplateName='string',
TemplateContent={
'Subject': 'string',
'Text': 'string',
'Html': 'string'
}
)
[REQUIRED]
The name of the template.
[REQUIRED]
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
The subject line of the email.
The email body that will be visible to recipients whose email clients do not display HTML.
The HTML body of the email.
dict
Response Syntax
{}
Response Structure
(dict) --
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Exceptions
SESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.LimitExceededExceptioncreate_import_job(**kwargs)¶Creates an import job for a data destination.
See also: AWS API Documentation
Request Syntax
response = client.create_import_job(
ImportDestination={
'SuppressionListDestination': {
'SuppressionListImportAction': 'DELETE'|'PUT'
},
'ContactListDestination': {
'ContactListName': 'string',
'ContactListImportAction': 'DELETE'|'PUT'
}
},
ImportDataSource={
'S3Url': 'string',
'DataFormat': 'CSV'|'JSON'
}
)
[REQUIRED]
The destination for the import job.
An object that contains the action of the import job towards suppression list.
The type of action to perform on the address. The following are possible values:
An object that contains the action of the import job towards a contact list.
The name of the contact list.
>The type of action to perform on the addresses. The following are the possible values:
[REQUIRED]
The data source for the import job.
An Amazon S3 URL in the format s3://<bucket_name> /<object> .
The data format of the import job's data source.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
JobId (string) --
A string that represents the import job ID.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.TooManyRequestsExceptiondelete_configuration_set(**kwargs)¶Delete an existing configuration set.
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
response = client.delete_configuration_set(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the configuration set.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptiondelete_configuration_set_event_destination(**kwargs)¶Delete an event destination.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string'
)
[REQUIRED]
The name of the configuration set that contains the event destination to delete.
[REQUIRED]
The name of the event destination to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptiondelete_contact(**kwargs)¶Removes a contact from a contact list.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact(
ContactListName='string',
EmailAddress='string'
)
[REQUIRED]
The name of the contact list from which the contact should be removed.
[REQUIRED]
The contact's email address.
dict
Response Syntax
{}
Response Structure
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptiondelete_contact_list(**kwargs)¶Deletes a contact list and all of the contacts on that list.
See also: AWS API Documentation
Request Syntax
response = client.delete_contact_list(
ContactListName='string'
)
[REQUIRED]
The name of the contact list.
{}
Response Structure
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptiondelete_custom_verification_email_template(**kwargs)¶Deletes an existing 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
response = client.delete_custom_verification_email_template(
TemplateName='string'
)
[REQUIRED]
The name of the custom verification email template that you want to delete.
{}
Response Structure
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptiondelete_dedicated_ip_pool(**kwargs)¶Delete a dedicated IP pool.
See also: AWS API Documentation
Request Syntax
response = client.delete_dedicated_ip_pool(
PoolName='string'
)
[REQUIRED]
The name of the dedicated IP pool that you want to delete.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptiondelete_email_identity(**kwargs)¶Deletes an email identity. An identity can be either an email address or a domain name.
See also: AWS API Documentation
Request Syntax
response = client.delete_email_identity(
EmailIdentity='string'
)
[REQUIRED]
The identity (that is, the email address or domain) to delete.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptiondelete_email_identity_policy(**kwargs)¶Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
Note
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide .
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.delete_email_identity_policy(
EmailIdentity='string',
PolicyName='string'
)
[REQUIRED]
The email identity.
[REQUIRED]
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptiondelete_email_template(**kwargs)¶Deletes an email template.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.delete_email_template(
TemplateName='string'
)
[REQUIRED]
The name of the template to be deleted.
{}
Response Structure
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptiondelete_suppressed_destination(**kwargs)¶Removes an email address from the suppression list for your account.
See also: AWS API Documentation
Request Syntax
response = client.delete_suppressed_destination(
EmailAddress='string'
)
[REQUIRED]
The suppressed email destination to remove from the account suppression list.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionget_account()¶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
response = client.get_account()
{
'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'
}
}
}
Response Structure
A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region.
Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
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.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.
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.
The maximum number of emails that you can send in the current Amazon Web Services Region over a 24-hour period. This value is also called your sending quota .
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 .
The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the past 24 hours.
Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.
An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
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.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.An object that defines your account details.
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.The URL of your website. This information helps us better understand the type of content that you plan to send.
The language you would prefer for the case. The contact language can be one of ENGLISH or JAPANESE .
A description of the types of email that you plan to send.
Additional email addresses where updates are sent about your account review process.
Information about the review of the latest details you submitted.
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.The associated support center case ID (if any).
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionget_blacklist_reports(**kwargs)¶Retrieve a list of the blacklists that your dedicated IP addresses appear on.
See also: AWS API Documentation
Request Syntax
response = client.get_blacklist_reports(
BlacklistItemNames=[
'string',
]
)
[REQUIRED]
A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon SES or Amazon Pinpoint.
An IP address that you want to obtain blacklist information for.
{
'BlacklistReport': {
'string': [
{
'RblName': 'string',
'ListingTime': datetime(2015, 1, 1),
'Description': 'string'
},
]
}
}
Response Structure
An object that contains information about blacklist events.
An object that contains information about a blacklist that one of your dedicated IP addresses appears on.
An IP address that you want to obtain blacklist information for.
An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.
The name of the blacklist that the IP address appears on.
The time when the blacklisting event occurred, shown in Unix time format.
Additional information about the blacklisting event, as provided by the blacklist maintainer.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionget_configuration_set(**kwargs)¶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
response = client.get_configuration_set(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the 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',
]
}
}
Response Structure
Information about a configuration set.
The name of the configuration set.
An object that defines the open and click tracking options for emails that you send using the configuration set.
The domain to use for tracking open and click events.
An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
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.
The name of the dedicated IP pool to associate with the configuration set.
An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
If true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled for the configuration set.
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.
An object that defines whether or not Amazon SES can send email that you send using the configuration set.
If true , email sending is enabled for the configuration set. If false , email sending is disabled for the configuration set.
An array of objects that define the tags (keys and values) that are associated with the configuration set.
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:
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.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.
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.
An object that contains information about the suppression list preferences for your account.
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.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.Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionget_configuration_set_event_destinations(**kwargs)¶Retrieve a list of event destinations that are associated with a configuration set.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
See also: AWS API Documentation
Request Syntax
response = client.get_configuration_set_event_destinations(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the configuration set that contains the event destination.
{
'EventDestinations': [
{
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE'|'DELIVERY_DELAY'|'SUBSCRIPTION',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
},
]
}
Response Structure
Information about an event destination for a configuration set.
An array that includes all of the events destinations that have been configured for the configuration set.
In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
A name that identifies the event destination.
If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .
If false , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
The types of events that Amazon SES sends to the specified event destinations.
An email sending event type. For example, email sends, opens, and bounces are all email events.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag . To use your own email headers, choose emailHeader . To use link tags, choose linkTags .
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide .
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionget_contact(**kwargs)¶Returns a contact from a contact list.
See also: AWS API Documentation
Request Syntax
response = client.get_contact(
ContactListName='string',
EmailAddress='string'
)
[REQUIRED]
The name of the contact list to which the contact belongs.
[REQUIRED]
The contact's email addres.
dict
Response Syntax
{
'ContactListName': 'string',
'EmailAddress': 'string',
'TopicPreferences': [
{
'TopicName': 'string',
'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
'TopicDefaultPreferences': [
{
'TopicName': 'string',
'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
'UnsubscribeAll': True|False,
'AttributesData': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ContactListName (string) --
The name of the contact list to which the contact belongs.
EmailAddress (string) --
The contact's email addres.
TopicPreferences (list) --
The contact's preference for being opted-in to or opted-out of a topic.>
(dict) --
The contact's preference for being opted-in to or opted-out of a topic.
TopicName (string) --
The name of the topic.
SubscriptionStatus (string) --
The contact's subscription status to a topic which is either OPT_IN or OPT_OUT .
TopicDefaultPreferences (list) --
The default topic preferences applied to the contact.
(dict) --
The contact's preference for being opted-in to or opted-out of a topic.
TopicName (string) --
The name of the topic.
SubscriptionStatus (string) --
The contact's subscription status to a topic which is either OPT_IN or OPT_OUT .
UnsubscribeAll (boolean) --
A boolean value status noting if the contact is unsubscribed from all contact list topics.
AttributesData (string) --
The attribute data attached to a contact.
CreatedTimestamp (datetime) --
A timestamp noting when the contact was created.
LastUpdatedTimestamp (datetime) --
A timestamp noting the last time the contact's information was updated.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionget_contact_list(**kwargs)¶Returns contact list metadata. It does not return any information about the contacts present in the list.
See also: AWS API Documentation
Request Syntax
response = client.get_contact_list(
ContactListName='string'
)
[REQUIRED]
The name of the contact list.
{
'ContactListName': 'string',
'Topics': [
{
'TopicName': 'string',
'DisplayName': 'string',
'Description': 'string',
'DefaultSubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
'Description': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The name of the contact list.
An interest group, theme, or label within a list. A contact list can have multiple topics.
An interest group, theme, or label within a list. Lists can have multiple topics.
The name of the topic.
The name of the topic the contact will see.
A description of what the topic is about, which the contact will see.
The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
A description of what the contact list is about.
A timestamp noting when the contact list was created.
A timestamp noting the last time the contact list was updated.
The tags associated with a contact list.
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:
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.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.
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.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionget_custom_verification_email_template(**kwargs)¶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
response = client.get_custom_verification_email_template(
TemplateName='string'
)
[REQUIRED]
The name of the custom verification email template that you want to retrieve.
{
'TemplateName': 'string',
'FromEmailAddress': 'string',
'TemplateSubject': 'string',
'TemplateContent': 'string',
'SuccessRedirectionURL': 'string',
'FailureRedirectionURL': 'string'
}
Response Structure
The following elements are returned by the service.
The name of the custom verification email template.
The email address that the custom verification email is sent from.
The subject line of the custom verification email.
The content of the custom verification email.
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionget_dedicated_ip(**kwargs)¶Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.
See also: AWS API Documentation
Request Syntax
response = client.get_dedicated_ip(
Ip='string'
)
[REQUIRED]
The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Web Services account.
{
'DedicatedIp': {
'Ip': 'string',
'WarmupStatus': 'IN_PROGRESS'|'DONE',
'WarmupPercentage': 123,
'PoolName': 'string'
}
}
Response Structure
Information about a dedicated IP address.
An object that contains information about a dedicated IP address.
An IPv4 address.
The warm-up status of a dedicated IP address. The status can have one of the following values:
IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
The name of the dedicated IP pool that the IP address is associated with.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionget_dedicated_ips(**kwargs)¶List the dedicated IP addresses that are associated with your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.get_dedicated_ips(
PoolName='string',
NextToken='string',
PageSize=123
)
GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.GetDedicatedIpsRequest . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.dict
Response Syntax
{
'DedicatedIps': [
{
'Ip': 'string',
'WarmupStatus': 'IN_PROGRESS'|'DONE',
'WarmupPercentage': 123,
'PoolName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Information about the dedicated IP addresses that are associated with your Amazon Web Services account.
DedicatedIps (list) --
A list of dedicated IP addresses that are associated with your Amazon Web Services account.
(dict) --
Contains information about a dedicated IP address that is associated with your Amazon SES account.
To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide .
Ip (string) --
An IPv4 address.
WarmupStatus (string) --
The warm-up status of a dedicated IP address. The status can have one of the following values:
IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.WarmupPercentage (integer) --
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.
PoolName (string) --
The name of the dedicated IP pool that the IP address is associated with.
NextToken (string) --
A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps , passing this token in the NextToken parameter.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionget_deliverability_dashboard_options()¶Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing .
See also: AWS API Documentation
Request Syntax
response = client.get_deliverability_dashboard_options()
{
'DashboardEnabled': True|False,
'SubscriptionExpiryDate': datetime(2015, 1, 1),
'AccountStatus': 'ACTIVE'|'PENDING_EXPIRATION'|'DISABLED',
'ActiveSubscribedDomains': [
{
'Domain': 'string',
'SubscriptionStartDate': datetime(2015, 1, 1),
'InboxPlacementTrackingOption': {
'Global': True|False,
'TrackedIsps': [
'string',
]
}
},
],
'PendingExpirationSubscribedDomains': [
{
'Domain': 'string',
'SubscriptionStartDate': datetime(2015, 1, 1),
'InboxPlacementTrackingOption': {
'Global': True|False,
'TrackedIsps': [
'string',
]
}
},
]
}
Response Structure
An object that shows the status of the Deliverability dashboard.
Specifies whether the Deliverability dashboard is enabled. If this value is true , the dashboard is enabled.
The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.
The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION , your subscription is scheduled to expire at the end of the current calendar month.
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription.
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
An object that contains information about the inbox placement data settings for the domain.
Specifies whether inbox placement data is being tracked for the domain.
An array of strings, one for each major email provider that the inbox placement data applies to.
The name of an email provider.
An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription.
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
An object that contains information about the inbox placement data settings for the domain.
Specifies whether inbox placement data is being tracked for the domain.
An array of strings, one for each major email provider that the inbox placement data applies to.
The name of an email provider.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.BadRequestExceptionget_deliverability_test_report(**kwargs)¶Retrieve the results of a predictive inbox placement test.
See also: AWS API Documentation
Request Syntax
response = client.get_deliverability_test_report(
ReportId='string'
)
[REQUIRED]
A unique string that identifies the predictive inbox placement test.
{
'DeliverabilityTestReport': {
'ReportId': 'string',
'ReportName': 'string',
'Subject': 'string',
'FromEmailAddress': 'string',
'CreateDate': datetime(2015, 1, 1),
'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
},
'OverallPlacement': {
'InboxPercentage': 123.0,
'SpamPercentage': 123.0,
'MissingPercentage': 123.0,
'SpfPercentage': 123.0,
'DkimPercentage': 123.0
},
'IspPlacements': [
{
'IspName': 'string',
'PlacementStatistics': {
'InboxPercentage': 123.0,
'SpamPercentage': 123.0,
'MissingPercentage': 123.0,
'SpfPercentage': 123.0,
'DkimPercentage': 123.0
}
},
],
'Message': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The results of the predictive inbox placement test.
An object that contains the results of the predictive inbox placement test.
A unique string that identifies the predictive inbox placement test.
A name that helps you identify a predictive inbox placement test report.
The subject line for an email that you submitted in a predictive inbox placement test.
The sender address that you specified for the predictive inbox placement test.
The date and time when the predictive inbox placement test was created, in Unix time format.
The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.
The name of the email provider that the inbox placement data applies to.
An object that contains inbox placement metrics for a specific email provider.
The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.
The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.
The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.
The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.
The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.
An object that contains the message that you sent when you performed this predictive inbox placement test.
An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
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:
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.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.
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.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionget_domain_deliverability_campaign(**kwargs)¶Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
See also: AWS API Documentation
Request Syntax
response = client.get_domain_deliverability_campaign(
CampaignId='string'
)
[REQUIRED]
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
{
'DomainDeliverabilityCampaign': {
'CampaignId': 'string',
'ImageUrl': 'string',
'Subject': 'string',
'FromAddress': 'string',
'SendingIps': [
'string',
],
'FirstSeenDateTime': datetime(2015, 1, 1),
'LastSeenDateTime': datetime(2015, 1, 1),
'InboxCount': 123,
'SpamCount': 123,
'ReadRate': 123.0,
'DeleteRate': 123.0,
'ReadDeleteRate': 123.0,
'ProjectedVolume': 123,
'Esps': [
'string',
]
}
}
Response Structure
An object that contains all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for.
An object that contains the deliverability data for the campaign.
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
The URL of an image that contains a snapshot of the email message that was sent.
The subject line, or title, of the email message.
The verified email address that the email message was sent from.
The IP addresses that were used to send the email message.
An IPv4 address.
The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
The number of email messages that were delivered to recipients’ inboxes.
The number of email messages that were delivered to recipients' spam or junk mail folders.
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
The projected number of recipients that the email message was sent to.
The major email providers who handled the email message.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.NotFoundExceptionget_domain_statistics_report(**kwargs)¶Retrieve inbox placement and engagement rates for the domains that you use to send email.
See also: AWS API Documentation
Request Syntax
response = client.get_domain_statistics_report(
Domain='string',
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1)
)
[REQUIRED]
The domain that you want to obtain deliverability metrics for.
[REQUIRED]
The first day (in Unix time) that you want to obtain domain deliverability metrics for.
[REQUIRED]
The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate .
dict
Response Syntax
{
'OverallVolume': {
'VolumeStatistics': {
'InboxRawCount': 123,
'SpamRawCount': 123,
'ProjectedInbox': 123,
'ProjectedSpam': 123
},
'ReadRatePercent': 123.0,
'DomainIspPlacements': [
{
'IspName': 'string',
'InboxRawCount': 123,
'SpamRawCount': 123,
'InboxPercentage': 123.0,
'SpamPercentage': 123.0
},
]
},
'DailyVolumes': [
{
'StartDate': datetime(2015, 1, 1),
'VolumeStatistics': {
'InboxRawCount': 123,
'SpamRawCount': 123,
'ProjectedInbox': 123,
'ProjectedSpam': 123
},
'DomainIspPlacements': [
{
'IspName': 'string',
'InboxRawCount': 123,
'SpamRawCount': 123,
'InboxPercentage': 123.0,
'SpamPercentage': 123.0
},
]
},
]
}
Response Structure
(dict) --
An object that includes statistics that are related to the domain that you specified.
OverallVolume (dict) --
An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate .
VolumeStatistics (dict) --
An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.
InboxRawCount (integer) --
The total number of emails that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of emails that arrived in recipients' spam or junk mail folders.
ProjectedInbox (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
ProjectedSpam (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
ReadRatePercent (float) --
The percentage of emails that were sent from the domain that were read by their recipients.
DomainIspPlacements (list) --
An object that contains inbox and junk mail placement metrics for individual email providers.
(dict) --
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
IspName (string) --
The name of the email provider that the inbox placement data applies to.
InboxRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
InboxPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
DailyVolumes (list) --
An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate .
(dict) --
An object that contains information about the volume of email sent on each day of the analysis period.
StartDate (datetime) --
The date that the DailyVolume metrics apply to, in Unix time.
VolumeStatistics (dict) --
An object that contains inbox placement metrics for a specific day in the analysis period.
InboxRawCount (integer) --
The total number of emails that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of emails that arrived in recipients' spam or junk mail folders.
ProjectedInbox (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.
ProjectedSpam (integer) --
An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.
DomainIspPlacements (list) --
An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
(dict) --
An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.
IspName (string) --
The name of the email provider that the inbox placement data applies to.
InboxRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamRawCount (integer) --
The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
InboxPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.
SpamPercentage (float) --
The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionget_email_identity(**kwargs)¶Provides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.
See also: AWS API Documentation
Request Syntax
response = client.get_email_identity(
EmailIdentity='string'
)
[REQUIRED]
The email identity.
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'FeedbackForwardingStatus': True|False,
'VerifiedForSendingStatus': True|False,
'DkimAttributes': {
'SigningEnabled': True|False,
'Status': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE'|'NOT_STARTED',
'Tokens': [
'string',
],
'SigningAttributesOrigin': 'AWS_SES'|'EXTERNAL',
'NextSigningKeyLength': 'RSA_1024_BIT'|'RSA_2048_BIT',
'CurrentSigningKeyLength': 'RSA_1024_BIT'|'RSA_2048_BIT',
'LastKeyGenerationTimestamp': datetime(2015, 1, 1)
},
'MailFromAttributes': {
'MailFromDomain': 'string',
'MailFromDomainStatus': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE',
'BehaviorOnMxFailure': 'USE_DEFAULT_VALUE'|'REJECT_MESSAGE'
},
'Policies': {
'string': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'ConfigurationSetName': 'string'
}
Response Structure
Details about an email identity.
The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.
The feedback forwarding configuration for the identity.
If the value is true , you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.
You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide .
An object that contains information about the DKIM attributes for the identity.
If the value is true , then the messages that you send from the identity are signed using DKIM. If the value is false , then the messages that you send from the identity aren't DKIM-signed.
Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:
PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.SUCCESS – The verification process completed successfully.FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
A string that indicates how DKIM was configured for the identity. These are the possible values:
AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM .EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
[Easy DKIM] The key length of the DKIM key pair in use.
[Easy DKIM] The last time a key pair was generated for this identity.
An object that contains information about the Mail-From attributes for the email identity.
The name of a domain that an email identity uses as a custom MAIL FROM domain.
The status of the MAIL FROM domain. This status can have the following values:
PENDING – Amazon SES hasn't started searching for the MX record yet.SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.FAILED – Amazon SES can't find the required MX record, or the record no longer exists.TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.The action to take if the required MX record can't be found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending , Failed , and TemporaryFailure states.
A map of policy names to policies.
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide .
An array of objects that define the tags (keys and values) that are associated with the email identity.
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:
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.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.
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.
The configuration set used by default when sending from this identity.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionget_email_identity_policies(**kwargs)¶Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.
Note
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide .
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.get_email_identity_policies(
EmailIdentity='string'
)
[REQUIRED]
The email identity.
{
'Policies': {
'string': 'string'
}
}
Response Structure
Identity policies associated with email identity.
A map of policy names to policies.
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide .
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionget_email_template(**kwargs)¶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
response = client.get_email_template(
TemplateName='string'
)
[REQUIRED]
The name of the template.
{
'TemplateName': 'string',
'TemplateContent': {
'Subject': 'string',
'Text': 'string',
'Html': 'string'
}
}
Response Structure
The following element is returned by the service.
The name of the template.
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
The subject line of the email.
The email body that will be visible to recipients whose email clients do not display HTML.
The HTML body of the email.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionget_import_job(**kwargs)¶Provides information about an import job.
See also: AWS API Documentation
Request Syntax
response = client.get_import_job(
JobId='string'
)
[REQUIRED]
The ID of the import job.
{
'JobId': 'string',
'ImportDestination': {
'SuppressionListDestination': {
'SuppressionListImportAction': 'DELETE'|'PUT'
},
'ContactListDestination': {
'ContactListName': 'string',
'ContactListImportAction': 'DELETE'|'PUT'
}
},
'ImportDataSource': {
'S3Url': 'string',
'DataFormat': 'CSV'|'JSON'
},
'FailureInfo': {
'FailedRecordsS3Url': 'string',
'ErrorMessage': 'string'
},
'JobStatus': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED',
'CreatedTimestamp': datetime(2015, 1, 1),
'CompletedTimestamp': datetime(2015, 1, 1),
'ProcessedRecordsCount': 123,
'FailedRecordsCount': 123
}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
A string that represents the import job ID.
The destination of the import job.
An object that contains the action of the import job towards suppression list.
The type of action to perform on the address. The following are possible values:
An object that contains the action of the import job towards a contact list.
The name of the contact list.
>The type of action to perform on the addresses. The following are the possible values:
The data source of the import job.
An Amazon S3 URL in the format s3://<bucket_name> /<object> .
The data format of the import job's data source.
The failure details about an import job.
An Amazon S3 presigned URL that contains all the failed records and related information.
A message about why the import job failed.
The status of the import job.
The time stamp of when the import job was created.
The time stamp of when the import job was completed.
The current number of records processed.
The number of records that failed processing because of invalid input or other reasons.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_suppressed_destination(**kwargs)¶Retrieves information about a specific email address that's on the suppression list for your account.
See also: AWS API Documentation
Request Syntax
response = client.get_suppressed_destination(
EmailAddress='string'
)
[REQUIRED]
The email address that's on the account suppression list.
{
'SuppressedDestination': {
'EmailAddress': 'string',
'Reason': 'BOUNCE'|'COMPLAINT',
'LastUpdateTime': datetime(2015, 1, 1),
'Attributes': {
'MessageId': 'string',
'FeedbackId': 'string'
}
}
}
Response Structure
Information about the suppressed email address.
An object containing information about the suppressed email address.
The email address that is on the suppression list for your account.
The reason that the address was added to the suppression list for your account.
The date and time when the suppressed destination was last updated, shown in Unix time format.
An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account.
The unique identifier of the email message that caused the email address to be added to the suppression list for your account.
A unique identifier that's generated when an email address is added to the suppression list for your account.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_configuration_sets(**kwargs)¶List all of the configuration sets associated with your account in the current region.
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
response = client.list_configuration_sets(
NextToken='string',
PageSize=123
)
ListConfigurationSets to indicate the position in the list of configuration sets.ListConfigurationSets . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.dict
Response Syntax
{
'ConfigurationSets': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of configuration sets in your Amazon SES account in the current Amazon Web Services Region.
ConfigurationSets (list) --
An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region.
(string) --
The name of a configuration set.
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.
NextToken (string) --
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets , and pass this token in the NextToken parameter.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionlist_contact_lists(**kwargs)¶Lists all of the contact lists available.
See also: AWS API Documentation
Request Syntax
response = client.list_contact_lists(
PageSize=123,
NextToken='string'
)
NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional lists.dict
Response Syntax
{
'ContactLists': [
{
'ContactListName': 'string',
'LastUpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContactLists (list) --
The available contact lists.
(dict) --
A list that contains contacts that have subscribed to a particular topic or topics.
ContactListName (string) --
The name of the contact list.
LastUpdatedTimestamp (datetime) --
A timestamp noting the last time the contact list was updated.
NextToken (string) --
A string token indicating that there might be additional contact lists available to be listed. Copy this token to a subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionlist_contacts(**kwargs)¶Lists the contacts present in a specific contact list.
See also: AWS API Documentation
Request Syntax
response = client.list_contacts(
ContactListName='string',
Filter={
'FilteredStatus': 'OPT_IN'|'OPT_OUT',
'TopicFilter': {
'TopicName': 'string',
'UseDefaultIfPreferenceUnavailable': True|False
}
},
PageSize=123,
NextToken='string'
)
[REQUIRED]
The name of the contact list.
A filter that can be applied to a list of contacts.
The status by which you are filtering: OPT_IN or OPT_OUT .
Used for filtering by a specific topic preference.
The name of a topic on which you wish to apply the filter.
Notes that the default subscription status should be applied to a contact because the contact has not noted their preference for subscribing to a topic.
NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.dict
Response Syntax
{
'Contacts': [
{
'EmailAddress': 'string',
'TopicPreferences': [
{
'TopicName': 'string',
'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
'TopicDefaultPreferences': [
{
'TopicName': 'string',
'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
'UnsubscribeAll': True|False,
'LastUpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contacts (list) --
The contacts present in a specific contact list.
(dict) --
A contact is the end-user who is receiving the email.
EmailAddress (string) --
The contact's email address.
TopicPreferences (list) --
The contact's preference for being opted-in to or opted-out of a topic.
(dict) --
The contact's preference for being opted-in to or opted-out of a topic.
TopicName (string) --
The name of the topic.
SubscriptionStatus (string) --
The contact's subscription status to a topic which is either OPT_IN or OPT_OUT .
TopicDefaultPreferences (list) --
The default topic preferences applied to the contact.
(dict) --
The contact's preference for being opted-in to or opted-out of a topic.
TopicName (string) --
The name of the topic.
SubscriptionStatus (string) --
The contact's subscription status to a topic which is either OPT_IN or OPT_OUT .
UnsubscribeAll (boolean) --
A boolean value status noting if the contact is unsubscribed from all contact list topics.
LastUpdatedTimestamp (datetime) --
A timestamp noting the last time the contact's information was updated.
NextToken (string) --
A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionlist_custom_verification_email_templates(**kwargs)¶Lists the existing custom verification email templates for your account in the current Amazon Web Services Region.
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
response = client.list_custom_verification_email_templates(
NextToken='string',
PageSize=123
)
ListCustomVerificationEmailTemplates to indicate the position in the list of custom verification email templates.The number of results to show in a single call to ListCustomVerificationEmailTemplates . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 1, and can be no more than 50.
dict
Response Syntax
{
'CustomVerificationEmailTemplates': [
{
'TemplateName': 'string',
'FromEmailAddress': 'string',
'TemplateSubject': 'string',
'SuccessRedirectionURL': 'string',
'FailureRedirectionURL': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The following elements are returned by the service.
CustomVerificationEmailTemplates (list) --
A list of the custom verification email templates that exist in your account.
(dict) --
Contains information about a custom verification email template.
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.
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.
NextToken (string) --
A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification email templates.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionlist_dedicated_ip_pools(**kwargs)¶List all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.
See also: AWS API Documentation
Request Syntax
response = client.list_dedicated_ip_pools(
NextToken='string',
PageSize=123
)
ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.ListDedicatedIpPools . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.dict
Response Syntax
{
'DedicatedIpPools': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of dedicated IP pools.
DedicatedIpPools (list) --
A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in the current Region.
(string) --
The name of a dedicated IP pool.
NextToken (string) --
A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools , passing this token in the NextToken parameter.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionlist_deliverability_test_reports(**kwargs)¶Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.
See also: AWS API Documentation
Request Syntax
response = client.list_deliverability_test_reports(
NextToken='string',
PageSize=123
)
ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.The number of results to show in a single call to ListDeliverabilityTestReports . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
dict
Response Syntax
{
'DeliverabilityTestReports': [
{
'ReportId': 'string',
'ReportName': 'string',
'Subject': 'string',
'FromEmailAddress': 'string',
'CreateDate': datetime(2015, 1, 1),
'DeliverabilityTestStatus': 'IN_PROGRESS'|'COMPLETED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.
DeliverabilityTestReports (list) --
An object that contains a lists of predictive inbox placement tests that you've performed.
(dict) --
An object that contains metadata related to a predictive inbox placement test.
ReportId (string) --
A unique string that identifies the predictive inbox placement test.
ReportName (string) --
A name that helps you identify a predictive inbox placement test report.
Subject (string) --
The subject line for an email that you submitted in a predictive inbox placement test.
FromEmailAddress (string) --
The sender address that you specified for the predictive inbox placement test.
CreateDate (datetime) --
The date and time when the predictive inbox placement test was created, in Unix time format.
DeliverabilityTestStatus (string) --
The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.
NextToken (string) --
A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports , and pass this token in the NextToken parameter.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionlist_domain_deliverability_campaigns(**kwargs)¶Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
See also: AWS API Documentation
Request Syntax
response = client.list_domain_deliverability_campaigns(
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
SubscribedDomain='string',
NextToken='string',
PageSize=123
)
[REQUIRED]
The first day, in Unix time format, that you want to obtain deliverability data for.
[REQUIRED]
The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.
[REQUIRED]
The domain to obtain deliverability data for.
ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.dict
Response Syntax
{
'DomainDeliverabilityCampaigns': [
{
'CampaignId': 'string',
'ImageUrl': 'string',
'Subject': 'string',
'FromAddress': 'string',
'SendingIps': [
'string',
],
'FirstSeenDateTime': datetime(2015, 1, 1),
'LastSeenDateTime': datetime(2015, 1, 1),
'InboxCount': 123,
'SpamCount': 123,
'ReadRate': 123.0,
'DeleteRate': 123.0,
'ReadDeleteRate': 123.0,
'ProjectedVolume': 123,
'Esps': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard for the domain.
DomainDeliverabilityCampaigns (list) --
An array of responses, one for each campaign that used the domain to send email during the specified time range.
(dict) --
An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).
CampaignId (string) --
The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.
ImageUrl (string) --
The URL of an image that contains a snapshot of the email message that was sent.
Subject (string) --
The subject line, or title, of the email message.
FromAddress (string) --
The verified email address that the email message was sent from.
SendingIps (list) --
The IP addresses that were used to send the email message.
(string) --
An IPv4 address.
FirstSeenDateTime (datetime) --
The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
LastSeenDateTime (datetime) --
The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.
InboxCount (integer) --
The number of email messages that were delivered to recipients’ inboxes.
SpamCount (integer) --
The number of email messages that were delivered to recipients' spam or junk mail folders.
ReadRate (float) --
The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
DeleteRate (float) --
The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
ReadDeleteRate (float) --
The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.
ProjectedVolume (integer) --
The projected number of recipients that the email message was sent to.
Esps (list) --
The major email providers who handled the email message.
NextToken (string) --
A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.NotFoundExceptionlist_email_identities(**kwargs)¶Returns a list of all of the email identities that are associated with your Amazon Web Services account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't. This operation returns identities that are associated with Amazon SES and Amazon Pinpoint.
See also: AWS API Documentation
Request Syntax
response = client.list_email_identities(
NextToken='string',
PageSize=123
)
ListEmailIdentities to indicate the position in the list of identities.The number of results to show in a single call to ListEmailIdentities . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 0, and can be no more than 1000.
dict
Response Syntax
{
'EmailIdentities': [
{
'IdentityType': 'EMAIL_ADDRESS'|'DOMAIN'|'MANAGED_DOMAIN',
'IdentityName': 'string',
'SendingEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of all of the identities that you've attempted to verify, regardless of whether or not those identities were successfully verified.
EmailIdentities (list) --
An array that includes all of the email identities associated with your Amazon Web Services account.
(dict) --
Information about an email identity.
IdentityType (string) --
The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.
IdentityName (string) --
The address or domain of the identity.
SendingEnabled (boolean) --
Indicates whether or not you can send email from the identity.
An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.
NextToken (string) --
A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities , and pass this token in the NextToken parameter.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionlist_email_templates(**kwargs)¶Lists the email templates 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
response = client.list_email_templates(
NextToken='string',
PageSize=123
)
ListEmailTemplates to indicate the position in the list of email templates.The number of results to show in a single call to ListEmailTemplates . If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.
The value you specify has to be at least 1, and can be no more than 10.
dict
Response Syntax
{
'TemplatesMetadata': [
{
'TemplateName': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The following elements are returned by the service.
TemplatesMetadata (list) --
An array the contains the name and creation time stamp for each template in your Amazon SES account.
(dict) --
Contains information about an email template.
TemplateName (string) --
The name of the template.
CreatedTimestamp (datetime) --
The time and date the template was created.
NextToken (string) --
A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent ListEmailTemplates call to retrieve the next 10 email templates.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionlist_import_jobs(**kwargs)¶Lists all of the import jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_import_jobs(
ImportDestinationType='SUPPRESSION_LIST'|'CONTACT_LIST',
NextToken='string',
PageSize=123
)
ImportDestinationType .ListImportJobs with the same parameters to retrieve the next page of import jobs.NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional addresses.dict
Response Syntax
{
'ImportJobs': [
{
'JobId': 'string',
'ImportDestination': {
'SuppressionListDestination': {
'SuppressionListImportAction': 'DELETE'|'PUT'
},
'ContactListDestination': {
'ContactListName': 'string',
'ContactListImportAction': 'DELETE'|'PUT'
}
},
'JobStatus': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED',
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
ImportJobs (list) --
A list of the import job summaries.
(dict) --
A summary of the import job.
JobId (string) --
A string that represents the import job ID.
ImportDestination (dict) --
An object that contains details about the resource destination the import job is going to target.
SuppressionListDestination (dict) --
An object that contains the action of the import job towards suppression list.
SuppressionListImportAction (string) --
The type of action to perform on the address. The following are possible values:
ContactListDestination (dict) --
An object that contains the action of the import job towards a contact list.
ContactListName (string) --
The name of the contact list.
ContactListImportAction (string) --
>The type of action to perform on the addresses. The following are the possible values:
JobStatus (string) --
The status of the import job.
CreatedTimestamp (datetime) --
The date and time when the import job was created.
NextToken (string) --
A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionlist_suppressed_destinations(**kwargs)¶Retrieves a list of email addresses that are on the suppression list for your account.
See also: AWS API Documentation
Request Syntax
response = client.list_suppressed_destinations(
Reasons=[
'BOUNCE'|'COMPLAINT',
],
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
NextToken='string',
PageSize=123
)
The factors that caused the email address to be added to .
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.ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.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.
Reason (string) --
The reason that the address was added to the suppression list for your account.
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. To view additional suppressed addresses, issue another request to ListSuppressedDestinations , and pass this token in the NextToken parameter.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.InvalidNextTokenExceptionRetrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource. Each tag consists of a required tag key and an optional associated tag value . A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key ) and an associated tag value (Value )
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:
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.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.
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.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionput_account_dedicated_ip_warmup_attributes(**kwargs)¶Enable or disable the automatic warm-up feature for dedicated IP addresses.
See also: AWS API Documentation
Request Syntax
response = client.put_account_dedicated_ip_warmup_attributes(
AutoWarmupEnabled=True|False
)
true to enable the automatic warm-up feature, or set to false to disable it.{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_account_details(**kwargs)¶Update your Amazon SES account details.
See also: AWS API Documentation
Request Syntax
response = client.put_account_details(
MailType='MARKETING'|'TRANSACTIONAL',
WebsiteURL='string',
ContactLanguage='EN'|'JA',
UseCaseDescription='string',
AdditionalContactEmailAddresses=[
'string',
],
ProductionAccessEnabled=True|False
)
[REQUIRED]
The type of email your account will send.
[REQUIRED]
The URL of your website. This information helps us better understand the type of content that you plan to send.
[REQUIRED]
A description of the types of email that you plan to send.
Additional email addresses that you would like to be notified regarding Amazon SES matters.
Indicates whether or not your account should have production access in the current Amazon Web Services Region.
If the value is false , then your account is in the sandbox . When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.
If the value is true , then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConflictExceptionput_account_sending_attributes(**kwargs)¶Enable or disable the ability of your account to send email.
See also: AWS API Documentation
Request Syntax
response = client.put_account_sending_attributes(
SendingEnabled=True|False
)
Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.
Note
If Amazon Web Services paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.
{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_account_suppression_attributes(**kwargs)¶Change the settings for the account-level suppression list.
See also: AWS API Documentation
Request Syntax
response = client.put_account_suppression_attributes(
SuppressedReasons=[
'BOUNCE'|'COMPLAINT',
]
)
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.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.{}
Response Structure
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_configuration_set_delivery_options(**kwargs)¶Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_delivery_options(
ConfigurationSetName='string',
TlsPolicy='REQUIRE'|'OPTIONAL',
SendingPoolName='string'
)
[REQUIRED]
The name of the configuration set to associate with a dedicated IP pool.
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.dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_configuration_set_reputation_options(**kwargs)¶Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_reputation_options(
ConfigurationSetName='string',
ReputationMetricsEnabled=True|False
)
[REQUIRED]
The name of the configuration set.
true , tracking of reputation metrics is enabled for the configuration set. If false , tracking of reputation metrics is disabled 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.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_configuration_set_sending_options(**kwargs)¶Enable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_sending_options(
ConfigurationSetName='string',
SendingEnabled=True|False
)
[REQUIRED]
The name of the configuration set to enable or disable email sending for.
true , email sending is enabled for the configuration set. If false , email sending is disabled 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.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_configuration_set_suppression_options(**kwargs)¶Specify the account suppression list preferences for a configuration set.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_suppression_options(
ConfigurationSetName='string',
SuppressedReasons=[
'BOUNCE'|'COMPLAINT',
]
)
[REQUIRED]
The name of the configuration set to change the suppression list preferences for.
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.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
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_configuration_set_tracking_options(**kwargs)¶Specify a custom domain to use for open and click tracking elements in email that you send.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_set_tracking_options(
ConfigurationSetName='string',
CustomRedirectDomain='string'
)
[REQUIRED]
The name of 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.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_dedicated_ip_in_pool(**kwargs)¶Move a dedicated IP address to an existing dedicated IP pool.
Note
The dedicated IP address that you specify must already exist, and must be associated with your Amazon Web Services account.
The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
See also: AWS API Documentation
Request Syntax
response = client.put_dedicated_ip_in_pool(
Ip='string',
DestinationPoolName='string'
)
[REQUIRED]
The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Web Services account.
[REQUIRED]
The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_dedicated_ip_warmup_attributes(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.put_dedicated_ip_warmup_attributes(
Ip='string',
WarmupPercentage=123
)
[REQUIRED]
The dedicated IP address that you want to update the warm-up attributes for.
[REQUIRED]
The warm-up percentage that you want to associate with the dedicated IP address.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_deliverability_dashboard_option(**kwargs)¶Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.
When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other Amazon Web Services services. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing .
See also: AWS API Documentation
Request Syntax
response = client.put_deliverability_dashboard_option(
DashboardEnabled=True|False,
SubscribedDomains=[
{
'Domain': 'string',
'SubscriptionStartDate': datetime(2015, 1, 1),
'InboxPlacementTrackingOption': {
'Global': True|False,
'TrackedIsps': [
'string',
]
}
},
]
)
[REQUIRED]
Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true .
An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.
An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.
A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription.
The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.
An object that contains information about the inbox placement data settings for the domain.
Specifies whether inbox placement data is being tracked for the domain.
An array of strings, one for each major email provider that the inbox placement data applies to.
The name of an email provider.
dict
Response Syntax
{}
Response Structure
(dict) --
A response that indicates whether the Deliverability dashboard is enabled.
Exceptions
SESV2.Client.exceptions.AlreadyExistsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.BadRequestExceptionput_email_identity_configuration_set_attributes(**kwargs)¶Used to associate a configuration set with an email identity.
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_configuration_set_attributes(
EmailIdentity='string',
ConfigurationSetName='string'
)
[REQUIRED]
The email address or domain to associate with a configuration set.
dict
Response Syntax
{}
Response Structure
(dict) --
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_email_identity_dkim_attributes(**kwargs)¶Used to enable or disable DKIM authentication for an email identity.
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_dkim_attributes(
EmailIdentity='string',
SigningEnabled=True|False
)
[REQUIRED]
The email identity.
Sets the DKIM signing configuration for the identity.
When you set this value true , then the messages that are sent from the identity are signed using DKIM. If you set this value to false , your messages are sent without DKIM signing.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_email_identity_dkim_signing_attributes(**kwargs)¶Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_dkim_signing_attributes(
EmailIdentity='string',
SigningAttributesOrigin='AWS_SES'|'EXTERNAL',
SigningAttributes={
'DomainSigningSelector': 'string',
'DomainSigningPrivateKey': 'string',
'NextSigningKeyLength': 'RSA_1024_BIT'|'RSA_2048_BIT'
}
)
[REQUIRED]
The email identity.
[REQUIRED]
The method to use to configure DKIM for the identity. There are the following possible values:
AWS_SES – Configure DKIM for the identity by using Easy DKIM .EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM .
[Bring Your Own DKIM] A string that's used to identify a public key in the DNS configuration for a domain.
[Bring Your Own DKIM] A private key that's used to generate a DKIM signature.
The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
dict
Response Syntax
{
'DkimStatus': 'PENDING'|'SUCCESS'|'FAILED'|'TEMPORARY_FAILURE'|'NOT_STARTED',
'DkimTokens': [
'string',
]
}
Response Structure
(dict) --
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
DkimStatus (string) --
The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.
If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.
The status can be one of the following:
PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.SUCCESS – The verification process completed successfully.FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.DkimTokens (list) --
If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.
If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_email_identity_feedback_attributes(**kwargs)¶Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.
If the value is true , you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.
You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_feedback_attributes(
EmailIdentity='string',
EmailForwardingEnabled=True|False
)
[REQUIRED]
The email identity.
Sets the feedback forwarding configuration for the identity.
If the value is true , you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.
You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_email_identity_mail_from_attributes(**kwargs)¶Used to enable or disable the custom Mail-From domain configuration for an email identity.
See also: AWS API Documentation
Request Syntax
response = client.put_email_identity_mail_from_attributes(
EmailIdentity='string',
MailFromDomain='string',
BehaviorOnMxFailure='USE_DEFAULT_VALUE'|'REJECT_MESSAGE'
)
[REQUIRED]
The verified email identity.
The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.
These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending , Failed , and TemporaryFailure states.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionput_suppressed_destination(**kwargs)¶Adds an email address to the suppression list for your account.
See also: AWS API Documentation
Request Syntax
response = client.put_suppressed_destination(
EmailAddress='string',
Reason='BOUNCE'|'COMPLAINT'
)
[REQUIRED]
The email address that should be added to the suppression list for your account.
[REQUIRED]
The factors that should cause the email address to be added to the suppression list for your account.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionsend_bulk_email(**kwargs)¶Composes an email message to multiple destinations.
See also: AWS API Documentation
Request Syntax
response = client.send_bulk_email(
FromEmailAddress='string',
FromEmailAddressIdentityArn='string',
ReplyToAddresses=[
'string',
],
FeedbackForwardingEmailAddress='string',
FeedbackForwardingEmailAddressIdentityArn='string',
DefaultEmailTags=[
{
'Name': 'string',
'Value': 'string'
},
],
DefaultContent={
'Template': {
'TemplateName': 'string',
'TemplateArn': 'string',
'TemplateData': 'string'
}
},
BulkEmailEntries=[
{
'Destination': {
'ToAddresses': [
'string',
],
'CcAddresses': [
'string',
],
'BccAddresses': [
'string',
]
},
'ReplacementTags': [
{
'Name': 'string',
'Value': 'string'
},
],
'ReplacementEmailContent': {
'ReplacementTemplate': {
'ReplacementTemplateData': 'string'
}
}
},
],
ConfigurationSetName='string'
)
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide .
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide .
A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
The name of the message tag. The message tag name has to meet the following criteria:
The value of the message tag. The message tag value has to meet the following criteria:
[REQUIRED]
An object that contains the body of the message. You can specify a template message.
The template to use for the bulk email message.
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
The Amazon Resource Name (ARN) of the template.
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
[REQUIRED]
The list of bulk email entry objects.
Represents the destination of the message, consisting of To:, CC:, and BCC: fields.
Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 . For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters . If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492 .
An array that contains the email addresses of the "To" recipients for the email.
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
The name of the message tag. The message tag name has to meet the following criteria:
The value of the message tag. The message tag value has to meet the following criteria:
The ReplacementEmailContent associated with a BulkEmailEntry .
The ReplacementTemplate associated with ReplacementEmailContent .
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
dict
Response Syntax
{
'BulkEmailEntryResults': [
{
'Status': 'SUCCESS'|'MESSAGE_REJECTED'|'MAIL_FROM_DOMAIN_NOT_VERIFIED'|'CONFIGURATION_SET_NOT_FOUND'|'TEMPLATE_NOT_FOUND'|'ACCOUNT_SUSPENDED'|'ACCOUNT_THROTTLED'|'ACCOUNT_DAILY_QUOTA_EXCEEDED'|'INVALID_SENDING_POOL_NAME'|'ACCOUNT_SENDING_PAUSED'|'CONFIGURATION_SET_SENDING_PAUSED'|'INVALID_PARAMETER'|'TRANSIENT_FAILURE'|'FAILED',
'Error': 'string',
'MessageId': 'string'
},
]
}
Response Structure
(dict) --
The following data is returned in JSON format by the service.
BulkEmailEntryResults (list) --
One object per intended recipient. Check each response object and retry any messages with a failure status.
(dict) --
The result of the SendBulkEmail operation of each specified BulkEmailEntry .
Status (string) --
The status of a message sent using the SendBulkTemplatedEmail operation.
Possible values for this parameter include:
Error (string) --
A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.
MessageId (string) --
The unique message identifier returned from the SendBulkTemplatedEmail operation.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.AccountSuspendedExceptionSESV2.Client.exceptions.SendingPausedExceptionSESV2.Client.exceptions.MessageRejectedSESV2.Client.exceptions.MailFromDomainNotVerifiedExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionsend_custom_verification_email(**kwargs)¶Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email template. For more information about creating and using 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
response = client.send_custom_verification_email(
EmailAddress='string',
TemplateName='string',
ConfigurationSetName='string'
)
[REQUIRED]
The email address to verify.
[REQUIRED]
The name of the custom verification email template to use when sending the verification email.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
The following element is returned by the service.
MessageId (string) --
The unique message identifier returned from the SendCustomVerificationEmail operation.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.MessageRejectedSESV2.Client.exceptions.SendingPausedExceptionSESV2.Client.exceptions.MailFromDomainNotVerifiedExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionsend_email(**kwargs)¶Sends an email message. You can use the Amazon SES API v2 to send the following types of messages:
See also: AWS API Documentation
Request Syntax
response = client.send_email(
FromEmailAddress='string',
FromEmailAddressIdentityArn='string',
Destination={
'ToAddresses': [
'string',
],
'CcAddresses': [
'string',
],
'BccAddresses': [
'string',
]
},
ReplyToAddresses=[
'string',
],
FeedbackForwardingEmailAddress='string',
FeedbackForwardingEmailAddressIdentityArn='string',
Content={
'Simple': {
'Subject': {
'Data': 'string',
'Charset': 'string'
},
'Body': {
'Text': {
'Data': 'string',
'Charset': 'string'
},
'Html': {
'Data': 'string',
'Charset': 'string'
}
}
},
'Raw': {
'Data': b'bytes'
},
'Template': {
'TemplateName': 'string',
'TemplateArn': 'string',
'TemplateData': 'string'
}
},
EmailTags=[
{
'Name': 'string',
'Value': 'string'
},
],
ConfigurationSetName='string',
ListManagementOptions={
'ContactListName': 'string',
'TopicName': 'string'
}
)
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide .
For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.
An object that contains the recipients of the email message.
An array that contains the email addresses of the "To" recipients for the email.
An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.
An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.
The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.
For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.
For more information about sending authorization, see the Amazon SES Developer Guide .
[REQUIRED]
An object that contains the body of the message. You can send either a Simple message Raw message or a template Message.
The simple email message. The message consists of a subject and a message body.
The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047 .
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.
An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.
The content of the message itself.
The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8 , ISO-8859-1 , or Shift_JIS .
The raw email message. The message has to meet the following criteria:
The raw email message. The message has to meet the following criteria:
The template to use for the email message.
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
The Amazon Resource Name (ARN) of the template.
An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.
A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.
Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.
The name of the message tag. The message tag name has to meet the following criteria:
The value of the message tag. The message tag value has to meet the following criteria:
An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.
The name of the contact list.
The name of the topic.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
A unique message ID that you receive when an email is accepted for sending.
MessageId (string) --
A unique identifier for the message that is generated when the message is accepted.
Note
It's possible for Amazon SES to accept a message without sending it. This can happen when the message that you're trying to send has an attachment contains a virus, or when you send a templated email that contains invalid personalization content, for example.
Exceptions
SESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.LimitExceededExceptionSESV2.Client.exceptions.AccountSuspendedExceptionSESV2.Client.exceptions.SendingPausedExceptionSESV2.Client.exceptions.MessageRejectedSESV2.Client.exceptions.MailFromDomainNotVerifiedExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptiontag_resource(**kwargs)¶Add one or more tags (keys and values) to a specified 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 more specific tag values. A tag value acts as a descriptor within a tag key.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.
[REQUIRED]
A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key ) and an associated tag value (Value ). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
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:
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.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.
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
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptiontest_render_email_template(**kwargs)¶Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.test_render_email_template(
TemplateName='string',
TemplateData='string'
)
[REQUIRED]
The name of the template.
[REQUIRED]
A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
dict
Response Syntax
{
'RenderedTemplate': 'string'
}
Response Structure
(dict) --
The following element is returned by the service.
RenderedTemplate (string) --
The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionuntag_resource(**kwargs)¶Remove one or more tags (keys and values) from a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.
[REQUIRED]
The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2
dict
Response Syntax
{}
Response Structure
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.ConcurrentModificationExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionupdate_configuration_set_event_destination(**kwargs)¶Update the configuration of an event destination for a configuration set.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
EventDestination={
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE'|'DELIVERY_DELAY'|'SUBSCRIPTION',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
}
)
[REQUIRED]
The name of the configuration set that contains the event destination to modify.
[REQUIRED]
The name of the event destination.
[REQUIRED]
An object that defines the event destination.
If true , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition .
If false , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition .
An email sending event type. For example, email sends, opens, and bounces are all email events.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag . To use your own email headers, choose emailHeader . To use link tags, choose linkTags .
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide .
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionupdate_contact(**kwargs)¶Updates a contact's preferences for a list. It is not necessary to specify all existing topic preferences in the TopicPreferences object, just the ones that need updating.
See also: AWS API Documentation
Request Syntax
response = client.update_contact(
ContactListName='string',
EmailAddress='string',
TopicPreferences=[
{
'TopicName': 'string',
'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
UnsubscribeAll=True|False,
AttributesData='string'
)
[REQUIRED]
The name of the contact list.
[REQUIRED]
The contact's email addres.
The contact's preference for being opted-in to or opted-out of a topic.
The contact's preference for being opted-in to or opted-out of a topic.
The name of the topic.
The contact's subscription status to a topic which is either OPT_IN or OPT_OUT .
dict
Response Syntax
{}
Response Structure
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.ConcurrentModificationExceptionupdate_contact_list(**kwargs)¶Updates contact list metadata. This operation does a complete replacement.
See also: AWS API Documentation
Request Syntax
response = client.update_contact_list(
ContactListName='string',
Topics=[
{
'TopicName': 'string',
'DisplayName': 'string',
'Description': 'string',
'DefaultSubscriptionStatus': 'OPT_IN'|'OPT_OUT'
},
],
Description='string'
)
[REQUIRED]
The name of the contact list.
An interest group, theme, or label within a list. A contact list can have multiple topics.
An interest group, theme, or label within a list. Lists can have multiple topics.
The name of the topic.
The name of the topic the contact will see.
A description of what the topic is about, which the contact will see.
The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.
dict
Response Syntax
{}
Response Structure
Exceptions
SESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.ConcurrentModificationExceptionupdate_custom_verification_email_template(**kwargs)¶Updates an existing 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
response = client.update_custom_verification_email_template(
TemplateName='string',
FromEmailAddress='string',
TemplateSubject='string',
TemplateContent='string',
SuccessRedirectionURL='string',
FailureRedirectionURL='string'
)
[REQUIRED]
The name of the custom verification email template that you want to update.
[REQUIRED]
The email address that the custom verification email is sent from.
[REQUIRED]
The subject line of the custom verification email.
[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 .
[REQUIRED]
The URL that the recipient of the verification email is sent to if his or her address is successfully verified.
[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.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.BadRequestExceptionSESV2.Client.exceptions.TooManyRequestsExceptionupdate_email_identity_policy(**kwargs)¶Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
Note
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide .
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.update_email_identity_policy(
EmailIdentity='string',
PolicyName='string',
Policy='string'
)
[REQUIRED]
The email identity.
[REQUIRED]
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
[REQUIRED]
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionupdate_email_template(**kwargs)¶Updates 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
response = client.update_email_template(
TemplateName='string',
TemplateContent={
'Subject': 'string',
'Text': 'string',
'Html': 'string'
}
)
[REQUIRED]
The name of the template.
[REQUIRED]
The content of the email template, composed of a subject line, an HTML part, and a text-only part.
The subject line of the email.
The email body that will be visible to recipients whose email clients do not display HTML.
The HTML body of the email.
dict
Response Syntax
{}
Response Structure
(dict) --
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Exceptions
SESV2.Client.exceptions.NotFoundExceptionSESV2.Client.exceptions.TooManyRequestsExceptionSESV2.Client.exceptions.BadRequestExceptionThe available paginators are: