SESV2 / Client / put_tenant_suppression_attributes

put_tenant_suppression_attributes

SESV2.Client.put_tenant_suppression_attributes(**kwargs)

Configure the suppression list preferences for a tenant. Use this operation to enable or disable tenant-level suppression, or to change the suppressed reasons for a tenant.

When you set the suppression scope to TENANT, Amazon SES maintains a separate suppression list for the tenant. When you set the scope to ACCOUNT, the tenant uses the account-level suppression list.

See also: AWS API Documentation

Request Syntax

response = client.put_tenant_suppression_attributes(
    TenantName='string',
    SuppressedReasons=[
        'BOUNCE'|'COMPLAINT',
    ],
    SuppressionScope='ACCOUNT'|'TENANT'
)
Parameters:

  • TenantName (string) –

    [REQUIRED]

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

  • SuppressedReasons (list) –

    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.

    • (string) –

      The reason that the address was added to the suppression list for your account or for a specific tenant. The value can be one of the following:

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

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

  • SuppressionScope (string) –

    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.

    Note

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Exceptions

  • SESV2.Client.exceptions.NotFoundException

  • SESV2.Client.exceptions.TooManyRequestsException

  • SESV2.Client.exceptions.BadRequestException