Skip to content

TrackingConfigurationOverrides

Source code in docs_src/capo_sesv2/types/tracking_configuration_overrides.py
class TrackingConfigurationOverrides(TypedDict, closed=True):
    open_tracking_enabled: NotRequired["capo_sesv2.types.feature_status.FeatureStatus"]
    """<p>Specifies whether Amazon SES tracks when the recipient opens this message. Can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Amazon SES tracks opens for this message, even when your account-level and configuration set settings don't enable open tracking.</p> </li> <li> <p> <code>DISABLED</code> – Amazon SES doesn't track opens for this message, even when your account-level or configuration set settings enable open tracking. Amazon SES doesn't add the tracking image to the message.</p> </li> </ul> <p>If you don't specify this value, Amazon SES uses the open tracking setting that would otherwise apply to the message.</p>"""
    click_tracking_enabled: NotRequired["capo_sesv2.types.feature_status.FeatureStatus"]
    """<p>Specifies whether Amazon SES tracks when the recipient clicks a link in this message. Can be one of the following:</p> <ul> <li> <p> <code>ENABLED</code> – Amazon SES tracks clicks for this message, even when your account-level and configuration set settings don't enable click tracking.</p> </li> <li> <p> <code>DISABLED</code> – Amazon SES doesn't track clicks for this message, even when your account-level or configuration set settings enable click tracking. Amazon SES doesn't rewrite the links in the message.</p> </li> </ul> <p>If you don't specify this value, Amazon SES uses the click tracking setting that would otherwise apply to the message.</p> <note> <p>Enabling open or click tracking with an override doesn't create an event destination. Amazon SES records the resulting open and click events in VDM, where you can review them using VDM metrics and Message Insights. To also receive these events at a destination that you own, the configuration set that the message uses must have an event destination that publishes open and click events.</p> </note>"""

click_tracking_enabled instance-attribute

click_tracking_enabled: NotRequired[FeatureStatus]

Specifies whether Amazon SES tracks when the recipient clicks a link in this message. Can be one of the following:

  • ENABLED – Amazon SES tracks clicks for this message, even when your account-level and configuration set settings don't enable click tracking.

  • DISABLED – Amazon SES doesn't track clicks for this message, even when your account-level or configuration set settings enable click tracking. Amazon SES doesn't rewrite the links in the message.

If you don't specify this value, Amazon SES uses the click tracking setting that would otherwise apply to the message.

Enabling open or click tracking with an override doesn't create an event destination. Amazon SES records the resulting open and click events in VDM, where you can review them using VDM metrics and Message Insights. To also receive these events at a destination that you own, the configuration set that the message uses must have an event destination that publishes open and click events.

open_tracking_enabled instance-attribute

open_tracking_enabled: NotRequired[FeatureStatus]

Specifies whether Amazon SES tracks when the recipient opens this message. Can be one of the following:

  • ENABLED – Amazon SES tracks opens for this message, even when your account-level and configuration set settings don't enable open tracking.

  • DISABLED – Amazon SES doesn't track opens for this message, even when your account-level or configuration set settings enable open tracking. Amazon SES doesn't add the tracking image to the message.

If you don't specify this value, Amazon SES uses the open tracking setting that would otherwise apply to the message.