GetDNSView
Retrieves information about a DNS view.
Request Syntax
GET /dns-views/dnsViewId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- dnsViewId
-
The ID of the DNS view to retrieve information about.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[-.a-zA-Z0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"clientToken": "string",
"createdAt": "string",
"description": "string",
"dnssecValidation": "string",
"ednsClientSubnet": "string",
"firewallRulesFailOpen": "string",
"globalResolverId": "string",
"id": "string",
"name": "string",
"status": "string",
"updatedAt": "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.
- arn
-
Amazon Resource Name (ARN) of the DNS view.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023} - clientToken
-
A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same
clientTokenhas the same result every time.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- createdAt
-
The time and date the DNS view was creates on.
Type: Timestamp
- description
-
Description of the DNS view.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- dnssecValidation
-
Specifies whether DNSSEC is enabled or disabled for the DNS view.
Type: String
Valid Values:
ENABLED | DISABLED - ednsClientSubnet
-
Specifies whether edns0 client subnet is enabled.
Type: String
Valid Values:
ENABLED | DISABLED - firewallRulesFailOpen
-
Specifies the DNS Firewall failure mode configuration. When enabled, the DNS Firewall allows DNS queries to proceed if it's unable to properly evaluate them. When disabled, the DNS Firewall blocks DNS queries it's unable to evaluate.
Type: String
Valid Values:
ENABLED | DISABLED - globalResolverId
-
ID of the Global Resolver the DNS view is associated to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[-.a-zA-Z0-9]+ - id
-
ID of the DNS view.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[-.a-zA-Z0-9]+ - name
-
Name of the DNS view.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
(?!^[0-9]+$)([a-zA-Z0-9-_/' ']+) - status
-
Operational status of the DNS view.
Type: String
Valid Values:
CREATING | OPERATIONAL | UPDATING | ENABLING | DISABLING | DISABLED | DELETING - updatedAt
-
The time and date the DNS view was updated on.
Type: Timestamp
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: