WAF / Paginator / ListSubscribedRuleGroups

ListSubscribedRuleGroups

class WAF.Paginator.ListSubscribedRuleGroups

paginator = client.get_paginator('list_subscribed_rule_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WAF.Client.list_subscribed_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',
            'MetricName': '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.

      A summary of the rule groups you are subscribed to.

      • RuleGroupId (string) –

        A unique identifier for a RuleGroup.

      • Name (string) –

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

      • MetricName (string) –

        A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change the name of the metric after you create the RuleGroup.

  • NextToken (string) –

    A token to resume pagination.