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).

Parameters:

• DomainName (string): The basis for your domain suggestion search, a string with (or without) top-level domain specified.
• SuggestionCount (int): The number of domain suggestions to be returned, maximum 50, minimum 1.
• OnlyAvailable (bool): If true, availability check will be performed on suggestion results, and only available domains will be returned. If false, suggestions will be returned without checking whether the domain is actually available, and caller will have to call checkDomainAvailability for each suggestion to determine availability for registration.

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
• gdsSuggestionCount
• gdsOnlyAvailable

data GetDomainSuggestions

See: getDomainSuggestions smart constructor.

Instances

Eq GetDomainSuggestions

Methods

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

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

Data 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

Methods

readsPrec :: Int -> ReadS GetDomainSuggestions

readList :: ReadS [GetDomainSuggestions]

readPrec :: ReadPrec GetDomainSuggestions

readListPrec :: ReadPrec [GetDomainSuggestions]

Show GetDomainSuggestions

Methods

showsPrec :: Int -> GetDomainSuggestions -> ShowS

show :: GetDomainSuggestions -> String

showList :: [GetDomainSuggestions] -> ShowS

Generic GetDomainSuggestions

Associated Types

type Rep GetDomainSuggestions :: * -> *

Methods

from :: GetDomainSuggestions -> Rep GetDomainSuggestions x

to :: Rep GetDomainSuggestions x -> GetDomainSuggestions

Hashable GetDomainSuggestions

Methods

hashWithSalt :: Int -> GetDomainSuggestions -> Int

hash :: GetDomainSuggestions -> Int

NFData GetDomainSuggestions

Methods

rnf :: GetDomainSuggestions -> ()

AWSRequest GetDomainSuggestions

Associated Types

type Rs GetDomainSuggestions :: *

Methods

request :: GetDomainSuggestions -> Request GetDomainSuggestions

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

ToPath GetDomainSuggestions

Methods

toPath :: GetDomainSuggestions -> ByteString

ToHeaders GetDomainSuggestions

Methods

toHeaders :: GetDomainSuggestions -> [Header]

ToQuery GetDomainSuggestions

Methods

toQuery :: GetDomainSuggestions -> QueryString

ToJSON GetDomainSuggestions

Methods

toJSON :: GetDomainSuggestions -> Value

toEncoding :: GetDomainSuggestions -> Encoding

type Rep GetDomainSuggestions

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

type Rs GetDomainSuggestions

type Rs GetDomainSuggestions = GetDomainSuggestionsResponse

Request Lenses

gdsDomainName :: Lens' GetDomainSuggestions Text

Undocumented member.

gdsSuggestionCount :: Lens' GetDomainSuggestions Int

Undocumented member.

gdsOnlyAvailable :: Lens' GetDomainSuggestions Bool

Undocumented member.

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
• gdsrsResponseStatus

data GetDomainSuggestionsResponse

See: getDomainSuggestionsResponse smart constructor.

Instances

Eq GetDomainSuggestionsResponse

Methods

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

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

Data GetDomainSuggestionsResponse

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

Methods

readsPrec :: Int -> ReadS GetDomainSuggestionsResponse

readList :: ReadS [GetDomainSuggestionsResponse]

readPrec :: ReadPrec GetDomainSuggestionsResponse

readListPrec :: ReadPrec [GetDomainSuggestionsResponse]

Show GetDomainSuggestionsResponse

Methods

showsPrec :: Int -> GetDomainSuggestionsResponse -> ShowS

show :: GetDomainSuggestionsResponse -> String

showList :: [GetDomainSuggestionsResponse] -> ShowS

Generic GetDomainSuggestionsResponse

Associated Types

type Rep GetDomainSuggestionsResponse :: * -> *

Methods

from :: GetDomainSuggestionsResponse -> Rep GetDomainSuggestionsResponse x

to :: Rep GetDomainSuggestionsResponse x -> GetDomainSuggestionsResponse

NFData GetDomainSuggestionsResponse

Methods

rnf :: GetDomainSuggestionsResponse -> ()

type Rep GetDomainSuggestionsResponse

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

Response Lenses

gdsrsSuggestionsList :: Lens' GetDomainSuggestionsResponse [DomainSuggestion]

Undocumented member.

gdsrsResponseStatus :: Lens' GetDomainSuggestionsResponse Int

The response status code.