SES / Client / set_active_receipt_rule_set

set_active_receipt_rule_set

SES.Client.set_active_receipt_rule_set(**kwargs)

Sets the specified receipt rule set as the active receipt rule set.

Note

To disable your email-receiving through Amazon SES completely, you can call this operation with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

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

See also: AWS API Documentation

Request Syntax

response = client.set_active_receipt_rule_set(
    RuleSetName='string'
)

Parameters:

RuleSetName (string) – The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  An empty element returned on a successful request.

Exceptions

• SES.Client.exceptions.RuleSetDoesNotExistException

Examples

The following example sets the active receipt rule set:

response = client.set_active_receipt_rule_set(
    RuleSetName='RuleSetToActivate',
)

print(response)

Expected Output:

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