Amazon Simple Email Service

2017/09/18 - Amazon Simple Email Service - 3 new1 updated api methods

Changes  Update ses client to latest version

DeleteConfigurationSetTrackingOptions (new) Link ¶

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 by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

See also: AWS API Documentation

Request Syntax

client.delete_configuration_set_tracking_options(
    ConfigurationSetName='string'
)
type ConfigurationSetName:

string

param ConfigurationSetName:

[REQUIRED]

The name of the configuration set from which you want to delete the tracking options.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    An empty element returned on a successful request.

CreateConfigurationSetTrackingOptions (new) Link ¶

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 by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

See also: AWS API Documentation

Request Syntax

client.create_configuration_set_tracking_options(
    ConfigurationSetName='string',
    TrackingOptions={
        'CustomRedirectDomain': 'string'
    }
)
type ConfigurationSetName:

string

param ConfigurationSetName:

[REQUIRED]

The name of the configuration set that the tracking options should be associated with.

type TrackingOptions:

dict

param TrackingOptions:

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

  • CustomRedirectDomain (string) --

    The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    An empty element returned on a successful request.

UpdateConfigurationSetTrackingOptions (new) Link ¶

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 by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

See also: AWS API Documentation

Request Syntax

client.update_configuration_set_tracking_options(
    ConfigurationSetName='string',
    TrackingOptions={
        'CustomRedirectDomain': 'string'
    }
)
type ConfigurationSetName:

string

param ConfigurationSetName:

[REQUIRED]

The name of the configuration set for which you want to update the custom tracking domain.

type TrackingOptions:

dict

param TrackingOptions:

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

  • CustomRedirectDomain (string) --

    The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    An empty element returned on a successful request.

DescribeConfigurationSet (updated) Link ¶
Changes (request, response)
Request 
{'ConfigurationSetAttributeNames': {'trackingOptions'}}
Response 
{'TrackingOptions': {'CustomRedirectDomain': 'string'}}

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

client.describe_configuration_set(
    ConfigurationSetName='string',
    ConfigurationSetAttributeNames=[
        'eventDestinations'|'trackingOptions',
    ]
)
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'
            }
        },
    ],
    'TrackingOptions': {
        'CustomRedirectDomain': '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 meet the following requirements:

        • Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

        • Contain 64 characters or fewer.

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

        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 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:

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