GetDomainSuggestions
The GetDomainSuggestions operation returns a list of suggested domain names.
Request Syntax
{
"DomainName": "string
",
"OnlyAvailable": boolean
,
"SuggestionCount": 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.
- DomainName
-
A domain name that you want to use as the basis for a list of possible domain names. 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
.
inexample.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.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
-
- OnlyAvailable
-
If
OnlyAvailable
istrue
, Route 53 returns only domain names that are available. IfOnlyAvailable
isfalse
, Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can callcheckDomainAvailability
for each suggestion.Type: Boolean
Required: Yes
- SuggestionCount
-
The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.
Type: Integer
Required: Yes
Response Syntax
{
"SuggestionsList": [
{
"Availability": "string",
"DomainName": "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.
- SuggestionsList
-
A list of possible domain names. If you specified
true
forOnlyAvailable
in the request, the list contains only domains that are available for registration.Type: Array of DomainSuggestion objects
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
GetDomainSuggestions Example
This example illustrates one usage of GetDomainSuggestions.
Sample Request
POST / HTTP/1.1
host:route53domains.us-east-1.amazonaws.com
x-amz-date:20140711T205230Z
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.GetDomainSuggestions
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]
{
"DomainName": "example.com",
"SuggestionCount": 8,
"OnlyAvailable": false
}
Sample Response
HTTP/1.1 200
Content-Length:[number of characters in the JSON string]
{
"SuggestionsList":[
{"DomainName": "example.net"},
{"DomainName": "example.org"},
{"DomainName": "example.io"},
{"DomainName": "example.com.au"},
{"DomainName": "example.co.uk"},
{"DomainName": "example.de"},
{"DomainName": "example.co"},
{"DomainName": "example.info"}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: