Route53Resolver / Paginator / ListFirewallRuleGroups

ListFirewallRuleGroups#

class Route53Resolver.Paginator.ListFirewallRuleGroups#
paginator = client.get_paginator('list_firewall_rule_groups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_firewall_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

{
    'FirewallRuleGroups': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'OwnerId': 'string',
            'CreatorRequestId': 'string',
            'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME'
        },
    ]
}

Response Structure

  • (dict) –

    • FirewallRuleGroups (list) –

      A list of your firewall rule groups.

      This might be a partial list of the rule groups that you have defined. For information, see MaxResults.

      • (dict) –

        Minimal high-level information for a firewall rule group. The action ListFirewallRuleGroups returns an array of these objects.

        To retrieve full information for a firewall rule group, call GetFirewallRuleGroup and ListFirewallRules.

        • Id (string) –

          The ID of the rule group.

        • Arn (string) –

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

        • Name (string) –

          The name of the rule group.

        • OwnerId (string) –

          The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

        • CreatorRequestId (string) –

          A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

        • ShareStatus (string) –

          Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).