SES / Client / update_configuration_set_sending_enabled

update_configuration_set_sending_enabled#

SES.Client.update_configuration_set_sending_enabled(**kwargs)#

Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.

You can execute this operation no more than once per second.

See also: AWS API Documentation

Request Syntax

response = client.update_configuration_set_sending_enabled(
    ConfigurationSetName='string',
    Enabled=True|False
)
Parameters:
  • ConfigurationSetName (string) –

    [REQUIRED]

    The name of the configuration set that you want to update.

  • Enabled (boolean) –

    [REQUIRED]

    Describes whether email sending is enabled or disabled for the configuration set.

Returns:

None

Exceptions

  • SES.Client.exceptions.ConfigurationSetDoesNotExistException

Examples

Set the sending enabled flag for a specific configuration set.

response = client.update_configuration_set_sending_enabled(
    ConfigurationSetName='foo',
    Enabled=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}