WAF / Paginator / ListRuleGroups

ListRuleGroups

class WAF.Paginator.ListRuleGroups

paginator = client.get_paginator('list_rule_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WAF.Client.list_rule_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 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.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'RuleGroups': [
        {
            'RuleGroupId': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • RuleGroups (list) –

    An array of RuleGroup objects.

    • (dict) –

      Note

      This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

      For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

      Contains the identifier and the friendly name or description of the RuleGroup .

      • RuleGroupId (string) –

        A unique identifier for a RuleGroup . You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup ), update a RuleGroup (see UpdateRuleGroup ), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL ), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup ).

        RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

      • Name (string) –

        A friendly name or description of the RuleGroup. You can’t change the name of a RuleGroup after you create it.

  • NextToken (string) –

    A token to resume pagination.