Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.Route53Domains.GetDomainSuggestions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 Source #

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 - Undocumented member.
gdsSuggestionCount - Undocumented member.
gdsOnlyAvailable - Undocumented member.

data GetDomainSuggestions Source #

See: getDomainSuggestions smart constructor.

Instances

Eq GetDomainSuggestions Source #
Methods (==) :: GetDomainSuggestions -> GetDomainSuggestions -> Bool # (/=) :: GetDomainSuggestions -> GetDomainSuggestions -> Bool #
Data GetDomainSuggestions Source #
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 Source #
Methods readsPrec :: Int -> ReadS GetDomainSuggestions # readList :: ReadS [GetDomainSuggestions] # readPrec :: ReadPrec GetDomainSuggestions # readListPrec :: ReadPrec [GetDomainSuggestions] #
Show GetDomainSuggestions Source #
Methods showsPrec :: Int -> GetDomainSuggestions -> ShowS # show :: GetDomainSuggestions -> String # showList :: [GetDomainSuggestions] -> ShowS #
Generic GetDomainSuggestions Source #
Associated Types type Rep GetDomainSuggestions :: * -> * # Methods from :: GetDomainSuggestions -> Rep GetDomainSuggestions x # to :: Rep GetDomainSuggestions x -> GetDomainSuggestions #
Hashable GetDomainSuggestions Source #
Methods hashWithSalt :: Int -> GetDomainSuggestions -> Int # hash :: GetDomainSuggestions -> Int #
ToJSON GetDomainSuggestions Source #
Methods toJSON :: GetDomainSuggestions -> Value # toEncoding :: GetDomainSuggestions -> Encoding # toJSONList :: [GetDomainSuggestions] -> Value # toEncodingList :: [GetDomainSuggestions] -> Encoding #
NFData GetDomainSuggestions Source #
Methods rnf :: GetDomainSuggestions -> () #
AWSRequest GetDomainSuggestions Source #
Associated Types type Rs GetDomainSuggestions :: * # Methods request :: GetDomainSuggestions -> Request GetDomainSuggestions # response :: MonadResource m => Logger -> Service -> Proxy * GetDomainSuggestions -> ClientResponse -> m (Response GetDomainSuggestions) #
ToPath GetDomainSuggestions Source #
Methods toPath :: GetDomainSuggestions -> ByteString #
ToHeaders GetDomainSuggestions Source #
Methods toHeaders :: GetDomainSuggestions -> [Header] #
ToQuery GetDomainSuggestions Source #
Methods toQuery :: GetDomainSuggestions -> QueryString #
type Rep GetDomainSuggestions Source #
type Rep GetDomainSuggestions = D1 (MetaData "GetDomainSuggestions" "Network.AWS.Route53Domains.GetDomainSuggestions" "amazonka-route53-domains-1.4.5-4CnKMt89RB29537pw6MzaN" 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 Source #
type Rs GetDomainSuggestions = GetDomainSuggestionsResponse

Request Lenses

gdsDomainName :: Lens' GetDomainSuggestions Text Source #

Undocumented member.

gdsSuggestionCount :: Lens' GetDomainSuggestions Int Source #

Undocumented member.

gdsOnlyAvailable :: Lens' GetDomainSuggestions Bool Source #

Undocumented member.

Destructuring the Response

getDomainSuggestionsResponse Source #

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 - Undocumented member.
gdsrsResponseStatus - -- | The response status code.

data GetDomainSuggestionsResponse Source #

See: getDomainSuggestionsResponse smart constructor.

Instances

Eq GetDomainSuggestionsResponse Source #
Methods (==) :: GetDomainSuggestionsResponse -> GetDomainSuggestionsResponse -> Bool # (/=) :: GetDomainSuggestionsResponse -> GetDomainSuggestionsResponse -> Bool #
Data GetDomainSuggestionsResponse Source #
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 Source #
Methods readsPrec :: Int -> ReadS GetDomainSuggestionsResponse # readList :: ReadS [GetDomainSuggestionsResponse] # readPrec :: ReadPrec GetDomainSuggestionsResponse # readListPrec :: ReadPrec [GetDomainSuggestionsResponse] #
Show GetDomainSuggestionsResponse Source #
Methods showsPrec :: Int -> GetDomainSuggestionsResponse -> ShowS # show :: GetDomainSuggestionsResponse -> String # showList :: [GetDomainSuggestionsResponse] -> ShowS #
Generic GetDomainSuggestionsResponse Source #
Associated Types type Rep GetDomainSuggestionsResponse :: * -> * # Methods from :: GetDomainSuggestionsResponse -> Rep GetDomainSuggestionsResponse x # to :: Rep GetDomainSuggestionsResponse x -> GetDomainSuggestionsResponse #
NFData GetDomainSuggestionsResponse Source #
Methods rnf :: GetDomainSuggestionsResponse -> () #
type Rep GetDomainSuggestionsResponse Source #
type Rep GetDomainSuggestionsResponse = D1 (MetaData "GetDomainSuggestionsResponse" "Network.AWS.Route53Domains.GetDomainSuggestions" "amazonka-route53-domains-1.4.5-4CnKMt89RB29537pw6MzaN" 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] Source #

Undocumented member.

gdsrsResponseStatus :: Lens' GetDomainSuggestionsResponse Int Source #

- | The response status code.