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

Network.AWS.Route53Domains.CheckDomainAvailability

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

Creating a Request

checkDomainAvailability #

Arguments

:: Text	`cdaDomainName`
-> CheckDomainAvailability

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

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

cdaIdNLangCode - Reserved for future use.
cdaDomainName - The name of the domain that you want to get availability for. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

data CheckDomainAvailability #

The CheckDomainAvailability request contains the following elements.

See: checkDomainAvailability smart constructor.

Instances

Eq CheckDomainAvailability #
Methods (==) :: CheckDomainAvailability -> CheckDomainAvailability -> Bool # (/=) :: CheckDomainAvailability -> CheckDomainAvailability -> Bool #
Data CheckDomainAvailability #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CheckDomainAvailability -> c CheckDomainAvailability # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CheckDomainAvailability # toConstr :: CheckDomainAvailability -> Constr # dataTypeOf :: CheckDomainAvailability -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CheckDomainAvailability) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CheckDomainAvailability) # gmapT :: (forall b. Data b => b -> b) -> CheckDomainAvailability -> CheckDomainAvailability # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CheckDomainAvailability -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CheckDomainAvailability -> r # gmapQ :: (forall d. Data d => d -> u) -> CheckDomainAvailability -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CheckDomainAvailability -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CheckDomainAvailability -> m CheckDomainAvailability # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CheckDomainAvailability -> m CheckDomainAvailability # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CheckDomainAvailability -> m CheckDomainAvailability #
Read CheckDomainAvailability #
Methods readsPrec :: Int -> ReadS CheckDomainAvailability # readList :: ReadS [CheckDomainAvailability] # readPrec :: ReadPrec CheckDomainAvailability # readListPrec :: ReadPrec [CheckDomainAvailability] #
Show CheckDomainAvailability #
Methods showsPrec :: Int -> CheckDomainAvailability -> ShowS # show :: CheckDomainAvailability -> String # showList :: [CheckDomainAvailability] -> ShowS #
Generic CheckDomainAvailability #
Associated Types type Rep CheckDomainAvailability :: * -> * # Methods from :: CheckDomainAvailability -> Rep CheckDomainAvailability x # to :: Rep CheckDomainAvailability x -> CheckDomainAvailability #
Hashable CheckDomainAvailability #
Methods hashWithSalt :: Int -> CheckDomainAvailability -> Int # hash :: CheckDomainAvailability -> Int #
ToJSON CheckDomainAvailability #
Methods toJSON :: CheckDomainAvailability -> Value # toEncoding :: CheckDomainAvailability -> Encoding # toJSONList :: [CheckDomainAvailability] -> Value # toEncodingList :: [CheckDomainAvailability] -> Encoding #
NFData CheckDomainAvailability #
Methods rnf :: CheckDomainAvailability -> () #
AWSRequest CheckDomainAvailability #
Associated Types type Rs CheckDomainAvailability :: * # Methods request :: CheckDomainAvailability -> Request CheckDomainAvailability # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CheckDomainAvailability -> ClientResponse -> m (Response CheckDomainAvailability) #
ToHeaders CheckDomainAvailability #
Methods toHeaders :: CheckDomainAvailability -> [Header] #
ToPath CheckDomainAvailability #
Methods toPath :: CheckDomainAvailability -> ByteString #
ToQuery CheckDomainAvailability #
Methods toQuery :: CheckDomainAvailability -> QueryString #
type Rep CheckDomainAvailability #
type Rep CheckDomainAvailability = D1 * (MetaData "CheckDomainAvailability" "Network.AWS.Route53Domains.CheckDomainAvailability" "amazonka-route53-domains-1.6.0-B5QWq1ndTGTHKssuUP1blk" False) (C1 * (MetaCons "CheckDomainAvailability'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_cdaIdNLangCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cdaDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))
type Rs CheckDomainAvailability #
type Rs CheckDomainAvailability = CheckDomainAvailabilityResponse

Request Lenses

cdaIdNLangCode :: Lens' CheckDomainAvailability (Maybe Text) #

Reserved for future use.

cdaDomainName :: Lens' CheckDomainAvailability Text #

The name of the domain that you want to get availability for. Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Destructuring the Response

checkDomainAvailabilityResponse #

Arguments

:: Int	`cdarsResponseStatus`
-> DomainAvailability	`cdarsAvailability`
-> CheckDomainAvailabilityResponse

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

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

cdarsResponseStatus - -- | The response status code.
cdarsAvailability - Whether the domain name is available for registering. Valid values: * AVAILABLE * The domain name is available. * AVAILABLE_RESERVED * The domain name is reserved under specific conditions. * AVAILABLE_PREORDER * The domain name is available and can be preordered. * DONT_KNOW * The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later. * PENDING * The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately. * RESERVED * The domain name has been reserved for another person or organization. * UNAVAILABLE * The domain name is not available. * UNAVAILABLE_PREMIUM * The domain name is not available. * UNAVAILABLE_RESTRICTED * The domain name is forbidden.

data CheckDomainAvailabilityResponse #

The CheckDomainAvailability response includes the following elements.

See: checkDomainAvailabilityResponse smart constructor.

Instances

Eq CheckDomainAvailabilityResponse #
Methods (==) :: CheckDomainAvailabilityResponse -> CheckDomainAvailabilityResponse -> Bool # (/=) :: CheckDomainAvailabilityResponse -> CheckDomainAvailabilityResponse -> Bool #
Data CheckDomainAvailabilityResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CheckDomainAvailabilityResponse -> c CheckDomainAvailabilityResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CheckDomainAvailabilityResponse # toConstr :: CheckDomainAvailabilityResponse -> Constr # dataTypeOf :: CheckDomainAvailabilityResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CheckDomainAvailabilityResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CheckDomainAvailabilityResponse) # gmapT :: (forall b. Data b => b -> b) -> CheckDomainAvailabilityResponse -> CheckDomainAvailabilityResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CheckDomainAvailabilityResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CheckDomainAvailabilityResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CheckDomainAvailabilityResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CheckDomainAvailabilityResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CheckDomainAvailabilityResponse -> m CheckDomainAvailabilityResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CheckDomainAvailabilityResponse -> m CheckDomainAvailabilityResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CheckDomainAvailabilityResponse -> m CheckDomainAvailabilityResponse #
Read CheckDomainAvailabilityResponse #
Methods readsPrec :: Int -> ReadS CheckDomainAvailabilityResponse # readList :: ReadS [CheckDomainAvailabilityResponse] # readPrec :: ReadPrec CheckDomainAvailabilityResponse # readListPrec :: ReadPrec [CheckDomainAvailabilityResponse] #
Show CheckDomainAvailabilityResponse #
Methods showsPrec :: Int -> CheckDomainAvailabilityResponse -> ShowS # show :: CheckDomainAvailabilityResponse -> String # showList :: [CheckDomainAvailabilityResponse] -> ShowS #
Generic CheckDomainAvailabilityResponse #
Associated Types type Rep CheckDomainAvailabilityResponse :: * -> * # Methods from :: CheckDomainAvailabilityResponse -> Rep CheckDomainAvailabilityResponse x # to :: Rep CheckDomainAvailabilityResponse x -> CheckDomainAvailabilityResponse #
NFData CheckDomainAvailabilityResponse #
Methods rnf :: CheckDomainAvailabilityResponse -> () #
type Rep CheckDomainAvailabilityResponse #
type Rep CheckDomainAvailabilityResponse = D1 * (MetaData "CheckDomainAvailabilityResponse" "Network.AWS.Route53Domains.CheckDomainAvailability" "amazonka-route53-domains-1.6.0-B5QWq1ndTGTHKssuUP1blk" False) (C1 * (MetaCons "CheckDomainAvailabilityResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_cdarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_cdarsAvailability") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * DomainAvailability))))

Response Lenses

cdarsResponseStatus :: Lens' CheckDomainAvailabilityResponse Int #

- | The response status code.

cdarsAvailability :: Lens' CheckDomainAvailabilityResponse DomainAvailability #

Whether the domain name is available for registering. Valid values: * AVAILABLE * The domain name is available. * AVAILABLE_RESERVED * The domain name is reserved under specific conditions. * AVAILABLE_PREORDER * The domain name is available and can be preordered. * DONT_KNOW * The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later. * PENDING * The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately. * RESERVED * The domain name has been reserved for another person or organization. * UNAVAILABLE * The domain name is not available. * UNAVAILABLE_PREMIUM * The domain name is not available. * UNAVAILABLE_RESTRICTED * The domain name is forbidden.