Skip to content

SuppressionOptions

Used by
Source code in docs_src/capo_sesv2/types/suppression_options.py 
13
14
15
16
17
18
19
20
21
22
23
24
class SuppressionOptions(TypedDict, closed=True):
    suppressed_reasons: NotRequired[
        "capo_sesv2.types.suppression_list_reasons.SuppressionListReasons"
    ]
    """<p>A list that contains the reasons that email addresses are automatically added to the suppression list for your account or for a specific tenant. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> – Amazon SES adds an email address to the suppression list for your account or for a specific tenant when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> – Amazon SES adds an email address to the suppression list for your account or for a specific tenant when a message sent to that address results in a hard bounce.</p> </li> </ul>"""
    suppression_scope: NotRequired[
        "capo_sesv2.types.suppression_list_scope.SuppressionListScope"
    ]
    """<p>The suppression scope for the configuration set. This overrides the tenant or account suppression scope for emails sent using this configuration set. Can be one of the following:</p> <ul> <li> <p> <code>TENANT</code> – Use the tenant's suppression list.</p> </li> <li> <p> <code>ACCOUNT</code> – Use the account-level suppression list.</p> </li> </ul>"""
    validation_options: NotRequired[
        "capo_sesv2.types.suppression_validation_options.SuppressionValidationOptions"
    ]

suppressed_reasons instance-attribute 

suppressed_reasons: NotRequired[SuppressionListReasons]

A list that contains the reasons that email addresses are automatically added to the suppression list for your account or for a specific tenant. This list can contain any or all of the following:

  • COMPLAINT – Amazon SES adds an email address to the suppression list for your account or for a specific tenant when a message sent to that address results in a complaint.

  • BOUNCE – Amazon SES adds an email address to the suppression list for your account or for a specific tenant when a message sent to that address results in a hard bounce.

suppression_scope instance-attribute 

suppression_scope: NotRequired[SuppressionListScope]

The suppression scope for the configuration set. This overrides the tenant or account suppression scope for emails sent using this configuration set. Can be one of the following:

  • TENANT – Use the tenant's suppression list.

  • ACCOUNT – Use the account-level suppression list.

validation_options instance-attribute 

validation_options: NotRequired[SuppressionValidationOptions]