Route53Resolver / Paginator / ListFirewallRuleTypes

ListFirewallRuleTypes

class Route53Resolver.Paginator.ListFirewallRuleTypes

paginator = client.get_paginator('list_firewall_rule_types')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53Resolver.Client.list_firewall_rule_types().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RuleType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• RuleType (string) – An optional filter that restricts the response to a single FirewallRuleType variant. Supported values: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. If omitted, definitions across all variants are returned.

• 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

{
    'FirewallRuleTypes': [
        {
            'RuleType': 'string',
            'Value': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'SubscriptionInfo': {
                'VendorName': 'string',
                'ProductId': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • FirewallRuleTypes (list) –

    A list of the available rule type definitions.

    • (dict) –

      The definition of an available rule type that can be used in DNS Firewall rules. This is returned by ListFirewallRuleTypes.

      • RuleType (string) –

        The category or class of the rule type, such as FirewallAdvancedContentCategory or FirewallAdvancedThreatCategory.

      • Value (string) –

        The specific identifier within the rule type category, such as VIOLENCE_AND_HATE_SPEECH or PHISHING.

      • DisplayName (string) –

        The display name of the rule type.

      • Description (string) –

        A description of the rule type.

      • SubscriptionInfo (dict) –

        For rule types that require an external subscription (today, only the PartnerThreatProtection variant), describes the Amazon Web Services Marketplace product that backs the rule type. Absent for rule types that are managed by Amazon Web Services and do not require a separate subscription. See SubscriptionInfo.

        • VendorName (string) –

          The name of the Amazon Web Services Marketplace seller (vendor) that publishes the partner threat-protection product (for example, Palo Alto Networks).

        • ProductId (string) –

          The Amazon Web Services Marketplace product identifier of the partner threat-protection product. Use this value to verify or manage the calling account’s subscription in Amazon Web Services Marketplace.