Skip to content

TenantSuppressionAttributes

Used by
Source code in docs_src/capo_sesv2/types/tenant_suppression_attributes.py 
12
13
14
15
16
17
18
19
20
class TenantSuppressionAttributes(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 the 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 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 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 tenant. Can be one of the following:</p> <ul> <li> <p> <code>TENANT</code> – The tenant uses its own suppression list.</p> </li> <li> <p> <code>ACCOUNT</code> – The tenant uses the account-level suppression list.</p> </li> </ul> <note> <p>If you don't specify a suppression scope, the tenant defaults to <code>ACCOUNT</code> scope and uses the account-level suppression list.</p> </note>"""

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 the tenant. This list can contain any or all of the following:

  • COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.

  • BOUNCE – Amazon SES adds an email address to the suppression list 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 tenant. Can be one of the following:

  • TENANT – The tenant uses its own suppression list.

  • ACCOUNT – The tenant uses the account-level suppression list.

If you don't specify a suppression scope, the tenant defaults to ACCOUNT scope and uses the account-level suppression list.