AWS API Changes

2017/08/01 - Amazon Simple Email Service - 3 updated api methods

Changes This update adds information about publishing email open and click events. This update also adds information about publishing email events to Amazon Simple Notification Service (Amazon SNS).

CreateConfigurationSetEventDestination (updated)

Link ¶
Changes (request)

{'EventDestination': {'CloudWatchDestination': {'DimensionConfigurations': {'DimensionValueSource': ['linkTag']}},
                      'MatchingEventTypes': ['click', 'open'],
                      'SNSDestination': {'TopicARN': 'string'}}}

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 Amazon 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 .

This action is throttled at one request per second.

See also: AWS API Documentation

Request Syntax

client.create_configuration_set_event_destination(
    ConfigurationSetName='string',
    EventDestination={
        'Name': 'string',
        'Enabled': True|False,
        'MatchingEventTypes': [
            'send'|'reject'|'bounce'|'complaint'|'delivery'|'open'|'click',
        ],
        'KinesisFirehoseDestination': {
            'IAMRoleARN': 'string',
            'DeliveryStreamARN': 'string'
        },
        'CloudWatchDestination': {
            'DimensionConfigurations': [
                {
                    'DimensionName': 'string',
                    'DimensionValueSource': 'messageTag'|'emailHeader'|'linkTag',
                    'DefaultDimensionValue': 'string'
                },
            ]
        },
        'SNSDestination': {
            'TopicARN': 'string'
        }
    }
)

type ConfigurationSetName

string

param ConfigurationSetName

[REQUIRED]

The name of the configuration set to which to apply the event destination.

type EventDestination

dict

param EventDestination

[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.
SNSDestination (dict) --

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
- TopicARN (string) -- [REQUIRED]
  
  The ARN of the Amazon SNS topic to which you want to publish email sending events. 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 http://docs.aws.amazon.com/http:/alpha-docs-aws.amazon.com/sns/latest/dg/CreateTopic.html`__ .

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

An empty element returned on a successful request.

DescribeConfigurationSet (updated)

Link ¶
Changes (response)

{'EventDestinations': {'CloudWatchDestination': {'DimensionConfigurations': {'DimensionValueSource': ['linkTag']}},
                       'MatchingEventTypes': ['click', 'open'],
                       'SNSDestination': {'TopicARN': 'string'}}}

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.

See also: AWS API Documentation

Request Syntax

client.describe_configuration_set(
    ConfigurationSetName='string',
    ConfigurationSetAttributeNames=[
        'eventDestinations',
    ]
)

type ConfigurationSetName

string

param ConfigurationSetName

[REQUIRED]

The name of the configuration set to describe.

type ConfigurationSetAttributeNames

list

param ConfigurationSetAttributeNames

A list of configuration set attributes to return.

(string) --

rtype

dict

returns

Response Syntax

{
    'ConfigurationSet': {
        'Name': 'string'
    },
    'EventDestinations': [
        {
            'Name': 'string',
            'Enabled': True|False,
            'MatchingEventTypes': [
                'send'|'reject'|'bounce'|'complaint'|'delivery'|'open'|'click',
            ],
            'KinesisFirehoseDestination': {
                'IAMRoleARN': 'string',
                'DeliveryStreamARN': 'string'
            },
            'CloudWatchDestination': {
                'DimensionConfigurations': [
                    {
                        'DimensionName': 'string',
                        'DimensionValueSource': 'messageTag'|'emailHeader'|'linkTag',
                        'DefaultDimensionValue': 'string'
                    },
                ]
            },
            'SNSDestination': {
                'TopicARN': '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 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:
      - 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.
    - 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 to which you want to publish email sending events. 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 http://docs.aws.amazon.com/http:/alpha-docs-aws.amazon.com/sns/latest/dg/CreateTopic.html`__ .

UpdateConfigurationSetEventDestination (updated)

Link ¶
Changes (request)

{'EventDestination': {'CloudWatchDestination': {'DimensionConfigurations': {'DimensionValueSource': ['linkTag']}},
                      'MatchingEventTypes': ['click', 'open'],
                      'SNSDestination': {'TopicARN': 'string'}}}

Updates the event destination of a configuration set.

Note

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 .

This action is throttled at one request per second.

See also: AWS API Documentation

Request Syntax

client.update_configuration_set_event_destination(
    ConfigurationSetName='string',
    EventDestination={
        'Name': 'string',
        'Enabled': True|False,
        'MatchingEventTypes': [
            'send'|'reject'|'bounce'|'complaint'|'delivery'|'open'|'click',
        ],
        'KinesisFirehoseDestination': {
            'IAMRoleARN': 'string',
            'DeliveryStreamARN': 'string'
        },
        'CloudWatchDestination': {
            'DimensionConfigurations': [
                {
                    'DimensionName': 'string',
                    'DimensionValueSource': 'messageTag'|'emailHeader'|'linkTag',
                    'DefaultDimensionValue': 'string'
                },
            ]
        },
        'SNSDestination': {
            'TopicARN': 'string'
        }
    }
)

type ConfigurationSetName

string

param ConfigurationSetName

[REQUIRED]

The name of the configuration set that you want to update.

type EventDestination

dict

param EventDestination

[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.
SNSDestination (dict) --

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
- TopicARN (string) -- [REQUIRED]
  
  The ARN of the Amazon SNS topic to which you want to publish email sending events. 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 http://docs.aws.amazon.com/http:/alpha-docs-aws.amazon.com/sns/latest/dg/CreateTopic.html`__ .

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

An empty element returned on a successful request.