PutConfigurationSetSuppressionOptions - Amazon SES API v2

PutConfigurationSetSuppressionOptions

Specify the account suppression list preferences for a configuration set.

Request Syntax

PUT /v2/email/configuration-sets/ConfigurationSetName/suppression-options HTTP/1.1 Content-type: application/json { "SuppressedReasons": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName

The name of the configuration set that you want to change the suppression list preferences for.

Required: Yes

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

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

  • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

Type: Array of strings

Valid Values: BOUNCE | COMPLAINT

Required: No

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 Errors.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: