Skip to content

PutTenantSuppressionAttributesRequest

Source code in docs_src/capo_sesv2/types/put_tenant_suppression_attributes_request.py 
15
16
17
18
19
20
21
22
23
24
25
class PutTenantSuppressionAttributesRequest(TypedDict, closed=True):
    tenant_name: "capo_sesv2.types.tenant_name.TenantName"
    """<p>The name of the tenant to configure suppression list preferences for.</p>"""
    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. Specify <code>TENANT</code> to use the tenant's own suppression list, or <code>ACCOUNT</code> to use the account-level suppression list.</p> <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. Specify TENANT to use the tenant's own suppression list, or ACCOUNT to use 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.

tenant_name instance-attribute 

tenant_name: TenantName

The name of the tenant to configure suppression list preferences for.