Table of Contents
A low-level client representing Amazon Simple Email Service (SES):
import boto3
client = boto3.client('ses')
These are the available methods:
Check if an operation can be paginated.
Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.
For information about setting up rule sets, 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.clone_receipt_rule_set(
RuleSetName='string',
OriginalRuleSetName='string'
)
[REQUIRED]
The name of the rule set to create. The name must:
[REQUIRED]
The name of the rule set to clone.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example creates a receipt rule set by cloning an existing one:
response = client.clone_receipt_rule_set(
OriginalRuleSetName='RuleSetToClone',
RuleSetName='RuleSetToCreate',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, 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_configuration_set(
ConfigurationSet={
'Name': 'string'
}
)
[REQUIRED]
A data structure that contains the name of the configuration set.
The name of the configuration set. The name must meet the following requirements:
{}
Response Structure
An empty element returned on a successful request.
Creates a configuration set event destination.
Note
When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, 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_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestination={
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'send'|'reject'|'bounce'|'complaint'|'delivery'|'open'|'click'|'renderingFailure',
],
'KinesisFirehoseDestination': {
'IAMRoleARN': 'string',
'DeliveryStreamARN': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'messageTag'|'emailHeader'|'linkTag',
'DefaultDimensionValue': 'string'
},
]
},
'SNSDestination': {
'TopicARN': 'string'
}
}
)
[REQUIRED]
The name of the configuration set that the event destination should be associated with.
[REQUIRED]
An object that describes the AWS service that email sending event information will be published to.
The name of the event destination. The name must:
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false .
The type of email sending events to publish to the event destination.
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide .
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail /SendRawEmail API, choose messageTag . If you want Amazon SES to use your own email headers, choose emailHeader .
The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Creates an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_configuration_set_tracking_options(
ConfigurationSetName='string',
TrackingOptions={
'CustomRedirectDomain': 'string'
}
)
[REQUIRED]
The name of the configuration set that the tracking options should be associated with.
[REQUIRED]
A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide .
The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
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.
None
Creates a new IP address filter.
For information about setting up IP address filters, 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_receipt_filter(
Filter={
'Name': 'string',
'IpFilter': {
'Policy': 'Block'|'Allow',
'Cidr': 'string'
}
}
)
[REQUIRED]
A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.
The name of the IP address filter. The name must:
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
Indicates whether to block or allow incoming mail from the specified IP addresses.
A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317 .
{}
Response Structure
An empty element returned on a successful request.
Examples
The following example creates a new IP address filter:
response = client.create_receipt_filter(
Filter={
'IpFilter': {
'Cidr': '1.2.3.4/24',
'Policy': 'Allow',
},
'Name': 'MyFilter',
},
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a receipt rule.
For information about setting up receipt rules, 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_receipt_rule(
RuleSetName='string',
After='string',
Rule={
'Name': 'string',
'Enabled': True|False,
'TlsPolicy': 'Require'|'Optional',
'Recipients': [
'string',
],
'Actions': [
{
'S3Action': {
'TopicArn': 'string',
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'KmsKeyArn': 'string'
},
'BounceAction': {
'TopicArn': 'string',
'SmtpReplyCode': 'string',
'StatusCode': 'string',
'Message': 'string',
'Sender': 'string'
},
'WorkmailAction': {
'TopicArn': 'string',
'OrganizationArn': 'string'
},
'LambdaAction': {
'TopicArn': 'string',
'FunctionArn': 'string',
'InvocationType': 'Event'|'RequestResponse'
},
'StopAction': {
'Scope': 'RuleSet',
'TopicArn': 'string'
},
'AddHeaderAction': {
'HeaderName': 'string',
'HeaderValue': 'string'
},
'SNSAction': {
'TopicArn': 'string',
'Encoding': 'UTF-8'|'Base64'
}
},
],
'ScanEnabled': True|False
}
)
[REQUIRED]
The name of the rule set that the receipt rule will be added to.
[REQUIRED]
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
The name of the receipt rule. The name must:
If true , the receipt rule is active. The default value is false .
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require , Amazon SES will bounce emails that are not received over TLS. The default is Optional .
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The name of the Amazon S3 bucket that incoming email will be saved to.
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES will not encrypt your emails.
Warning
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The SMTP reply code, as defined by RFC 5321 .
The SMTP enhanced status code, as defined by RFC 3463 .
Human-readable text to include in the bounce message.
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 . For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information about AWS Lambda, see the AWS Lambda Developer Guide .
The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event . For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide .
Warning
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
The name of the RuleSet that is being stopped.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
Adds a header to the received email.
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
Publishes the email content within a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
If true , then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false .
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example creates a new receipt rule:
response = client.create_receipt_rule(
After='',
Rule={
'Actions': [
{
'S3Action': {
'BucketName': 'MyBucket',
'ObjectKeyPrefix': 'email',
},
},
],
'Enabled': True,
'Name': 'MyRule',
'ScanEnabled': True,
'TlsPolicy': 'Optional',
},
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates an empty receipt rule set.
For information about setting up receipt rule sets, 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_receipt_rule_set(
RuleSetName='string'
)
[REQUIRED]
The name of the rule set to create. The name must:
{}
Response Structure
An empty element returned on a successful request.
Examples
The following example creates an empty receipt rule set:
response = client.create_receipt_rule_set(
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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_template(
Template={
'TemplateName': 'string',
'SubjectPart': 'string',
'TextPart': 'string',
'HtmlPart': 'string'
}
)
[REQUIRED]
The content of the email, composed of a subject line, an HTML part, and a text-only part.
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
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.
{}
Response Structure
Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, 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_configuration_set(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the configuration set to delete.
{}
Response Structure
An empty element returned on a successful request.
Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, 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_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string'
)
[REQUIRED]
The name of the configuration set from which to delete the event destination.
[REQUIRED]
The name of the event destination to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Deletes an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide .
Note
Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_set_tracking_options(
ConfigurationSetName='string'
)
[REQUIRED]
The name of the configuration set from which you want to delete the tracking options.
{}
Response Structure
An empty element returned on a successful request.
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.
Deletes the specified identity (an email address or a domain) from the list of verified identities.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.delete_identity(
Identity='string'
)
[REQUIRED]
The identity to be removed from the list of identities for the AWS Account.
{}
Response Structure
An empty element returned on a successful request.
Examples
The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:
response = client.delete_identity(
Identity='user@example.com',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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_identity_policy(
Identity='string',
PolicyName='string'
)
[REQUIRED]
The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .
To successfully call this API, you must own the identity.
[REQUIRED]
The name of the policy to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example deletes a sending authorization policy for an identity:
response = client.delete_identity_policy(
Identity='user@example.com',
PolicyName='MyPolicy',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified IP address filter.
For information about managing IP address filters, 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_receipt_filter(
FilterName='string'
)
[REQUIRED]
The name of the IP address filter to delete.
{}
Response Structure
An empty element returned on a successful request.
Examples
The following example deletes an IP address filter:
response = client.delete_receipt_filter(
FilterName='MyFilter',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified receipt rule.
For information about managing receipt rules, 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_receipt_rule(
RuleSetName='string',
RuleName='string'
)
[REQUIRED]
The name of the receipt rule set that contains the receipt rule to delete.
[REQUIRED]
The name of the receipt rule to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example deletes a receipt rule:
response = client.delete_receipt_rule(
RuleName='MyRule',
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes the specified receipt rule set and all of the receipt rules it contains.
Note
The currently active rule set cannot be deleted.
For information about managing receipt rule sets, 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_receipt_rule_set(
RuleSetName='string'
)
[REQUIRED]
The name of the receipt rule set to delete.
{}
Response Structure
An empty element returned on a successful request.
Examples
The following example deletes a receipt rule set:
response = client.delete_receipt_rule_set(
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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_template(
TemplateName='string'
)
[REQUIRED]
The name of the template to be deleted.
{}
Response Structure
Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.
See also: AWS API Documentation
Request Syntax
response = client.delete_verified_email_address(
EmailAddress='string'
)
[REQUIRED]
An email address to be removed from the list of verified addresses.
Examples
The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:
response = client.delete_verified_email_address(
EmailAddress='user@example.com',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Returns the metadata and receipt rules for the receipt rule set that is currently active.
For information about setting up receipt rule sets, 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.describe_active_receipt_rule_set()
{
'Metadata': {
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
},
'Rules': [
{
'Name': 'string',
'Enabled': True|False,
'TlsPolicy': 'Require'|'Optional',
'Recipients': [
'string',
],
'Actions': [
{
'S3Action': {
'TopicArn': 'string',
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'KmsKeyArn': 'string'
},
'BounceAction': {
'TopicArn': 'string',
'SmtpReplyCode': 'string',
'StatusCode': 'string',
'Message': 'string',
'Sender': 'string'
},
'WorkmailAction': {
'TopicArn': 'string',
'OrganizationArn': 'string'
},
'LambdaAction': {
'TopicArn': 'string',
'FunctionArn': 'string',
'InvocationType': 'Event'|'RequestResponse'
},
'StopAction': {
'Scope': 'RuleSet',
'TopicArn': 'string'
},
'AddHeaderAction': {
'HeaderName': 'string',
'HeaderValue': 'string'
},
'SNSAction': {
'TopicArn': 'string',
'Encoding': 'UTF-8'|'Base64'
}
},
],
'ScanEnabled': True|False
},
]
}
Response Structure
Represents the metadata and receipt rules for the receipt rule set that is currently active.
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.
The name of the receipt rule set. The name must:
The date and time the receipt rule set was created.
The receipt rules that belong to the active rule set.
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
The name of the receipt rule. The name must:
If true , the receipt rule is active. The default value is false .
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require , Amazon SES will bounce emails that are not received over TLS. The default is Optional .
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The name of the Amazon S3 bucket that incoming email will be saved to.
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES will not encrypt your emails.
Warning
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The SMTP reply code, as defined by RFC 5321 .
The SMTP enhanced status code, as defined by RFC 3463 .
Human-readable text to include in the bounce message.
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 . For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information about AWS Lambda, see the AWS Lambda Developer Guide .
The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event . For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide .
Warning
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
The name of the RuleSet that is being stopped.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
Adds a header to the received email.
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
Publishes the email content within a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
If true , then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false .
Examples
The following example returns the metadata and receipt rules for the receipt rule set that is currently active:
response = client.describe_active_receipt_rule_set(
)
print(response)
Expected Output:
{
'Metadata': {
'CreatedTimestamp': datetime(2016, 7, 15, 16, 25, 59, 4, 197, 0),
'Name': 'default-rule-set',
},
'Rules': [
{
'Actions': [
{
'S3Action': {
'BucketName': 'MyBucket',
'ObjectKeyPrefix': 'email',
},
},
],
'Enabled': True,
'Name': 'MyRule',
'ScanEnabled': True,
'TlsPolicy': 'Optional',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Returns the details of the specified configuration set. For information about using configuration sets, 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.describe_configuration_set(
ConfigurationSetName='string',
ConfigurationSetAttributeNames=[
'eventDestinations'|'trackingOptions'|'reputationOptions',
]
)
[REQUIRED]
The name of the configuration set to describe.
A list of configuration set attributes to return.
dict
Response Syntax
{
'ConfigurationSet': {
'Name': 'string'
},
'EventDestinations': [
{
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'send'|'reject'|'bounce'|'complaint'|'delivery'|'open'|'click'|'renderingFailure',
],
'KinesisFirehoseDestination': {
'IAMRoleARN': 'string',
'DeliveryStreamARN': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'messageTag'|'emailHeader'|'linkTag',
'DefaultDimensionValue': 'string'
},
]
},
'SNSDestination': {
'TopicARN': 'string'
}
},
],
'TrackingOptions': {
'CustomRedirectDomain': 'string'
},
'ReputationOptions': {
'SendingEnabled': True|False,
'ReputationMetricsEnabled': True|False,
'LastFreshStart': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
ConfigurationSet (dict) --
The configuration set object associated with the specified configuration set.
Name (string) --
The name of the configuration set. The name must meet the following requirements:
EventDestinations (list) --
A list of event destinations associated with the configuration set.
(dict) --
Contains information about the event destination that the specified email sending events will be published to.
Note
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide .
Name (string) --
The name of the event destination. The name must:
Enabled (boolean) --
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false .
MatchingEventTypes (list) --
The type of email sending events to publish to the event destination.
KinesisFirehoseDestination (dict) --
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
IAMRoleARN (string) --
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
DeliveryStreamARN (string) --
The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
CloudWatchDestination (dict) --
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
DimensionConfigurations (list) --
A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
(dict) --
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide .
DimensionName (string) --
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:
DimensionValueSource (string) --
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail /SendRawEmail API, choose messageTag . If you want Amazon SES to use your own email headers, choose emailHeader .
DefaultDimensionValue (string) --
The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:
SNSDestination (dict) --
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
TopicARN (string) --
The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
TrackingOptions (dict) --
The name of the custom open and click tracking domain associated with the configuration set.
CustomRedirectDomain (string) --
The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
ReputationOptions (dict) --
An object that represents the reputation settings for the configuration set.
SendingEnabled (boolean) --
Describes whether email sending is enabled or disabled for the configuration set. If the value is true , then Amazon SES will send emails that use the configuration set. If the value is false , Amazon SES will not send emails that use the configuration set. The default value is true . You can change this setting using UpdateConfigurationSetSendingEnabled .
ReputationMetricsEnabled (boolean) --
Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
If the value is true , reputation metrics are published. If the value is false , reputation metrics are not published. The default value is false .
LastFreshStart (datetime) --
The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start .
When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset.
If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null .
Returns the details of the specified receipt rule.
For information about setting up receipt rules, 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.describe_receipt_rule(
RuleSetName='string',
RuleName='string'
)
[REQUIRED]
The name of the receipt rule set that the receipt rule belongs to.
[REQUIRED]
The name of the receipt rule.
dict
Response Syntax
{
'Rule': {
'Name': 'string',
'Enabled': True|False,
'TlsPolicy': 'Require'|'Optional',
'Recipients': [
'string',
],
'Actions': [
{
'S3Action': {
'TopicArn': 'string',
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'KmsKeyArn': 'string'
},
'BounceAction': {
'TopicArn': 'string',
'SmtpReplyCode': 'string',
'StatusCode': 'string',
'Message': 'string',
'Sender': 'string'
},
'WorkmailAction': {
'TopicArn': 'string',
'OrganizationArn': 'string'
},
'LambdaAction': {
'TopicArn': 'string',
'FunctionArn': 'string',
'InvocationType': 'Event'|'RequestResponse'
},
'StopAction': {
'Scope': 'RuleSet',
'TopicArn': 'string'
},
'AddHeaderAction': {
'HeaderName': 'string',
'HeaderValue': 'string'
},
'SNSAction': {
'TopicArn': 'string',
'Encoding': 'UTF-8'|'Base64'
}
},
],
'ScanEnabled': True|False
}
}
Response Structure
(dict) --
Represents the details of a receipt rule.
Rule (dict) --
A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.
Name (string) --
The name of the receipt rule. The name must:
Enabled (boolean) --
If true , the receipt rule is active. The default value is false .
TlsPolicy (string) --
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require , Amazon SES will bounce emails that are not received over TLS. The default is Optional .
Recipients (list) --
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
Actions (list) --
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
(dict) --
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
S3Action (dict) --
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
TopicArn (string) --
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
BucketName (string) --
The name of the Amazon S3 bucket that incoming email will be saved to.
ObjectKeyPrefix (string) --
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
KmsKeyArn (string) --
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES will not encrypt your emails.
Warning
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .
BounceAction (dict) --
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
SmtpReplyCode (string) --
The SMTP reply code, as defined by RFC 5321 .
StatusCode (string) --
The SMTP enhanced status code, as defined by RFC 3463 .
Message (string) --
Human-readable text to include in the bounce message.
Sender (string) --
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
WorkmailAction (dict) --
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
OrganizationArn (string) --
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 . For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .
LambdaAction (dict) --
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
FunctionArn (string) --
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information about AWS Lambda, see the AWS Lambda Developer Guide .
InvocationType (string) --
The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event . For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide .
Warning
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
StopAction (dict) --
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
Scope (string) --
The name of the RuleSet that is being stopped.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
AddHeaderAction (dict) --
Adds a header to the received email.
HeaderName (string) --
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
HeaderValue (string) --
Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
SNSAction (dict) --
Publishes the email content within a notification to Amazon SNS.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
Encoding (string) --
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
ScanEnabled (boolean) --
If true , then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false .
Examples
The following example returns the details of a receipt rule:
response = client.describe_receipt_rule(
RuleName='MyRule',
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'Rule': {
'Actions': [
{
'S3Action': {
'BucketName': 'MyBucket',
'ObjectKeyPrefix': 'email',
},
},
],
'Enabled': True,
'Name': 'MyRule',
'ScanEnabled': True,
'TlsPolicy': 'Optional',
},
'ResponseMetadata': {
'...': '...',
},
}
Returns the details of the specified receipt rule set.
For information about managing receipt rule sets, 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.describe_receipt_rule_set(
RuleSetName='string'
)
[REQUIRED]
The name of the receipt rule set to describe.
{
'Metadata': {
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
},
'Rules': [
{
'Name': 'string',
'Enabled': True|False,
'TlsPolicy': 'Require'|'Optional',
'Recipients': [
'string',
],
'Actions': [
{
'S3Action': {
'TopicArn': 'string',
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'KmsKeyArn': 'string'
},
'BounceAction': {
'TopicArn': 'string',
'SmtpReplyCode': 'string',
'StatusCode': 'string',
'Message': 'string',
'Sender': 'string'
},
'WorkmailAction': {
'TopicArn': 'string',
'OrganizationArn': 'string'
},
'LambdaAction': {
'TopicArn': 'string',
'FunctionArn': 'string',
'InvocationType': 'Event'|'RequestResponse'
},
'StopAction': {
'Scope': 'RuleSet',
'TopicArn': 'string'
},
'AddHeaderAction': {
'HeaderName': 'string',
'HeaderValue': 'string'
},
'SNSAction': {
'TopicArn': 'string',
'Encoding': 'UTF-8'|'Base64'
}
},
],
'ScanEnabled': True|False
},
]
}
Response Structure
Represents the details of the specified receipt rule set.
The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.
The name of the receipt rule set. The name must:
The date and time the receipt rule set was created.
A list of the receipt rules that belong to the specified receipt rule set.
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
The name of the receipt rule. The name must:
If true , the receipt rule is active. The default value is false .
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require , Amazon SES will bounce emails that are not received over TLS. The default is Optional .
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The name of the Amazon S3 bucket that incoming email will be saved to.
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES will not encrypt your emails.
Warning
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The SMTP reply code, as defined by RFC 5321 .
The SMTP enhanced status code, as defined by RFC 3463 .
Human-readable text to include in the bounce message.
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 . For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information about AWS Lambda, see the AWS Lambda Developer Guide .
The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event . For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide .
Warning
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
The name of the RuleSet that is being stopped.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
Adds a header to the received email.
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
Publishes the email content within a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
If true , then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false .
Examples
The following example returns the metadata and receipt rules of a receipt rule set:
response = client.describe_receipt_rule_set(
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'Metadata': {
'CreatedTimestamp': datetime(2016, 7, 15, 16, 25, 59, 4, 197, 0),
'Name': 'MyRuleSet',
},
'Rules': [
{
'Actions': [
{
'S3Action': {
'BucketName': 'MyBucket',
'ObjectKeyPrefix': 'email',
},
},
],
'Enabled': True,
'Name': 'MyRule',
'ScanEnabled': True,
'TlsPolicy': 'Optional',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Generate a presigned url given a client, its method, and arguments
The presigned url
Returns the email sending status of the Amazon SES account for the current region.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.get_account_sending_enabled()
{
'Enabled': True|False
}
Response Structure
Represents a request to return the email sending status for your Amazon SES account in the current AWS Region.
Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.
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 content of the custom verification email template.
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.
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_identity_dkim_attributes(
Identities=[
'string',
]
)
[REQUIRED]
A list of one or more verified identities - email addresses, domains, or both.
{
'DkimAttributes': {
'string': {
'DkimEnabled': True|False,
'DkimVerificationStatus': 'Pending'|'Success'|'Failed'|'TemporaryFailure'|'NotStarted',
'DkimTokens': [
'string',
]
}
}
}
Response Structure
Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.
The DKIM attributes for an email address or a domain.
Represents the DKIM attributes of a verified email address or a domain.
True if DKIM signing is enabled for email sent from the identity; false otherwise. The default value is true.
Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)
A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide .
Examples
The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:
response = client.get_identity_dkim_attributes(
Identities=[
'example.com',
'user@example.com',
],
)
print(response)
Expected Output:
{
'DkimAttributes': {
'example.com': {
'DkimEnabled': True,
'DkimTokens': [
'EXAMPLEjcs5xoyqytjsotsijas7236gr',
'EXAMPLEjr76cvoc6mysspnioorxsn6ep',
'EXAMPLEkbmkqkhlm2lyz77ppkulerm4k',
],
'DkimVerificationStatus': 'Success',
},
'user@example.com': {
'DkimEnabled': False,
'DkimVerificationStatus': 'NotStarted',
},
},
'ResponseMetadata': {
'...': '...',
},
}
Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).
This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.
See also: AWS API Documentation
Request Syntax
response = client.get_identity_mail_from_domain_attributes(
Identities=[
'string',
]
)
[REQUIRED]
A list of one or more identities.
{
'MailFromDomainAttributes': {
'string': {
'MailFromDomain': 'string',
'MailFromDomainStatus': 'Pending'|'Success'|'Failed'|'TemporaryFailure',
'BehaviorOnMXFailure': 'UseDefaultValue'|'RejectMessage'
}
}
}
Response Structure
Represents the custom MAIL FROM attributes for a list of identities.
A map of identities to custom MAIL FROM attributes.
Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).
The custom MAIL FROM domain that the identity is configured to use.
The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success , Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure .
The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.
The custom MAIL FROM setup states that result in this behavior are Pending , Failed , and TemporaryFailure .
Examples
The following example returns the custom MAIL FROM attributes for an identity:
response = client.get_identity_mail_from_domain_attributes(
Identities=[
'example.com',
],
)
print(response)
Expected Output:
{
'MailFromDomainAttributes': {
'example.com': {
'BehaviorOnMXFailure': 'UseDefaultValue',
'MailFromDomain': 'bounces.example.com',
'MailFromDomainStatus': 'Success',
},
},
'ResponseMetadata': {
'...': '...',
},
}
Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.
This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_identity_notification_attributes(
Identities=[
'string',
]
)
[REQUIRED]
A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .
{
'NotificationAttributes': {
'string': {
'BounceTopic': 'string',
'ComplaintTopic': 'string',
'DeliveryTopic': 'string',
'ForwardingEnabled': True|False,
'HeadersInBounceNotificationsEnabled': True|False,
'HeadersInComplaintNotificationsEnabled': True|False,
'HeadersInDeliveryNotificationsEnabled': True|False
}
}
}
Response Structure
Represents the notification attributes for a list of identities.
A map of Identity to IdentityNotificationAttributes.
Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.
The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.
Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce . A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint . A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.
Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery . A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.
Examples
The following example returns the notification attributes for an identity:
response = client.get_identity_notification_attributes(
Identities=[
'example.com',
],
)
print(response)
Expected Output:
{
'NotificationAttributes': {
'example.com': {
'BounceTopic': 'arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic',
'ForwardingEnabled': True,
'HeadersInBounceNotificationsEnabled': False,
'HeadersInComplaintNotificationsEnabled': False,
'HeadersInDeliveryNotificationsEnabled': False,
},
},
'ResponseMetadata': {
'...': '...',
},
}
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_identity_policies(
Identity='string',
PolicyNames=[
'string',
]
)
[REQUIRED]
The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .
To successfully call this API, you must own the identity.
[REQUIRED]
A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies .
dict
Response Syntax
{
'Policies': {
'string': 'string'
}
}
Response Structure
(dict) --
Represents the requested sending authorization policies.
Policies (dict) --
A map of policy names to policies.
Examples
The following example returns a sending authorization policy for an identity:
response = client.get_identity_policies(
Identity='example.com',
PolicyNames=[
'MyPolicy',
],
)
print(response)
Expected Output:
{
'Policies': {
'MyPolicy': '{"Version":"2008-10-17","Statement":[{"Sid":"stmt1469123904194","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":["ses:SendEmail","ses:SendRawEmail"],"Resource":"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com"}]}',
},
'ResponseMetadata': {
'...': '...',
},
}
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
See also: AWS API Documentation
Request Syntax
response = client.get_identity_verification_attributes(
Identities=[
'string',
]
)
[REQUIRED]
A list of identities.
{
'VerificationAttributes': {
'string': {
'VerificationStatus': 'Pending'|'Success'|'Failed'|'TemporaryFailure'|'NotStarted',
'VerificationToken': 'string'
}
}
}
Response Structure
The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.
A map of Identities to IdentityVerificationAttributes objects.
Represents the verification attributes of a single identity.
The verification status of the identity: "Pending", "Success", "Failed", or "TemporaryFailure".
The verification token for a domain identity. Null for email address identities.
Examples
The following example returns the verification status and the verification token for a domain identity:
response = client.get_identity_verification_attributes(
Identities=[
'example.com',
],
)
print(response)
Expected Output:
{
'VerificationAttributes': {
'example.com': {
'VerificationStatus': 'Success',
'VerificationToken': 'EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY=',
},
},
'ResponseMetadata': {
'...': '...',
},
}
Create a paginator for an operation.
Provides the sending limits for the Amazon SES account.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.get_send_quota()
{
'Max24HourSend': 123.0,
'MaxSendRate': 123.0,
'SentLast24Hours': 123.0
}
Response Structure
Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.
The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.
The maximum number of emails that Amazon SES can accept from the user's account per second.
Note
The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.
The number of emails sent during the previous 24 hours.
Examples
The following example returns the Amazon SES sending limits for an AWS account:
response = client.get_send_quota(
)
print(response)
Expected Output:
{
'Max24HourSend': 200,
'MaxSendRate': 1,
'SentLast24Hours': 1,
'ResponseMetadata': {
'...': '...',
},
}
Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.get_send_statistics()
{
'SendDataPoints': [
{
'Timestamp': datetime(2015, 1, 1),
'DeliveryAttempts': 123,
'Bounces': 123,
'Complaints': 123,
'Rejects': 123
},
]
}
Response Structure
Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.
A list of data points, each of which represents 15 minutes of activity.
Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.
Time of the data point.
Number of emails that have been sent.
Number of emails that have bounced.
Number of unwanted emails that were rejected by recipients.
Number of emails rejected by Amazon SES.
Examples
The following example returns Amazon SES sending statistics:
response = client.get_send_statistics(
)
print(response)
Expected Output:
{
'SendDataPoints': [
{
'Bounces': 0,
'Complaints': 0,
'DeliveryAttempts': 5,
'Rejects': 0,
'Timestamp': datetime(2016, 7, 13, 22, 43, 0, 2, 195, 0),
},
{
'Bounces': 0,
'Complaints': 0,
'DeliveryAttempts': 3,
'Rejects': 0,
'Timestamp': datetime(2016, 7, 13, 23, 13, 0, 2, 195, 0),
},
{
'Bounces': 0,
'Complaints': 0,
'DeliveryAttempts': 1,
'Rejects': 0,
'Timestamp': datetime(2016, 7, 13, 21, 13, 0, 2, 195, 0),
},
],
'ResponseMetadata': {
'...': '...',
},
}
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_template(
TemplateName='string'
)
[REQUIRED]
The name of the template you want to retrieve.
{
'Template': {
'TemplateName': 'string',
'SubjectPart': 'string',
'TextPart': 'string',
'HtmlPart': 'string'
}
}
Response Structure
The content of the email, composed of a subject line, an HTML part, and a text-only part.
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
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.
Returns an object that can wait for some condition.
Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.
See also: AWS API Documentation
Request Syntax
response = client.list_configuration_sets(
NextToken='string',
MaxItems=123
)
dict
Response Syntax
{
'ConfigurationSets': [
{
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
ConfigurationSets (list) --
A list of configuration sets.
(dict) --
The name of the configuration set.
Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide .
Name (string) --
The name of the configuration set. The name must meet the following requirements:
NextToken (string) --
A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets .
Lists the existing custom verification email templates for your account in the current AWS 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',
MaxResults=123
)
dict
Response Syntax
{
'CustomVerificationEmailTemplates': [
{
'TemplateName': 'string',
'FromEmailAddress': 'string',
'TemplateSubject': 'string',
'SuccessRedirectionURL': 'string',
'FailureRedirectionURL': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
A paginated list of custom verification email templates.
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 ListTemplates to retrieve the next 50 custom verification email templates.
Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.list_identities(
IdentityType='EmailAddress'|'Domain',
NextToken='string',
MaxItems=123
)
dict
Response Syntax
{
'Identities': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.
Identities (list) --
A list of identities.
NextToken (string) --
The token used for pagination.
Examples
The following example lists the email address identities that have been submitted for verification with Amazon SES:
response = client.list_identities(
IdentityType='EmailAddress',
MaxItems=123,
NextToken='',
)
print(response)
Expected Output:
{
'Identities': [
'user@example.com',
],
'NextToken': '',
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies .
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.list_identity_policies(
Identity='string'
)
[REQUIRED]
The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .
To successfully call this API, you must own the identity.
{
'PolicyNames': [
'string',
]
}
Response Structure
A list of names of sending authorization policies that apply to an identity.
A list of names of policies that apply to the specified identity.
Examples
The following example returns a list of sending authorization policies that are attached to an identity:
response = client.list_identity_policies(
Identity='example.com',
)
print(response)
Expected Output:
{
'PolicyNames': [
'MyPolicy',
],
'ResponseMetadata': {
'...': '...',
},
}
Lists the IP address filters associated with your AWS account in the current AWS Region.
For information about managing IP address filters, 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.list_receipt_filters()
{
'Filters': [
{
'Name': 'string',
'IpFilter': {
'Policy': 'Block'|'Allow',
'Cidr': 'string'
}
},
]
}
Response Structure
A list of IP address filters that exist under your AWS account.
A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.
A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.
For information about setting up IP address filters, see the Amazon SES Developer Guide .
The name of the IP address filter. The name must:
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
Indicates whether to block or allow incoming mail from the specified IP addresses.
A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317 .
Examples
The following example lists the IP address filters that are associated with an AWS account:
response = client.list_receipt_filters(
)
print(response)
Expected Output:
{
'Filters': [
{
'IpFilter': {
'Cidr': '1.2.3.4/24',
'Policy': 'Block',
},
'Name': 'MyFilter',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.
For information about managing receipt rule sets, 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.list_receipt_rule_sets(
NextToken='string'
)
{
'RuleSets': [
{
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
A list of receipt rule sets that exist under your AWS account.
The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.
Information about a receipt rule set.
A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.
For information about setting up receipt rule sets, see the Amazon SES Developer Guide .
The name of the receipt rule set. The name must:
The date and time the receipt rule set was created.
A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.
Examples
The following example lists the receipt rule sets that exist under an AWS account:
response = client.list_receipt_rule_sets(
NextToken='',
)
print(response)
Expected Output:
{
'NextToken': '',
'RuleSets': [
{
'CreatedTimestamp': datetime(2016, 7, 15, 16, 25, 59, 4, 197, 0),
'Name': 'MyRuleSet',
},
],
'ResponseMetadata': {
'...': '...',
},
}
Lists the email templates present in your Amazon SES account in the current AWS Region.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.list_templates(
NextToken='string',
MaxItems=123
)
dict
Response Syntax
{
'TemplatesMetadata': [
{
'Name': 'string',
'CreatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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.
Name (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 call to ListTemplates to retrieve the next 50 email templates.
Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.
See also: AWS API Documentation
Request Syntax
response = client.list_verified_email_addresses()
{
'VerifiedEmailAddresses': [
'string',
]
}
Response Structure
A list of email addresses that you have verified with Amazon SES under your AWS account.
A list of email addresses that have been verified.
Examples
The following example lists all email addresses that have been submitted for verification with Amazon SES:
response = client.list_verified_email_addresses(
)
print(response)
Expected Output:
{
'VerifiedEmailAddresses': [
'user1@example.com',
'user2@example.com',
],
'ResponseMetadata': {
'...': '...',
},
}
Adds or updates a sending authorization policy for the specified 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.put_identity_policy(
Identity='string',
PolicyName='string',
Policy='string'
)
[REQUIRED]
The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .
To successfully call this API, you must own the 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 empty element returned on a successful request.
Examples
The following example adds a sending authorization policy to an identity:
response = client.put_identity_policy(
Identity='example.com',
Policy='{"Version":"2008-10-17","Statement":[{"Sid":"stmt1469123904194","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":["ses:SendEmail","ses:SendRawEmail"],"Resource":"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com"}]}',
PolicyName='MyPolicy',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Reorders the receipt rules within a receipt rule set.
Note
All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.
For information about managing receipt rule sets, 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.reorder_receipt_rule_set(
RuleSetName='string',
RuleNames=[
'string',
]
)
[REQUIRED]
The name of the receipt rule set to reorder.
[REQUIRED]
A list of the specified receipt rule set's receipt rules in the order that you want to put them.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example reorders the receipt rules within a receipt rule set:
response = client.reorder_receipt_rule_set(
RuleNames=[
'MyRule',
'MyOtherRule',
],
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.
Note
You cannot use this API to send generic bounces for mail that was not received by Amazon SES.
For information about receiving email through Amazon SES, 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.send_bounce(
OriginalMessageId='string',
BounceSender='string',
Explanation='string',
MessageDsn={
'ReportingMta': 'string',
'ArrivalDate': datetime(2015, 1, 1),
'ExtensionFields': [
{
'Name': 'string',
'Value': 'string'
},
]
},
BouncedRecipientInfoList=[
{
'Recipient': 'string',
'RecipientArn': 'string',
'BounceType': 'DoesNotExist'|'MessageTooLarge'|'ExceededQuota'|'ContentRejected'|'Undefined'|'TemporaryFailure',
'RecipientDsnFields': {
'FinalRecipient': 'string',
'Action': 'failed'|'delayed'|'delivered'|'relayed'|'expanded',
'RemoteMta': 'string',
'Status': 'string',
'DiagnosticCode': 'string',
'LastAttemptDate': datetime(2015, 1, 1),
'ExtensionFields': [
{
'Name': 'string',
'Value': 'string'
},
]
}
},
],
BounceSenderArn='string'
)
[REQUIRED]
The message ID of the message to be bounced.
[REQUIRED]
The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.
Message-related DSN fields. If not specified, Amazon SES will choose the values.
The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name ). The default value is dns; inbound-smtp.[region].amazonaws.com .
When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.
Additional X-headers to include in the DSN.
Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
[REQUIRED]
A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.
Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .
The email address of the recipient of the bounced email.
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 receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide .
The reason for the bounce. You must provide either this parameter or RecipientDsnFields .
Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType . You must provide either this parameter or BounceType .
The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.
Note
Do not prepend the FinalRecipient email address with rfc 822; , as described in RFC 3798 .
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464 .
The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name ). This parameter typically applies only to propagating synchronous bounces.
The status code that indicates what went wrong. This is required by RFC 3464 .
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
The time the final delivery attempt was made, in RFC 822 date-time format.
Additional X-headers to include in the DSN.
Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.
For information about receiving email through Amazon SES, see the Amazon SES Developer Guide .
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
The value of the header to add. Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Represents a unique message ID.
MessageId (string) --
The message ID of the bounce message.
Composes an email message to multiple destinations. The message body is created using an email template.
In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:
See also: AWS API Documentation
Request Syntax
response = client.send_bulk_templated_email(
Source='string',
SourceArn='string',
ReplyToAddresses=[
'string',
],
ReturnPath='string',
ReturnPathArn='string',
ConfigurationSetName='string',
DefaultTags=[
{
'Name': 'string',
'Value': 'string'
},
],
Template='string',
TemplateArn='string',
DefaultTemplateData='string',
Destinations=[
{
'Destination': {
'ToAddresses': [
'string',
],
'CcAddresses': [
'string',
],
'BccAddresses': [
'string',
]
},
'ReplacementTags': [
{
'Name': 'string',
'Value': 'string'
},
],
'ReplacementTemplateData': 'string'
},
]
)
[REQUIRED]
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide .
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide .
Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 . For this reason, the local part of a source 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 . The sender name (also known as the friendly name ) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047 . MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= .
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 send for the email address specified in the Source 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 send from user@example.com , then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the Source to be user@example.com .
For more information about sending authorization, see the Amazon SES Developer Guide .
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive 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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the ReturnPath 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 to a destination using SendBulkTemplatedEmail .
Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
The name of the tag. The name must:
The value of the tag. The value must:
[REQUIRED]
The template to use when sending this email.
A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.
The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.
[REQUIRED]
One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.
An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.
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 .
The To: field(s) of the message.
The CC: field(s) of the message.
The BCC: field(s) of the message.
A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail . 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 can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
The name of the tag. The name must:
The value of the tag. The value must:
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
{
'Status': [
{
'Status': 'Success'|'MessageRejected'|'MailFromDomainNotVerified'|'ConfigurationSetDoesNotExist'|'TemplateDoesNotExist'|'AccountSuspended'|'AccountThrottled'|'AccountDailyQuotaExceeded'|'InvalidSendingPoolName'|'AccountSendingPaused'|'ConfigurationSetSendingPaused'|'InvalidParameterValue'|'TransientFailure'|'Failed',
'Error': 'string',
'MessageId': 'string'
},
]
}
Response Structure
(dict) --
Status (list) --
The unique message identifier returned from the SendBulkTemplatedEmail action.
(dict) --
An object that contains the response from the SendBulkTemplatedEmail operation.
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.
Adds an email address to the list of identities for your Amazon SES account in the current AWS 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 response received when attempting to send the custom verification email.
MessageId (string) --
The unique message identifier returned from the SendCustomVerificationEmail operation.
Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements:
Warning
For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota ). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.send_email(
Source='string',
Destination={
'ToAddresses': [
'string',
],
'CcAddresses': [
'string',
],
'BccAddresses': [
'string',
]
},
Message={
'Subject': {
'Data': 'string',
'Charset': 'string'
},
'Body': {
'Text': {
'Data': 'string',
'Charset': 'string'
},
'Html': {
'Data': 'string',
'Charset': 'string'
}
}
},
ReplyToAddresses=[
'string',
],
ReturnPath='string',
SourceArn='string',
ReturnPathArn='string',
Tags=[
{
'Name': 'string',
'Value': 'string'
},
],
ConfigurationSetName='string'
)
[REQUIRED]
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide .
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide .
Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 . For this reason, the local part of a source 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 . The sender name (also known as the friendly name ) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047 . MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= .
[REQUIRED]
The destination for this email, composed of To:, CC:, and BCC: fields.
The To: field(s) of the message.
The CC: field(s) of the message.
The BCC: field(s) of the message.
[REQUIRED]
The message to be sent.
The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
The textual data of the content.
The character set of the content.
The message body.
The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
The textual data of the content.
The character set of the content.
The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
The textual data of the content.
The character set of the content.
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive 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 send for the email address specified in the Source 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 send from user@example.com , then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the Source to be user@example.com .
For more information about sending authorization, see the Amazon SES Developer Guide .
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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the ReturnPath 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 SendEmail . 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 can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
The name of the tag. The name must:
The value of the tag. The value must:
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Represents a unique message ID.
MessageId (string) --
The unique message identifier returned from the SendEmail action.
Examples
The following example sends a formatted email:
response = client.send_email(
Destination={
'BccAddresses': [
],
'CcAddresses': [
'recipient3@example.com',
],
'ToAddresses': [
'recipient1@example.com',
'recipient2@example.com',
],
},
Message={
'Body': {
'Html': {
'Charset': 'UTF-8',
'Data': 'This message body contains HTML formatting. It can, for example, contain links like this one: <a class="ulink" href="http://docs.aws.amazon.com/ses/latest/DeveloperGuide" target="_blank">Amazon SES Developer Guide</a>.',
},
'Text': {
'Charset': 'UTF-8',
'Data': 'This is the message body in text format.',
},
},
'Subject': {
'Charset': 'UTF-8',
'Data': 'Test email',
},
},
ReplyToAddresses=[
],
ReturnPath='',
ReturnPathArn='',
Source='sender@example.com',
SourceArn='',
)
print(response)
Expected Output:
{
'MessageId': 'EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000',
'ResponseMetadata': {
'...': '...',
},
}
Composes an email message and immediately queues it for sending.
This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.
The SendRawEmail operation has the following requirements:
Additionally, keep the following considerations in mind when using the SendRawEmail operation:
Warning
Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.
For most common sending authorization scenarios, we recommend that you specify the SourceIdentityArn parameter and not the FromIdentityArn or ReturnPathIdentityArn parameters. If you only specify the SourceIdentityArn parameter, Amazon SES will set the From and Return Path addresses to the identity specified in SourceIdentityArn . For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.send_raw_email(
Source='string',
Destinations=[
'string',
],
RawMessage={
'Data': b'bytes'
},
FromArn='string',
SourceArn='string',
ReturnPathArn='string',
Tags=[
{
'Name': 'string',
'Value': 'string'
},
],
ConfigurationSetName='string'
)
The identity's email address. If you do not provide a value for this parameter, you must specify a "From" address in the raw text of the message. (You can also specify both.)
Note
Amazon SES does not support the SMTPUTF8 extension, as described in`RFC6531 <https://tools.ietf.org/html/rfc6531>`__ . For this reason, the local part of a source 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 . The sender name (also known as the friendly name ) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047 . MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= .
If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
[REQUIRED]
The raw email message itself. The message has to meet the following criteria:
The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.
The To:, CC:, and BCC: headers in the raw message can contain a group list.
If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the "Source," "From," and "Return-Path" addresses. For more information, see the documentation for SendRawEmail .
Warning
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For more information, go to the Amazon SES Developer Guide .
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 specify a particular "From" address in the header of the raw email.
Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.
Note
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide .
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 send for the email address specified in the Source 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 send from user@example.com , then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the Source to be user@example.com .
Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.
Note
For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide .
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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the ReturnPath to be feedback@example.com .
Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.
Note
For information about when to use this parameter, see the description of SendRawEmail in this guide, or 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 SendRawEmail . 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 can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
The name of the tag. The name must:
The value of the tag. The value must:
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Represents a unique message ID.
MessageId (string) --
The unique message identifier returned from the SendRawEmail action.
Examples
The following example sends an email with an attachment:
response = client.send_raw_email(
Destinations=[
],
FromArn='',
RawMessage={
'Data': 'From: sender@example.com\nTo: recipient@example.com\nSubject: Test email (contains an attachment)\nMIME-Version: 1.0\nContent-type: Multipart/Mixed; boundary="NextPart"\n\n--NextPart\nContent-Type: text/plain\n\nThis is the message body.\n\n--NextPart\nContent-Type: text/plain;\nContent-Disposition: attachment; filename="attachment.txt"\n\nThis is the text in the attachment.\n\n--NextPart--',
},
ReturnPathArn='',
Source='',
SourceArn='',
)
print(response)
Expected Output:
{
'MessageId': 'EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000',
'ResponseMetadata': {
'...': '...',
},
}
Composes an email message using an email template and immediately queues it for sending.
In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements:
Warning
If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.
For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.send_templated_email(
Source='string',
Destination={
'ToAddresses': [
'string',
],
'CcAddresses': [
'string',
],
'BccAddresses': [
'string',
]
},
ReplyToAddresses=[
'string',
],
ReturnPath='string',
SourceArn='string',
ReturnPathArn='string',
Tags=[
{
'Name': 'string',
'Value': 'string'
},
],
ConfigurationSetName='string',
Template='string',
TemplateArn='string',
TemplateData='string'
)
[REQUIRED]
The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide .
If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide .
Note
Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 . For this reason, the local part of a source 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 . The sender name (also known as the friendly name ) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in`RFC 2047 <https://tools.ietf.org/html/rfc2047>`__ . MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= .
[REQUIRED]
The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.
The To: field(s) of the message.
The CC: field(s) of the message.
The BCC: field(s) of the message.
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive 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 send for the email address specified in the Source 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 send from user@example.com , then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the Source to be user@example.com .
For more information about sending authorization, see the Amazon SES Developer Guide .
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 ReturnPath 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 ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com , and the ReturnPath 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 SendTemplatedEmail . 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 can provide to SendEmail or SendRawEmail to apply to an email.
Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
The name of the tag. The name must:
The value of the tag. The value must:
[REQUIRED]
The template to use when sending this email.
[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
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The unique message identifier returned from the SendTemplatedEmail action.
Sets the specified receipt rule set as the active receipt rule set.
Note
To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.
For information about managing receipt rule sets, 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.set_active_receipt_rule_set(
RuleSetName='string'
)
{}
Response Structure
An empty element returned on a successful request.
Examples
The following example sets the active receipt rule set:
response = client.set_active_receipt_rule_set(
RuleSetName='RuleSetToActivate',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Enables or disables Easy DKIM signing of email sent from an identity:
For email addresses (for example, user@example.com ), you can only enable Easy DKIM signing if the corresponding domain (in this case, example.com ) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim operation.
You can execute this operation no more than once per second.
For more information about Easy DKIM signing, go to the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.set_identity_dkim_enabled(
Identity='string',
DkimEnabled=True|False
)
[REQUIRED]
The identity for which DKIM signing should be enabled or disabled.
[REQUIRED]
Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:
response = client.set_identity_dkim_enabled(
DkimEnabled=True,
Identity='user@example.com',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.
Note
Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.set_identity_feedback_forwarding_enabled(
Identity='string',
ForwardingEnabled=True|False
)
[REQUIRED]
The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com , example.com .
[REQUIRED]
Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example configures Amazon SES to forward an identity's bounces and complaints via email:
response = client.set_identity_feedback_forwarding_enabled(
ForwardingEnabled=True,
Identity='user@example.com',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.
You can execute this operation no more than once per second.
For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.set_identity_headers_in_notifications_enabled(
Identity='string',
NotificationType='Bounce'|'Complaint'|'Delivery',
Enabled=True|False
)
[REQUIRED]
The identity for which to enable or disable headers in notifications. Examples: user@example.com , example.com .
[REQUIRED]
The notification type for which to enable or disable headers in notifications.
[REQUIRED]
Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.
This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:
response = client.set_identity_headers_in_notifications_enabled(
Enabled=True,
Identity='user@example.com',
NotificationType='Bounce',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
Warning
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. 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.set_identity_mail_from_domain(
Identity='string',
MailFromDomain='string',
BehaviorOnMXFailure='UseDefaultValue'|'RejectMessage'
)
[REQUIRED]
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue , Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage , Amazon SES will return a MailFromDomainNotVerified error and not send the email.
The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending , Failed , and TemporaryFailure states.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:
response = client.set_identity_mail_from_domain(
BehaviorOnMXFailure='UseDefaultValue',
Identity='user@example.com',
MailFromDomain='bounces.example.com',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.
You can execute this operation no more than once per second.
For more information about feedback notification, see the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.set_identity_notification_topic(
Identity='string',
NotificationType='Bounce'|'Complaint'|'Delivery',
SnsTopic='string'
)
[REQUIRED]
The identity (email address or domain) that you want to set the Amazon SNS topic for.
Warning
You can only specify a verified identity for this parameter.
You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .
[REQUIRED]
The type of notifications that will be published to the specified Amazon SNS topic.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:
response = client.set_identity_notification_topic(
Identity='user@example.com',
NotificationType='Bounce',
SnsTopic='arn:aws:sns:us-west-2:111122223333:MyTopic',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Sets the position of the specified receipt rule in the receipt rule set.
For information about managing receipt rules, 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.set_receipt_rule_position(
RuleSetName='string',
RuleName='string',
After='string'
)
[REQUIRED]
The name of the receipt rule set that contains the receipt rule to reposition.
[REQUIRED]
The name of the receipt rule to reposition.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example sets the position of a receipt rule in a receipt rule set:
response = client.set_receipt_rule_position(
After='PutRuleAfterThisRule',
RuleName='RuleToReposition',
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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_template(
TemplateName='string',
TemplateData='string'
)
[REQUIRED]
The name of the template that you want to render.
[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) --
RenderedTemplate (string) --
The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.
Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.update_account_sending_enabled(
Enabled=True|False
)
Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.
Note
When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestination={
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'send'|'reject'|'bounce'|'complaint'|'delivery'|'open'|'click'|'renderingFailure',
],
'KinesisFirehoseDestination': {
'IAMRoleARN': 'string',
'DeliveryStreamARN': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'messageTag'|'emailHeader'|'linkTag',
'DefaultDimensionValue': 'string'
},
]
},
'SNSDestination': {
'TopicARN': 'string'
}
}
)
[REQUIRED]
The name of the configuration set that contains the event destination that you want to update.
[REQUIRED]
The event destination object that you want to apply to the specified configuration set.
The name of the event destination. The name must:
Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false .
The type of email sending events to publish to the event destination.
An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.
Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.
For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide .
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:
The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail /SendRawEmail API, choose messageTag . If you want Amazon SES to use your own email headers, choose emailHeader .
The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:
An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_set_reputation_metrics_enabled(
ConfigurationSetName='string',
Enabled=True|False
)
[REQUIRED]
The name of the configuration set that you want to update.
[REQUIRED]
Describes whether or not Amazon SES will publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.
None
Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_set_sending_enabled(
ConfigurationSetName='string',
Enabled=True|False
)
[REQUIRED]
The name of the configuration set that you want to update.
[REQUIRED]
Describes whether email sending is enabled or disabled for the configuration set.
None
Modifies an association between a configuration set and a custom domain for open and click event tracking.
By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_configuration_set_tracking_options(
ConfigurationSetName='string',
TrackingOptions={
'CustomRedirectDomain': 'string'
}
)
[REQUIRED]
The name of the configuration set for which you want to update the custom tracking domain.
[REQUIRED]
A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide .
The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
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.
None
Updates a receipt rule.
For information about managing receipt rules, 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_receipt_rule(
RuleSetName='string',
Rule={
'Name': 'string',
'Enabled': True|False,
'TlsPolicy': 'Require'|'Optional',
'Recipients': [
'string',
],
'Actions': [
{
'S3Action': {
'TopicArn': 'string',
'BucketName': 'string',
'ObjectKeyPrefix': 'string',
'KmsKeyArn': 'string'
},
'BounceAction': {
'TopicArn': 'string',
'SmtpReplyCode': 'string',
'StatusCode': 'string',
'Message': 'string',
'Sender': 'string'
},
'WorkmailAction': {
'TopicArn': 'string',
'OrganizationArn': 'string'
},
'LambdaAction': {
'TopicArn': 'string',
'FunctionArn': 'string',
'InvocationType': 'Event'|'RequestResponse'
},
'StopAction': {
'Scope': 'RuleSet',
'TopicArn': 'string'
},
'AddHeaderAction': {
'HeaderName': 'string',
'HeaderValue': 'string'
},
'SNSAction': {
'TopicArn': 'string',
'Encoding': 'UTF-8'|'Base64'
}
},
],
'ScanEnabled': True|False
}
)
[REQUIRED]
The name of the receipt rule set that the receipt rule belongs to.
[REQUIRED]
A data structure that contains the updated receipt rule information.
The name of the receipt rule. The name must:
If true , the receipt rule is active. The default value is false .
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require , Amazon SES will bounce emails that are not received over TLS. The default is Optional .
The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
For information about setting up receipt rules, see the Amazon SES Developer Guide .
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The name of the Amazon S3 bucket that incoming email will be saved to.
The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.
The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:
For more information about key policies, see the AWS KMS Developer Guide . If you do not specify a master key, Amazon SES will not encrypt your emails.
Warning
Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide .
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The SMTP reply code, as defined by RFC 5321 .
The SMTP enhanced status code, as defined by RFC 3463 .
Human-readable text to include in the bounce message.
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7 . For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide .
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction . For more information about AWS Lambda, see the AWS Lambda Developer Guide .
The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event . For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide .
Warning
There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
The name of the RuleSet that is being stopped.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
Adds a header to the received email.
The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.
Must be less than 2048 characters, and must not contain newline characters ("r" or "n").
Publishes the email content within a notification to Amazon SNS.
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic . For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .
The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.
If true , then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false .
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Examples
The following example updates a receipt rule to use an Amazon S3 action:
response = client.update_receipt_rule(
Rule={
'Actions': [
{
'S3Action': {
'BucketName': 'MyBucket',
'ObjectKeyPrefix': 'email',
},
},
],
'Enabled': True,
'Name': 'MyRule',
'ScanEnabled': True,
'TlsPolicy': 'Optional',
},
RuleSetName='MyRuleSet',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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_template(
Template={
'TemplateName': 'string',
'SubjectPart': 'string',
'TextPart': 'string',
'HtmlPart': 'string'
}
)
[REQUIRED]
The content of the email, composed of a subject line, an HTML part, and a text-only part.
The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.
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.
{}
Response Structure
Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.
You can execute this operation no more than once per second.
To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled operation.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.verify_domain_dkim(
Domain='string'
)
[REQUIRED]
The name of the domain to be verified for Easy DKIM signing.
{
'DkimTokens': [
'string',
]
}
Response Structure
Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.
A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide .
Examples
The following example generates DKIM tokens for a domain that has been verified with Amazon SES:
response = client.verify_domain_dkim(
Domain='example.com',
)
print(response)
Expected Output:
{
'DkimTokens': [
'EXAMPLEq76owjnks3lnluwg65scbemvw',
'EXAMPLEi3dnsj67hstzaj673klariwx2',
'EXAMPLEwfbtcukvimehexktmdtaz6naj',
],
'ResponseMetadata': {
'...': '...',
},
}
Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains 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.verify_domain_identity(
Domain='string'
)
[REQUIRED]
The domain to be verified.
{
'VerificationToken': 'string'
}
Response Structure
Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.
A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.
As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.
Examples
The following example starts the domain verification process with Amazon SES:
response = client.verify_domain_identity(
Domain='example.com',
)
print(response)
Expected Output:
{
'VerificationToken': 'eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE',
'ResponseMetadata': {
'...': '...',
},
}
Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.
See also: AWS API Documentation
Request Syntax
response = client.verify_email_address(
EmailAddress='string'
)
[REQUIRED]
The email address to be verified.
Examples
The following example starts the email address verification process with Amazon SES:
response = client.verify_email_address(
EmailAddress='user@example.com',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.
You can execute this operation no more than once per second.
See also: AWS API Documentation
Request Syntax
response = client.verify_email_identity(
EmailAddress='string'
)
[REQUIRED]
The email address to be verified.
{}
Response Structure
An empty element returned on a successful request.
Examples
The following example starts the email address verification process with Amazon SES:
response = client.verify_email_identity(
EmailAddress='user@example.com',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
The available paginators are:
paginator = client.get_paginator('list_custom_verification_email_templates')
Creates an iterator that will paginate through responses from SES.Client.list_custom_verification_email_templates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'CustomVerificationEmailTemplates': [
{
'TemplateName': 'string',
'FromEmailAddress': 'string',
'TemplateSubject': 'string',
'SuccessRedirectionURL': 'string',
'FailureRedirectionURL': 'string'
},
],
}
Response Structure
A paginated list of custom verification email templates.
A list of the custom verification email templates that exist in your account.
Contains information about a custom verification email template.
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 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.
paginator = client.get_paginator('list_identities')
Creates an iterator that will paginate through responses from SES.Client.list_identities().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
IdentityType='EmailAddress'|'Domain',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Identities': [
'string',
],
}
Response Structure
(dict) --
A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.
Identities (list) --
A list of identities.
The available waiters are:
waiter = client.get_waiter('identity_exists')
Polls SES.Client.get_identity_verification_attributes() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
Identities=[
'string',
],
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
A list of identities.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 20
None