Skip to content

Get Domain Suggestions

route53domains_get_domain_suggestions R Documentation

The GetDomainSuggestions operation returns a list of suggested domain names

Description

The GetDomainSuggestions operation returns a list of suggested domain names.

Usage

route53domains_get_domain_suggestions(DomainName, SuggestionCount,
  OnlyAvailable)

Arguments

DomainName

[required] 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 . 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.

SuggestionCount

[required] The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

OnlyAvailable

[required] 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.

Value

A list with the following syntax: 

list(
  SuggestionsList = list(
    list(
      DomainName = "string",
      Availability = "string"
    )
  )
)

Request syntax

svc$get_domain_suggestions(
  DomainName = "string",
  SuggestionCount = 123,
  OnlyAvailable = TRUE|FALSE
)