ListFirewallRules - Amazon Route 53

ListFirewallRules

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

A single call might return only a partial list of the rules. For information, see MaxResults.

Request Syntax

{ "Action": "string", "FirewallRuleGroupId": "string", "MaxResults": number, "NextToken": "string", "Priority": number }

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.

Action

Optional additional filter for the rules to retrieve.

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

  • ALLOW - Permit the request to go through.

  • ALERT - Permit the request to go through but send an alert to the logs.

  • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

Type: String

Valid Values: ALLOW | BLOCK | ALERT

Required: No

FirewallRuleGroupId

The unique identifier of the firewall rule group that you want to retrieve the rules for.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

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.

If you don't specify a value for MaxResults, Resolver returns up to 100 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 returns 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

Priority

Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

Type: Integer

Required: No

Response Syntax

{ "FirewallRules": [ { "Action": "string", "BlockOverrideDnsType": "string", "BlockOverrideDomain": "string", "BlockOverrideTtl": number, "BlockResponse": "string", "CreationTime": "string", "CreatorRequestId": "string", "FirewallDomainListId": "string", "FirewallRuleGroupId": "string", "ModificationTime": "string", "Name": "string", "Priority": number } ], "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.

FirewallRules

A list of the rules that you have defined.

This might be a partial list of the firewall rules that you've defined. For information, see MaxResults.

Type: Array of FirewallRule 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 Errors.

AccessDeniedException

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

HTTP Status Code: 400

InternalServiceErrorException

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

HTTP Status Code: 400

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 400

ValidationException

HTTP Status Code: 400

See Also

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