Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListFirewallRules

Lists all DNS firewall rules for a DNS view with pagination support.

Request Syntax


GET /firewall-rules?filters&dnsview_id=dnsViewId&max_results=maxResults&next_token=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

dnsViewId

ID of the DNS view.

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

Pattern: [-.a-zA-Z0-9]+

Required: Yes

filters

Values to filter the results.

maxResults

The maximum number of results to retrieve in a single call.

nextToken

A pagination token used for large sets of results that can't be returned in a single response.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "firewallRules": [ 
      { 
         "action": "string",
         "blockOverrideDnsType": "string",
         "blockOverrideDomain": "string",
         "blockOverrideTtl": number,
         "blockResponse": "string",
         "confidenceThreshold": "string",
         "createdAt": "string",
         "description": "string",
         "dnsAdvancedProtection": "string",
         "dnsViewId": "string",
         "firewallDomainListId": "string",
         "id": "string",
         "name": "string",
         "priority": number,
         "queryType": "string",
         "status": "string",
         "updatedAt": "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.

firewallRules

List of the firewall rules and information about them.

Type: Array of FirewallRulesItem objects

nextToken

A pagination token used for large sets of results that can't be returned in a single response. Provide this token in the next call to get the results not returned in this call.

Type: String

Errors

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

AccessDeniedException

You don't have permission to perform this operation. Check your IAM permissions and try again.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. Try again later.

retryAfterSeconds: Number of seconds in which the caller can retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found. Verify the resource ID and try again.

resourceId: The unique ID of the resource referenced in the failed request.
resourceType: The resource type of the resource referenced in the failed request.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to too many requests. Wait a moment and try again.

quotaCode: The quota code recognized by the AWS Service Quotas service.
retryAfterSeconds: Number of seconds in which the caller can retry the request.
serviceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 429

ValidationException

The input parameters are invalid. Check the parameter values and try again.

fieldList: The list of fields that aren't valid.
reason: Reason the request failed validation.

HTTP Status Code: 400