Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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

data CheckDomainAvailability Source #

The CheckDomainAvailability request contains the following elements.

See: newCheckDomainAvailability smart constructor.

Constructors

CheckDomainAvailability'

Fields

idnLangCode :: Maybe Text
Reserved for future use.
domainName :: Text
The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
The domain name can contain only the following characters:
- Letters a through z. Domain names are not case sensitive.
- Numbers 0 through 9.
- Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
- Period (.) to separate the labels in the name, such as the . in example.com.
Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

Instances

Instances details

ToJSON CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods toJSON :: CheckDomainAvailability -> Value # toEncoding :: CheckDomainAvailability -> Encoding # toJSONList :: [CheckDomainAvailability] -> Value # toEncodingList :: [CheckDomainAvailability] -> Encoding #
ToHeaders CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods toHeaders :: CheckDomainAvailability -> [Header] #
ToPath CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods toPath :: CheckDomainAvailability -> ByteString #
ToQuery CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods toQuery :: CheckDomainAvailability -> QueryString #
AWSRequest CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Associated Types type AWSResponse CheckDomainAvailability # Methods request :: (Service -> Service) -> CheckDomainAvailability -> Request CheckDomainAvailability # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CheckDomainAvailability -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CheckDomainAvailability))) #
Generic CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Associated Types type Rep CheckDomainAvailability :: Type -> Type # Methods from :: CheckDomainAvailability -> Rep CheckDomainAvailability x # to :: Rep CheckDomainAvailability x -> CheckDomainAvailability #
Read CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods readsPrec :: Int -> ReadS CheckDomainAvailability # readList :: ReadS [CheckDomainAvailability] # readPrec :: ReadPrec CheckDomainAvailability # readListPrec :: ReadPrec [CheckDomainAvailability] #
Show CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods showsPrec :: Int -> CheckDomainAvailability -> ShowS # show :: CheckDomainAvailability -> String # showList :: [CheckDomainAvailability] -> ShowS #
NFData CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods rnf :: CheckDomainAvailability -> () #
Eq CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods (==) :: CheckDomainAvailability -> CheckDomainAvailability -> Bool # (/=) :: CheckDomainAvailability -> CheckDomainAvailability -> Bool #
Hashable CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods hashWithSalt :: Int -> CheckDomainAvailability -> Int # hash :: CheckDomainAvailability -> Int #
type AWSResponse CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability type AWSResponse CheckDomainAvailability = CheckDomainAvailabilityResponse
type Rep CheckDomainAvailability Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability type Rep CheckDomainAvailability = D1 ('MetaData "CheckDomainAvailability" "Amazonka.Route53Domains.CheckDomainAvailability" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "CheckDomainAvailability'" 'PrefixI 'True) (S1 ('MetaSel ('Just "idnLangCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCheckDomainAvailability Source #

Arguments

:: Text	`CheckDomainAvailability`
-> CheckDomainAvailability

Create a value of CheckDomainAvailability with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:idnLangCode:CheckDomainAvailability', checkDomainAvailability_idnLangCode - Reserved for future use.

CheckDomainAvailability, checkDomainAvailability_domainName - The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

Request Lenses

checkDomainAvailability_idnLangCode :: Lens' CheckDomainAvailability (Maybe Text) Source #

Reserved for future use.

checkDomainAvailability_domainName :: Lens' CheckDomainAvailability Text Source #

The name of the domain that you want to get availability for. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

Letters a through z. Domain names are not case sensitive.
Numbers 0 through 9.
Hyphen (-). You can't specify a hyphen at the beginning or end of a label.
Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53. For more information, see Formatting Internationalized Domain Names.

Destructuring the Response

data CheckDomainAvailabilityResponse Source #

The CheckDomainAvailability response includes the following elements.

See: newCheckDomainAvailabilityResponse smart constructor.

Constructors

CheckDomainAvailabilityResponse'

Fields

availability :: Maybe DomainAvailability
Whether the domain name is available for registering.
You can register only domains designated as AVAILABLE.
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. 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CheckDomainAvailabilityResponse Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Associated Types type Rep CheckDomainAvailabilityResponse :: Type -> Type # Methods from :: CheckDomainAvailabilityResponse -> Rep CheckDomainAvailabilityResponse x # to :: Rep CheckDomainAvailabilityResponse x -> CheckDomainAvailabilityResponse #
Read CheckDomainAvailabilityResponse Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods readsPrec :: Int -> ReadS CheckDomainAvailabilityResponse # readList :: ReadS [CheckDomainAvailabilityResponse] # readPrec :: ReadPrec CheckDomainAvailabilityResponse # readListPrec :: ReadPrec [CheckDomainAvailabilityResponse] #
Show CheckDomainAvailabilityResponse Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods showsPrec :: Int -> CheckDomainAvailabilityResponse -> ShowS # show :: CheckDomainAvailabilityResponse -> String # showList :: [CheckDomainAvailabilityResponse] -> ShowS #
NFData CheckDomainAvailabilityResponse Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods rnf :: CheckDomainAvailabilityResponse -> () #
Eq CheckDomainAvailabilityResponse Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability Methods (==) :: CheckDomainAvailabilityResponse -> CheckDomainAvailabilityResponse -> Bool # (/=) :: CheckDomainAvailabilityResponse -> CheckDomainAvailabilityResponse -> Bool #
type Rep CheckDomainAvailabilityResponse Source #
Instance details Defined in Amazonka.Route53Domains.CheckDomainAvailability type Rep CheckDomainAvailabilityResponse = D1 ('MetaData "CheckDomainAvailabilityResponse" "Amazonka.Route53Domains.CheckDomainAvailability" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "CheckDomainAvailabilityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "availability") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainAvailability)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCheckDomainAvailabilityResponse Source #

Arguments

:: Int	`$sel:httpStatus:CheckDomainAvailabilityResponse'`
-> CheckDomainAvailabilityResponse

Create a value of CheckDomainAvailabilityResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CheckDomainAvailabilityResponse, checkDomainAvailabilityResponse_availability - Whether the domain name is available for registering.

You can register only domains designated as AVAILABLE.

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

$sel:httpStatus:CheckDomainAvailabilityResponse', checkDomainAvailabilityResponse_httpStatus - The response's http status code.

Response Lenses

checkDomainAvailabilityResponse_availability :: Lens' CheckDomainAvailabilityResponse (Maybe DomainAvailability) Source #

Whether the domain name is available for registering.

You can register only domains designated as AVAILABLE.

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

checkDomainAvailabilityResponse_httpStatus :: Lens' CheckDomainAvailabilityResponse Int Source #

The response's http status code.