SES / Client / create_configuration_set_tracking_options

create_configuration_set_tracking_options

SES.Client.create_configuration_set_tracking_options(**kwargs)

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'
    }
)

Parameters:

• ConfigurationSetName (string) –

  [REQUIRED]

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

• TrackingOptions (dict) –

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  An empty element returned on a successful request.

Exceptions

• SES.Client.exceptions.ConfigurationSetDoesNotExistException

• SES.Client.exceptions.TrackingOptionsAlreadyExistsException

• SES.Client.exceptions.InvalidTrackingOptionsException