SES / Client / reorder_receipt_rule_set

reorder_receipt_rule_set

SES.Client.reorder_receipt_rule_set(**kwargs)

Reorders the receipt rules within a receipt rule set.

Note

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn’t explicitly position all of the rules.

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.reorder_receipt_rule_set(
    RuleSetName='string',
    RuleNames=[
        'string',
    ]
)

Parameters:

• RuleSetName (string) –

  [REQUIRED]

  The name of the receipt rule set to reorder.

• RuleNames (list) –

  [REQUIRED]

  A list of the specified receipt rule set’s receipt rules in the order that you want to put them.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  An empty element returned on a successful request.

Exceptions

• SES.Client.exceptions.RuleSetDoesNotExistException

• SES.Client.exceptions.RuleDoesNotExistException

Examples

The following example reorders the receipt rules within a receipt rule set:

response = client.reorder_receipt_rule_set(
    RuleNames=[
        'MyRule',
        'MyOtherRule',
    ],
    RuleSetName='MyRuleSet',
)

print(response)

Expected Output:

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