NetworkFirewall / Client / list_rule_groups

list_rule_groups#

NetworkFirewall.Client.list_rule_groups(**kwargs)#

Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.

See also: AWS API Documentation

Request Syntax

response = client.list_rule_groups(
    NextToken='string',
    MaxResults=123,
    Scope='MANAGED'|'ACCOUNT',
    ManagedType='AWS_MANAGED_THREAT_SIGNATURES'|'AWS_MANAGED_DOMAIN_LISTS',
    Type='STATELESS'|'STATEFUL'
)
Parameters:

  • NextToken (string) – When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

  • MaxResults (integer) – The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

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

Exceptions

  • NetworkFirewall.Client.exceptions.InvalidRequestException

  • NetworkFirewall.Client.exceptions.ThrottlingException

  • NetworkFirewall.Client.exceptions.InternalServerError