2024/06/12 - Amazon Simple Email Service - 3 updated api methods
Changes This release adds support for Amazon EventBridge as an email sending events destination.
{'EventDestination': {'EventBridgeDestination': {'EventBusArn': 'string'}}}
Create an event destination. Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.
A single configuration set can include more than one event destination.
See also: AWS API Documentation
Request Syntax
client.create_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
EventDestination={
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE'|'DELIVERY_DELAY'|'SUBSCRIPTION',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'EventBridgeDestination': {
'EventBusArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
}
)
string
[REQUIRED]
The name of the configuration set .
string
[REQUIRED]
A name that identifies the event destination within the configuration set.
dict
[REQUIRED]
An object that defines the event destination.
Enabled (boolean) --
If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.
If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
MatchingEventTypes (list) --
An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.
(string) --
An email sending event type. For example, email sends, opens, and bounces are all email events.
KinesisFirehoseDestination (dict) --
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
IamRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
DeliveryStreamArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
CloudWatchDestination (dict) --
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
DimensionConfigurations (list) -- [REQUIRED]
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
(dict) --
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
DimensionName (string) -- [REQUIRED]
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
DimensionValueSource (string) -- [REQUIRED]
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.
DefaultDimensionValue (string) -- [REQUIRED]
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).
It can contain no more than 256 characters.
SnsDestination (dict) --
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.
TopicArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
EventBridgeDestination (dict) --
An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.
EventBusArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported.
PinpointDestination (dict) --
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.
{'EventDestinations': {'EventBridgeDestination': {'EventBusArn': 'string'}}}
Retrieve a list of event destinations that are associated with a configuration set.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.
See also: AWS API Documentation
Request Syntax
client.get_configuration_set_event_destinations(
ConfigurationSetName='string'
)
string
[REQUIRED]
The name of the configuration set that contains the event destination.
dict
Response Syntax
{
'EventDestinations': [
{
'Name': 'string',
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE'|'DELIVERY_DELAY'|'SUBSCRIPTION',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'EventBridgeDestination': {
'EventBusArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
},
]
}
Response Structure
(dict) --
Information about an event destination for a configuration set.
EventDestinations (list) --
An array that includes all of the events destinations that have been configured for the configuration set.
(dict) --
In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
Name (string) --
A name that identifies the event destination.
Enabled (boolean) --
If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.
If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
MatchingEventTypes (list) --
The types of events that Amazon SES sends to the specified event destinations.
SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)
REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.
BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)
COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.
DELIVERY - SES successfully delivered the email to the recipient's mail server.
OPEN - The recipient received the message and opened it in their email client.
CLICK - The recipient clicked one or more links in the email.
RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)
DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.
SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.
(string) --
An email sending event type. For example, email sends, opens, and bounces are all email events.
KinesisFirehoseDestination (dict) --
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
DeliveryStreamArn (string) --
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
CloudWatchDestination (dict) --
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
DimensionConfigurations (list) --
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
(dict) --
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
DimensionName (string) --
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
DimensionValueSource (string) --
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.
DefaultDimensionValue (string) --
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).
It can contain no more than 256 characters.
SnsDestination (dict) --
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.
TopicArn (string) --
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
EventBridgeDestination (dict) --
An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.
EventBusArn (string) --
The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported.
PinpointDestination (dict) --
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
{'EventDestination': {'EventBridgeDestination': {'EventBusArn': 'string'}}}
Update the configuration of an event destination for a configuration set.
Events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon EventBridge and associate a rule to send the event to the specified target.
See also: AWS API Documentation
Request Syntax
client.update_configuration_set_event_destination(
ConfigurationSetName='string',
EventDestinationName='string',
EventDestination={
'Enabled': True|False,
'MatchingEventTypes': [
'SEND'|'REJECT'|'BOUNCE'|'COMPLAINT'|'DELIVERY'|'OPEN'|'CLICK'|'RENDERING_FAILURE'|'DELIVERY_DELAY'|'SUBSCRIPTION',
],
'KinesisFirehoseDestination': {
'IamRoleArn': 'string',
'DeliveryStreamArn': 'string'
},
'CloudWatchDestination': {
'DimensionConfigurations': [
{
'DimensionName': 'string',
'DimensionValueSource': 'MESSAGE_TAG'|'EMAIL_HEADER'|'LINK_TAG',
'DefaultDimensionValue': 'string'
},
]
},
'SnsDestination': {
'TopicArn': 'string'
},
'EventBridgeDestination': {
'EventBusArn': 'string'
},
'PinpointDestination': {
'ApplicationArn': 'string'
}
}
)
string
[REQUIRED]
The name of the configuration set that contains the event destination to modify.
string
[REQUIRED]
The name of the event destination.
dict
[REQUIRED]
An object that defines the event destination.
Enabled (boolean) --
If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.
If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
MatchingEventTypes (list) --
An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.
(string) --
An email sending event type. For example, email sends, opens, and bounces are all email events.
KinesisFirehoseDestination (dict) --
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
IamRoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
DeliveryStreamArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.
CloudWatchDestination (dict) --
An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
DimensionConfigurations (list) -- [REQUIRED]
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
(dict) --
An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
DimensionName (string) -- [REQUIRED]
The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:
It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
It can contain no more than 256 characters.
DimensionValueSource (string) -- [REQUIRED]
The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.
DefaultDimensionValue (string) -- [REQUIRED]
The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:
Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).
It can contain no more than 256 characters.
SnsDestination (dict) --
An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notifications when certain email events occur.
TopicArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
EventBridgeDestination (dict) --
An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.
EventBusArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported.
PinpointDestination (dict) --
An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.
dict
Response Syntax
{}
Response Structure
(dict) --
An HTTP 200 response if the request succeeds, or an error message if the request fails.