amazonka-route53-domains-1.6.0: Amazon Route 53 Domains SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Route53Domains.GetDomainSuggestions

Contents

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

Synopsis

Creating a Request

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 # 
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 # 
Show GetDomainSuggestions # 
Generic GetDomainSuggestions # 
Hashable GetDomainSuggestions # 
ToJSON GetDomainSuggestions # 
NFData GetDomainSuggestions # 

Methods

rnf :: GetDomainSuggestions -> () #

AWSRequest GetDomainSuggestions # 
ToHeaders GetDomainSuggestions # 
ToPath GetDomainSuggestions # 
ToQuery GetDomainSuggestions # 
type Rep GetDomainSuggestions # 
type Rep GetDomainSuggestions = D1 * (MetaData "GetDomainSuggestions" "Network.AWS.Route53Domains.GetDomainSuggestions" "amazonka-route53-domains-1.6.0-B5QWq1ndTGTHKssuUP1blk" False) (C1 * (MetaCons "GetDomainSuggestions'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdsDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdsSuggestionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_gdsOnlyAvailable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool)))))
type Rs GetDomainSuggestions # 

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 #

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 # 
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 # 
Show GetDomainSuggestionsResponse # 
Generic GetDomainSuggestionsResponse # 
NFData GetDomainSuggestionsResponse # 
type Rep GetDomainSuggestionsResponse # 
type Rep GetDomainSuggestionsResponse = D1 * (MetaData "GetDomainSuggestionsResponse" "Network.AWS.Route53Domains.GetDomainSuggestions" "amazonka-route53-domains-1.6.0-B5QWq1ndTGTHKssuUP1blk" False) (C1 * (MetaCons "GetDomainSuggestionsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdsrsSuggestionsList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [DomainSuggestion]))) (S1 * (MetaSel (Just Symbol "_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.