Route53Resolver / Client / list_firewall_rule_groups

list_firewall_rule_groups#

Route53Resolver.Client.list_firewall_rule_groups(**kwargs)#

Retrieves the minimal high-level information for the rule groups that you have defined.

A single call might return only a partial list of the rule groups. For information, see MaxResults.

See also: AWS API Documentation

Request Syntax

response = client.list_firewall_rule_groups(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) –

    The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don’t specify a value for MaxResults, Resolver returns up to 100 objects.

  • NextToken (string) –

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

    • 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).

Exceptions