getDomainSuggestions method
The GetDomainSuggestions operation returns a list of suggested domain names.
May throw InvalidInput. May throw UnsupportedTLD.
Parameter 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
.
Parameter onlyAvailable
:
If OnlyAvailable
is true
, Route 53 returns only
domain names that are available. If OnlyAvailable
is
false
, Route 53 returns domain names without checking whether
they're available to be registered. To determine whether the domain is
available, you can call checkDomainAvailability
for each
suggestion.
Parameter suggestionCount
:
The number of suggested domain names that you want Route 53 to return.
Specify a value between 1 and 50.
Implementation
Future<GetDomainSuggestionsResponse> getDomainSuggestions({
required String domainName,
required bool onlyAvailable,
required int suggestionCount,
}) async {
ArgumentError.checkNotNull(domainName, 'domainName');
_s.validateStringLength(
'domainName',
domainName,
0,
255,
isRequired: true,
);
ArgumentError.checkNotNull(onlyAvailable, 'onlyAvailable');
ArgumentError.checkNotNull(suggestionCount, 'suggestionCount');
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'Route53Domains_v20140515.GetDomainSuggestions'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'DomainName': domainName,
'OnlyAvailable': onlyAvailable,
'SuggestionCount': suggestionCount,
},
);
return GetDomainSuggestionsResponse.fromJson(jsonResponse.body);
}