Skip to content

Configure the suppression list preferences for a tenant

Description

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.

Usage

sesv2_put_tenant_suppression_attributes(TenantName, SuppressedReasons,
  SuppressionScope)

Arguments

  • TenantName

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

  • SuppressedReasons

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.

  • SuppressionScope

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.

Value

An empty list.

Request syntax

svc$put_tenant_suppression_attributes(
  TenantName = "string",
  SuppressedReasons = list(
    "BOUNCE"|"COMPLAINT"
  ),
  SuppressionScope = "ACCOUNT"|"TENANT"
)