Network.AWS.Route53Domains.GetDomainSuggestions

The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).

Creating a Request

getDomainSuggestions

Arguments

:: Text

gdsDomainName

-> Int

gdsSuggestionCount

-> Bool

gdsOnlyAvailable

-> GetDomainSuggestions

Creates a value of GetDomainSuggestions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdsDomainName - A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide .
• gdsSuggestionCount - The number of suggested domain names that you want Amazon Route 53 to return.
• gdsOnlyAvailable - If OnlyAvailable is true , Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false , Amazon 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.

data GetDomainSuggestions

See: getDomainSuggestions smart constructor.

Instances

Eq GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

(==) :: GetDomainSuggestions -> GetDomainSuggestions -> Bool

(/=) :: GetDomainSuggestions -> GetDomainSuggestions -> Bool

Data GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDomainSuggestions -> c GetDomainSuggestions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDomainSuggestions

toConstr :: GetDomainSuggestions -> Constr

dataTypeOf :: GetDomainSuggestions -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetDomainSuggestions)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDomainSuggestions)

gmapT :: (forall b. Data b => b -> b) -> GetDomainSuggestions -> GetDomainSuggestions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDomainSuggestions -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDomainSuggestions -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDomainSuggestions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDomainSuggestions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDomainSuggestions -> m GetDomainSuggestions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDomainSuggestions -> m GetDomainSuggestions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDomainSuggestions -> m GetDomainSuggestions

Read GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

readsPrec :: Int -> ReadS GetDomainSuggestions

readList :: ReadS [GetDomainSuggestions]

readPrec :: ReadPrec GetDomainSuggestions

readListPrec :: ReadPrec [GetDomainSuggestions]

Show GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

showsPrec :: Int -> GetDomainSuggestions -> ShowS

show :: GetDomainSuggestions -> String

showList :: [GetDomainSuggestions] -> ShowS

Generic GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Associated Types

type Rep GetDomainSuggestions :: Type -> Type

Methods

from :: GetDomainSuggestions -> Rep GetDomainSuggestions x

to :: Rep GetDomainSuggestions x -> GetDomainSuggestions

Hashable GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

hashWithSalt :: Int -> GetDomainSuggestions -> Int

hash :: GetDomainSuggestions -> Int

ToJSON GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

toJSON :: GetDomainSuggestions -> Value

toEncoding :: GetDomainSuggestions -> Encoding

toJSONList :: [GetDomainSuggestions] -> Value

toEncodingList :: [GetDomainSuggestions] -> Encoding

AWSRequest GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Associated Types

type Rs GetDomainSuggestions :: Type

Methods

request :: GetDomainSuggestions -> Request GetDomainSuggestions

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetDomainSuggestions -> ClientResponse -> m (Response GetDomainSuggestions)

ToHeaders GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

toHeaders :: GetDomainSuggestions -> [Header]

ToPath GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

toPath :: GetDomainSuggestions -> ByteString

ToQuery GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

toQuery :: GetDomainSuggestions -> QueryString

NFData GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

rnf :: GetDomainSuggestions -> ()

type Rep GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

type Rep GetDomainSuggestions = D1 (MetaData "GetDomainSuggestions" "Network.AWS.Route53Domains.GetDomainSuggestions" "amazonka-route53-domains-1.6.1-1AoNz7bHDzI3lZpMthxnFZ" False) (C1 (MetaCons "GetDomainSuggestions'" PrefixI True) (S1 (MetaSel (Just "_gdsDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_gdsSuggestionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_gdsOnlyAvailable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))

type Rs GetDomainSuggestions

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

type Rs GetDomainSuggestions = GetDomainSuggestionsResponse

Request Lenses

gdsDomainName :: Lens' GetDomainSuggestions Text

A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide .

gdsSuggestionCount :: Lens' GetDomainSuggestions Int

The number of suggested domain names that you want Amazon Route 53 to return.

gdsOnlyAvailable :: Lens' GetDomainSuggestions Bool

If OnlyAvailable is true , Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false , Amazon 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.

Destructuring the Response

getDomainSuggestionsResponse

Arguments

:: Int

gdsrsResponseStatus

-> GetDomainSuggestionsResponse

Creates a value of GetDomainSuggestionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdsrsSuggestionsList - A list of possible domain names. If you specified true for OnlyAvailable in the request, the list contains only domains that are available for registration.
• gdsrsResponseStatus - -- | The response status code.

data GetDomainSuggestionsResponse

See: getDomainSuggestionsResponse smart constructor.

Instances

Eq GetDomainSuggestionsResponse

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

(==) :: GetDomainSuggestionsResponse -> GetDomainSuggestionsResponse -> Bool

(/=) :: GetDomainSuggestionsResponse -> GetDomainSuggestionsResponse -> Bool

Data GetDomainSuggestionsResponse

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDomainSuggestionsResponse -> c GetDomainSuggestionsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDomainSuggestionsResponse

toConstr :: GetDomainSuggestionsResponse -> Constr

dataTypeOf :: GetDomainSuggestionsResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetDomainSuggestionsResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDomainSuggestionsResponse)

gmapT :: (forall b. Data b => b -> b) -> GetDomainSuggestionsResponse -> GetDomainSuggestionsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDomainSuggestionsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDomainSuggestionsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDomainSuggestionsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDomainSuggestionsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDomainSuggestionsResponse -> m GetDomainSuggestionsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDomainSuggestionsResponse -> m GetDomainSuggestionsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDomainSuggestionsResponse -> m GetDomainSuggestionsResponse

Read GetDomainSuggestionsResponse

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

readsPrec :: Int -> ReadS GetDomainSuggestionsResponse

readList :: ReadS [GetDomainSuggestionsResponse]

readPrec :: ReadPrec GetDomainSuggestionsResponse

readListPrec :: ReadPrec [GetDomainSuggestionsResponse]

Show GetDomainSuggestionsResponse

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

showsPrec :: Int -> GetDomainSuggestionsResponse -> ShowS

show :: GetDomainSuggestionsResponse -> String

showList :: [GetDomainSuggestionsResponse] -> ShowS

Generic GetDomainSuggestionsResponse

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Associated Types

type Rep GetDomainSuggestionsResponse :: Type -> Type

Methods

from :: GetDomainSuggestionsResponse -> Rep GetDomainSuggestionsResponse x

to :: Rep GetDomainSuggestionsResponse x -> GetDomainSuggestionsResponse

NFData GetDomainSuggestionsResponse

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

Methods

rnf :: GetDomainSuggestionsResponse -> ()

type Rep GetDomainSuggestionsResponse

Defined in Network.AWS.Route53Domains.GetDomainSuggestions

type Rep GetDomainSuggestionsResponse = D1 (MetaData "GetDomainSuggestionsResponse" "Network.AWS.Route53Domains.GetDomainSuggestions" "amazonka-route53-domains-1.6.1-1AoNz7bHDzI3lZpMthxnFZ" False) (C1 (MetaCons "GetDomainSuggestionsResponse'" PrefixI True) (S1 (MetaSel (Just "_gdsrsSuggestionsList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DomainSuggestion])) :*: S1 (MetaSel (Just "_gdsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

gdsrsSuggestionsList :: Lens' GetDomainSuggestionsResponse [DomainSuggestion]

A list of possible domain names. If you specified true for OnlyAvailable in the request, the list contains only domains that are available for registration.

gdsrsResponseStatus :: Lens' GetDomainSuggestionsResponse Int

• - | The response status code.