2016/11/02 - Amazon Simple Email Service - 7 new 2 updated api methods
Changes Amazon Simple Email Service (Amazon SES) now enables you to track your bounce, complaint, delivery, sent, and rejected email metrics with fine-grained granularity.
Returns the details of the specified configuration set.
Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
This action is throttled at one request per second.
Request Syntax
client.describe_configuration_set(
ConfigurationSetName='string',
ConfigurationSetAttributeNames=[
'eventDestinations',
]
)
string
[REQUIRED]
The name of the configuration set to describe.
list
A list of configuration set attributes to return.
(string) --
dict
Response Syntax
{
'ConfigurationSet': {
'Name': 'string'
},
'EventDestinations': [
{
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'send'|'reject'|'bounce'|'complaint'|'delivery',
],
'KinesisFirehoseDestination': {
'IAMRoleARN': 'string',
'DeliveryStreamARN': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'messageTag'|'emailHeader',
'DefaultDimensionValue': 'string'
},
]
}
},
]
}
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:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 64 characters.
EventDestinations (list) --
A list of event destinations associated with the configuration set.
(dict) --
Contains information about the event destination to which the specified email sending events are published.
Note
When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide .
Name (string) --
The name of the event destination. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 64 characters.
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.
(string) --
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 to which to publish email sending events.
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:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
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:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
Updates the event destination of a configuration set.
Note
When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.
Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide .
This action is throttled at one request per second.
Request Syntax
client.update_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestination={
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'send'|'reject'|'bounce'|'complaint'|'delivery',
],
'KinesisFirehoseDestination': {
'IAMRoleARN': 'string',
'DeliveryStreamARN': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'messageTag'|'emailHeader',
'DefaultDimensionValue': 'string'
},
]
}
}
)
string
[REQUIRED]
The name of the configuration set that you want to update.
dict
[REQUIRED]
The event destination object that you want to apply to the specified configuration set.
Name (string) -- [REQUIRED]
The name of the event destination. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 64 characters.
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) -- [REQUIRED]
The type of email sending events to publish to the event destination.
(string) --
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) -- [REQUIRED]
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
DeliveryStreamARN (string) -- [REQUIRED]
The ARN of the Amazon Kinesis Firehose stream to which to publish email sending events.
CloudWatchDestination (dict) --
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
DimensionConfigurations (list) -- [REQUIRED]
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) -- [REQUIRED]
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
DimensionValueSource (string) -- [REQUIRED]
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) -- [REQUIRED]
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:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
dict
Response Syntax
{}
Response Structure
(dict) --
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 either Amazon CloudWatch or Amazon Kinesis Firehose.
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 .
This action is throttled at one request per second.
Request Syntax
client.create_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestination={
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'send'|'reject'|'bounce'|'complaint'|'delivery',
],
'KinesisFirehoseDestination': {
'IAMRoleARN': 'string',
'DeliveryStreamARN': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'messageTag'|'emailHeader',
'DefaultDimensionValue': 'string'
},
]
}
}
)
string
[REQUIRED]
The name of the configuration set to which to apply the event destination.
dict
[REQUIRED]
An object that describes the AWS service to which Amazon SES will publish the email sending events associated with the specified configuration set.
Name (string) -- [REQUIRED]
The name of the event destination. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 64 characters.
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) -- [REQUIRED]
The type of email sending events to publish to the event destination.
(string) --
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) -- [REQUIRED]
The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.
DeliveryStreamARN (string) -- [REQUIRED]
The ARN of the Amazon Kinesis Firehose stream to which to publish email sending events.
CloudWatchDestination (dict) --
An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.
DimensionConfigurations (list) -- [REQUIRED]
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) -- [REQUIRED]
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
DimensionValueSource (string) -- [REQUIRED]
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) -- [REQUIRED]
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:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
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 .
This action is throttled at one request per second.
Request Syntax
client.delete_configuration_set(
ConfigurationSetName='string'
)
string
[REQUIRED]
The name of the configuration set to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
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 .
This action is throttled at one request per second.
Request Syntax
client.create_configuration_set(
ConfigurationSet={
'Name': 'string'
}
)
dict
[REQUIRED]
A data structure that contains the name of the configuration set.
Name (string) -- [REQUIRED]
The name of the configuration set. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 64 characters.
dict
Response Syntax
{}
Response Structure
(dict) --
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 .
This action is throttled at one request per second.
Request Syntax
client.delete_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string'
)
string
[REQUIRED]
The name of the configuration set from which to delete the event destination.
string
[REQUIRED]
The name of the event destination to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
An empty element returned on a successful request.
Lists the 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 .
This action is throttled at one request per second and can return up to 50 configuration sets at a time.
Request Syntax
client.list_configuration_sets(
NextToken='string',
MaxItems=123
)
string
A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.
integer
The number of configuration sets to return.
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 enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide .
Name (string) --
The name of the configuration set. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 64 characters.
NextToken (string) --
A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets .
{'ConfigurationSetName': 'string',
'Tags': [{'Name': 'string', 'Value': 'string'}]}
Composes an email message based on input data, and then immediately queues the message for sending.
There are several important points to know about SendEmail :
You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide .
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide .
Request Syntax
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'
)
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 .
In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= . For more information, see RFC 2047 .
dict
[REQUIRED]
The destination for this email, composed of To:, CC:, and BCC: fields.
ToAddresses (list) --
The To: field(s) of the message.
(string) --
CcAddresses (list) --
The CC: field(s) of the message.
(string) --
BccAddresses (list) --
The BCC: field(s) of the message.
(string) --
dict
[REQUIRED]
The message to be sent.
Subject (dict) -- [REQUIRED]
The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
Data (string) -- [REQUIRED]
The textual data of the content.
Charset (string) --
The character set of the content.
Body (dict) -- [REQUIRED]
The message body.
Text (dict) --
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).
Data (string) -- [REQUIRED]
The textual data of the content.
Charset (string) --
The character set of the content.
Html (dict) --
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.
Data (string) -- [REQUIRED]
The textual data of the content.
Charset (string) --
The character set of the content.
list
The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.
(string) --
string
The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
string
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to 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 .
string
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the 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 .
list
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.
(dict) --
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 .
Name (string) -- [REQUIRED]
The name of the tag. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
Value (string) -- [REQUIRED]
The value of the tag. The value must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
string
The name of the configuration set to use when you send an email using SendEmail .
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Represents a unique message ID.
MessageId (string) --
The unique message identifier returned from the SendEmail action.
{'ConfigurationSetName': 'string',
'Tags': [{'Name': 'string', 'Value': 'string'}]}
Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent.
There are several important points to know about SendRawEmail :
You can only send email from verified email addresses and domains; otherwise, you will get an "Email address not verified" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide .
The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.
Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.
The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.
Amazon SES overrides any Message-ID and Date headers you provide.
For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide .
If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's "Source," "From," and "Return-Path" parameters in one of two ways: you can pass optional parameters SourceArn , FromArn , and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:
X-SES-SOURCE-ARN
X-SES-FROM-ARN
X-SES-RETURN-PATH-ARN
Warning
Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.
For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn . (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn , Amazon SES will simply set the "From" address and the "Return Path" address to the identity specified in SourceIdentityArn . For more information about sending authorization, see the Amazon SES Developer Guide .
Request Syntax
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'
)
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.)
By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?= . For more information, see RFC 2047 .
Note
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.
list
A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.
(string) --
dict
[REQUIRED]
The raw text of the message. The client is responsible for ensuring the following:
Message must contain a header and a body, separated by a blank line.
All required header fields must be present.
Each part of a multipart MIME message must be formatted properly.
MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide .
Must be base64-encoded.
Data (bytes) -- [REQUIRED]
The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 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 .
string
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to 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 .
string
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to 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 .
string
This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the 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 .
list
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.
(dict) --
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 .
Name (string) -- [REQUIRED]
The name of the tag. The name must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
Value (string) -- [REQUIRED]
The value of the tag. The value must:
Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Contain less than 256 characters.
string
The name of the configuration set to use when you send an email using SendRawEmail .
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
Represents a unique message ID.
MessageId (string) --
The unique message identifier returned from the SendRawEmail action.