SESV2 / Client / put_configuration_set_suppression_options

put_configuration_set_suppression_options

SESV2.Client.put_configuration_set_suppression_options(**kwargs)

Specify the account suppression list preferences for a configuration set.

See also: AWS API Documentation

Request Syntax

response = client.put_configuration_set_suppression_options(
    ConfigurationSetName='string',
    SuppressedReasons=[
        'BOUNCE'|'COMPLAINT',
    ],
    ValidationOptions={
        'ConditionThreshold': {
            'ConditionThresholdEnabled': 'ENABLED'|'DISABLED',
            'OverallConfidenceThreshold': {
                'ConfidenceVerdictThreshold': 'MEDIUM'|'HIGH'|'MANAGED'
            }
        }
    }
)
Parameters:

  • ConfigurationSetName (string) –

    [REQUIRED]

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

  • SuppressedReasons (list) –

    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.

    • (string) –

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

      • COMPLAINT – Amazon SES added an email address to the suppression list for your account 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 because a message sent to that address results in a hard bounce.

  • ValidationOptions (dict) –

    An object that contains information about the email address suppression preferences for the configuration set in the current Amazon Web Services Region.

    • ConditionThreshold (dict) – [REQUIRED]

      Specifies the condition threshold settings for suppression validation.

      • ConditionThresholdEnabled (string) – [REQUIRED]

        Indicates whether Auto Validation is enabled for suppression. Set to ENABLED to enable the Auto Validation feature, or set to DISABLED to disable it.

      • OverallConfidenceThreshold (dict) –

        The overall confidence threshold used to determine suppression decisions.

        • ConfidenceVerdictThreshold (string) – [REQUIRED]

          The confidence level threshold for suppression decisions.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

Exceptions

  • SESV2.Client.exceptions.NotFoundException

  • SESV2.Client.exceptions.TooManyRequestsException

  • SESV2.Client.exceptions.BadRequestException