Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CheckDomainAvailability

This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

Request Syntax


{
   "DomainName": "string",
   "IdnLangCode": "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.

DomainName

The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

IdnLangCode

Reserved for future use.

Type: String

Length Constraints: Maximum length of 3.

Required: No

Response Syntax


{
   "Availability": "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.

Availability

Whether the domain name is available for registering.

Note

You can register only domains designated as AVAILABLE.

Valid values:

AVAILABLE: The domain name is available.
AVAILABLE_RESERVED: The domain name is reserved under specific conditions.
AVAILABLE_PREORDER: The domain name is available and can be preordered.
DONT_KNOW: The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
INVALID_NAME_FOR_TLD: The TLD isn't valid. For example, it can contain characters that aren't allowed.
PENDING: The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
RESERVED: The domain name has been reserved for another person or organization.
UNAVAILABLE: The domain name is not available.
UNAVAILABLE_PREMIUM: The domain name is not available.
UNAVAILABLE_RESTRICTED: The domain name is forbidden.

Type: String

Errors

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

InvalidInput

The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

HTTP Status Code: 400

UnsupportedTLD

Amazon Route 53 does not support this top-level domain (TLD).

HTTP Status Code: 400

Examples

CheckDomainAvailability Example

This example illustrates one usage of CheckDomainAvailability.

Sample Request


POST / HTTP/1.1
host:route53domains.us-east-1.amazonaws.com
x-amz-date:20140711T205225Z
authorization:AWS4-HMAC-SHA256
              Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,
              SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
              Signature=[calculated-signature]
x-amz-target:Route53Domains_v20140515.CheckDomainAvailability
user-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
connections:Keep-Alive
{
   "DomainName":"example.com"
}

Sample Response


HTTP/1.1 200
Content-Length:[number of characters in the JSON string]
{
   "Availability":"AVAILABLE"
}