Skip to content

Retrieves the rule-type variants that can be used in the FirewallRuleType field of CreateFirewallRule and UpdateFirewallRule

Description

Retrieves the rule-type variants that can be used in the FirewallRuleType field of create_firewall_rule and update_firewall_rule. 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.

Usage

route53resolver_list_firewall_rule_types(RuleType, MaxResults,
  NextToken)

Arguments

  • RuleType

    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

    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

    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.

Value

A list with the following syntax:

list(
  FirewallRuleTypes = list(
    list(
      RuleType = "string",
      Value = "string",
      DisplayName = "string",
      Description = "string",
      SubscriptionInfo = list(
        VendorName = "string",
        ProductId = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_firewall_rule_types(
  RuleType = "string",
  MaxResults = 123,
  NextToken = "string"
)