Route53Resolver / Client / list_firewall_rule_types

list_firewall_rule_types

Route53Resolver.Client.list_firewall_rule_types(**kwargs)

Retrieves the rule-type variants that can be used in the FirewallRuleType field of CreateFirewallRule and UpdateFirewallRule. Each returned FirewallRuleTypeDefinition identifies one variant + value combination — for example, FirewallAdvancedContentCategory + VIOLENCE_AND_HATE_SPEECH, or PartnerThreatProtection + a partner-managed feed.

The supported RuleType filter values are FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. When a returned definition’s variant requires an external subscription (currently only PartnerThreatProtection), the response also includes a SubscriptionInfo identifying the Amazon Web Services Marketplace product that backs it; absence of SubscriptionInfo means the variant is fully managed by Amazon Web Services and requires no separate subscription.

See also: AWS API Documentation

Request Syntax

response = client.list_firewall_rule_types(
    RuleType='string',
    MaxResults=123,
    NextToken='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.

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

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

{
    'FirewallRuleTypes': [
        {
            'RuleType': 'string',
            'Value': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'SubscriptionInfo': {
                'VendorName': 'string',
                'ProductId': 'string'
            }
        },
    ],
    'NextToken': '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.

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

Exceptions