Copyright | (c) 2013-2015 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 |
This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
See: AWS API Reference for CheckDomainAvailability.
- checkDomainAvailability :: Text -> CheckDomainAvailability
- data CheckDomainAvailability
- cdaIdNLangCode :: Lens' CheckDomainAvailability (Maybe Text)
- cdaDomainName :: Lens' CheckDomainAvailability Text
- checkDomainAvailabilityResponse :: Int -> DomainAvailability -> CheckDomainAvailabilityResponse
- data CheckDomainAvailabilityResponse
- cdarsStatus :: Lens' CheckDomainAvailabilityResponse Int
- cdarsAvailability :: Lens' CheckDomainAvailabilityResponse DomainAvailability
Creating a Request
checkDomainAvailability Source
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:
data CheckDomainAvailability Source
The CheckDomainAvailability request contains the following elements.
See: checkDomainAvailability
smart constructor.
Request Lenses
cdaIdNLangCode :: Lens' CheckDomainAvailability (Maybe Text) Source
Reserved for future use.
cdaDomainName :: Lens' CheckDomainAvailability Text Source
The name of a domain.
Type: String
Default: None
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.
Required: Yes
Destructuring the Response
checkDomainAvailabilityResponse Source
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:
data CheckDomainAvailabilityResponse Source
The CheckDomainAvailability response includes the following elements.
See: checkDomainAvailabilityResponse
smart constructor.
Response Lenses
cdarsStatus :: Lens' CheckDomainAvailabilityResponse Int Source
The response status code.
cdarsAvailability :: Lens' CheckDomainAvailabilityResponse DomainAvailability Source
Whether the domain name is available for registering.
You can only register domains designated as AVAILABLE
.
Type: String
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.UNAVAILABLE
– The domain name is not available.UNAVAILABLE_PREMIUM
– The domain name is not available.UNAVAILABLE_RESTRICTED
– The domain name is forbidden.RESERVED
– The domain name has been reserved for another person or organization.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.