SES / Paginator / ListReceiptRuleSets

ListReceiptRuleSets

class SES.Paginator.ListReceiptRuleSets

paginator = client.get_paginator('list_receipt_rule_sets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SES.Client.list_receipt_rule_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'RuleSets': [
        {
            'Name': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  A list of receipt rule sets that exist under your AWS account.

  • RuleSets (list) –

    The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.

    • (dict) –

      Information about a receipt rule set.

      A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account’s verified domains.

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

      • Name (string) –

        The name of the receipt rule set. The name must:

        • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

        • Start and end with a letter or number.

        • Contain less than 64 characters.

      • CreatedTimestamp (datetime) –

        The date and time the receipt rule set was created.