NetworkFirewall / Paginator / ListRuleGroups

ListRuleGroups#

class NetworkFirewall.Paginator.ListRuleGroups#
paginator = client.get_paginator('list_rule_groups')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Scope='MANAGED'|'ACCOUNT',
    ManagedType='AWS_MANAGED_THREAT_SIGNATURES'|'AWS_MANAGED_DOMAIN_LISTS',
    Type='STATELESS'|'STATEFUL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • Scope (string) – The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

  • ManagedType (string) – Indicates the general category of the Amazon Web Services managed rule group.

  • Type (string) – Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

  • 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': [
        {
            'Name': 'string',
            'Arn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • RuleGroups (list) –

      The rule group metadata objects that you’ve defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.

      • (dict) –

        High-level information about a rule group, returned by ListRuleGroups. You can use the information provided in the metadata to retrieve and manage a rule group.

        • Name (string) –

          The descriptive name of the rule group. You can’t change the name of a rule group after you create it.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the rule group.