Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutTenantSuppressionAttributes

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.

Request Syntax


POST /v2/email/tenant/suppression HTTP/1.1
Content-type: application/json

{
   "SuppressedReasons": [ "string" ],
   "SuppressionScope": "string",
   "TenantName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Type: Array of strings

Valid Values: BOUNCE | COMPLAINT

Required: No

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.

Note

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

Type: String

Valid Values: ACCOUNT | TENANT

Required: No

TenantName

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

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

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

Errors

For information about the errors that are common to all actions, see Common Error Types.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429