View a markdown version of this page

ListFirewallRuleTypes - Amazon Route 53

ListFirewallRuleTypes

Retrieves the available rule types that can be used in DNS Firewall rules.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "RuleType": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Required: No

RuleType

The rule type to filter by. If specified, only rule types matching this value are returned.

Type: String

Length Constraints: Maximum length of 128.

Required: No

Response Syntax

{ "FirewallRuleTypes": [ { "Description": "string", "DisplayName": "string", "RuleType": "string", "Value": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FirewallRuleTypes

A list of the available rule type definitions.

Type: Array of FirewallRuleTypeDefinition objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

HTTP Status Code: 400

InternalServiceErrorException

We encountered an unknown error. Try again in a few minutes.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

ValidationException

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

HTTP Status Code: 400

Examples

ListFirewallRuleTypes Example

This example illustrates one usage of ListFirewallRuleTypes.

Sample Request

POST / HTTP/1.1 Host: route53resolver.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 22 X-Amz-Target: Route53Resolver.ListFirewallRuleTypes X-Amz-Date: 20260420T120000Z User-Agent: aws-cli/2.15.0 Python/3.11.6 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAJJ2SONIPEXAMPLE/20260420/us-east-1/route53resolver/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=[calculated-signature] { "MaxResults": 10 }

Sample Response

HTTP/1.1 200 OK Date: Sun, 20 Apr 2026 12:00:04 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 450 x-amzn-RequestId: 7e5d4f6a-8b9c-0d1e-2f3a-4b5c6example Connection: keep-alive { "FirewallRuleTypes": [ { "RuleType": "FirewallAdvancedContentCategory", "Value": "VIOLENCE_AND_HATE_SPEECH", "DisplayName": "Violence and Hate Speech", "Description": "Content category: Violence and Hate Speech" }, { "RuleType": "FirewallAdvancedThreatCategory", "Value": "PHISHING", "DisplayName": "Phishing", "Description": "Advanced threat category: Phishing" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: