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 |
This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. Contact information for the domain is also returned as part of the output.
Synopsis
- data GetDomainDetail = GetDomainDetail' {
- domainName :: Text
- newGetDomainDetail :: Text -> GetDomainDetail
- getDomainDetail_domainName :: Lens' GetDomainDetail Text
- data GetDomainDetailResponse = GetDomainDetailResponse' {
- abuseContactEmail :: Maybe Text
- abuseContactPhone :: Maybe Text
- adminContact :: Maybe (Sensitive ContactDetail)
- adminPrivacy :: Maybe Bool
- autoRenew :: Maybe Bool
- creationDate :: Maybe POSIX
- dnsSec :: Maybe Text
- dnssecKeys :: Maybe [DnssecKey]
- domainName :: Maybe Text
- expirationDate :: Maybe POSIX
- nameservers :: Maybe [Nameserver]
- registrantContact :: Maybe (Sensitive ContactDetail)
- registrantPrivacy :: Maybe Bool
- registrarName :: Maybe Text
- registrarUrl :: Maybe Text
- registryDomainId :: Maybe Text
- reseller :: Maybe Text
- statusList :: Maybe [Text]
- techContact :: Maybe (Sensitive ContactDetail)
- techPrivacy :: Maybe Bool
- updatedDate :: Maybe POSIX
- whoIsServer :: Maybe Text
- httpStatus :: Int
- newGetDomainDetailResponse :: Int -> GetDomainDetailResponse
- getDomainDetailResponse_abuseContactEmail :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_abuseContactPhone :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_adminContact :: Lens' GetDomainDetailResponse (Maybe ContactDetail)
- getDomainDetailResponse_adminPrivacy :: Lens' GetDomainDetailResponse (Maybe Bool)
- getDomainDetailResponse_autoRenew :: Lens' GetDomainDetailResponse (Maybe Bool)
- getDomainDetailResponse_creationDate :: Lens' GetDomainDetailResponse (Maybe UTCTime)
- getDomainDetailResponse_dnsSec :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_dnssecKeys :: Lens' GetDomainDetailResponse (Maybe [DnssecKey])
- getDomainDetailResponse_domainName :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_expirationDate :: Lens' GetDomainDetailResponse (Maybe UTCTime)
- getDomainDetailResponse_nameservers :: Lens' GetDomainDetailResponse (Maybe [Nameserver])
- getDomainDetailResponse_registrantContact :: Lens' GetDomainDetailResponse (Maybe ContactDetail)
- getDomainDetailResponse_registrantPrivacy :: Lens' GetDomainDetailResponse (Maybe Bool)
- getDomainDetailResponse_registrarName :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_registrarUrl :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_registryDomainId :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_reseller :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_statusList :: Lens' GetDomainDetailResponse (Maybe [Text])
- getDomainDetailResponse_techContact :: Lens' GetDomainDetailResponse (Maybe ContactDetail)
- getDomainDetailResponse_techPrivacy :: Lens' GetDomainDetailResponse (Maybe Bool)
- getDomainDetailResponse_updatedDate :: Lens' GetDomainDetailResponse (Maybe UTCTime)
- getDomainDetailResponse_whoIsServer :: Lens' GetDomainDetailResponse (Maybe Text)
- getDomainDetailResponse_httpStatus :: Lens' GetDomainDetailResponse Int
Creating a Request
data GetDomainDetail Source #
The GetDomainDetail request includes the following element.
See: newGetDomainDetail
smart constructor.
GetDomainDetail' | |
|
Instances
Create a value of GetDomainDetail
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:
GetDomainDetail
, getDomainDetail_domainName
- The name of the domain that you want to get detailed information about.
Request Lenses
getDomainDetail_domainName :: Lens' GetDomainDetail Text Source #
The name of the domain that you want to get detailed information about.
Destructuring the Response
data GetDomainDetailResponse Source #
The GetDomainDetail response includes the following elements.
See: newGetDomainDetailResponse
smart constructor.
GetDomainDetailResponse' | |
|
Instances
newGetDomainDetailResponse Source #
Create a value of GetDomainDetailResponse
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:abuseContactEmail:GetDomainDetailResponse'
, getDomainDetailResponse_abuseContactEmail
- Email address to contact to report incorrect contact information for a
domain, to report that the domain is being used to send spam, to report
that someone is cybersquatting on a domain name, or report some other
type of abuse.
$sel:abuseContactPhone:GetDomainDetailResponse'
, getDomainDetailResponse_abuseContactPhone
- Phone number for reporting abuse.
$sel:adminContact:GetDomainDetailResponse'
, getDomainDetailResponse_adminContact
- Provides details about the domain administrative contact.
$sel:adminPrivacy:GetDomainDetailResponse'
, getDomainDetailResponse_adminPrivacy
- Specifies whether contact information is concealed from WHOIS queries.
If the value is true
, WHOIS ("who is") queries return contact
information either for Amazon Registrar (for .com, .net, and .org
domains) or for our registrar associate, Gandi (for all other TLDs). If
the value is false
, WHOIS queries return the information that you
entered for the admin contact.
GetDomainDetailResponse
, getDomainDetailResponse_autoRenew
- Specifies whether the domain registration is set to renew automatically.
$sel:creationDate:GetDomainDetailResponse'
, getDomainDetailResponse_creationDate
- The date when the domain was created as found in the response to a WHOIS
query. The date and time is in Unix time format and Coordinated
Universal time (UTC).
$sel:dnsSec:GetDomainDetailResponse'
, getDomainDetailResponse_dnsSec
- Deprecated.
$sel:dnssecKeys:GetDomainDetailResponse'
, getDomainDetailResponse_dnssecKeys
- A complex type that contains information about the DNSSEC configuration.
GetDomainDetail
, getDomainDetailResponse_domainName
- The name of a domain.
$sel:expirationDate:GetDomainDetailResponse'
, getDomainDetailResponse_expirationDate
- The date when the registration for the domain is set to expire. The date
and time is in Unix time format and Coordinated Universal time (UTC).
$sel:nameservers:GetDomainDetailResponse'
, getDomainDetailResponse_nameservers
- The name servers of the domain.
$sel:registrantContact:GetDomainDetailResponse'
, getDomainDetailResponse_registrantContact
- Provides details about the domain registrant.
$sel:registrantPrivacy:GetDomainDetailResponse'
, getDomainDetailResponse_registrantPrivacy
- Specifies whether contact information is concealed from WHOIS queries.
If the value is true
, WHOIS ("who is") queries return contact
information either for Amazon Registrar (for .com, .net, and .org
domains) or for our registrar associate, Gandi (for all other TLDs). If
the value is false
, WHOIS queries return the information that you
entered for the registrant contact (domain owner).
$sel:registrarName:GetDomainDetailResponse'
, getDomainDetailResponse_registrarName
- Name of the registrar of the domain as identified in the registry.
Domains with a .com, .net, or .org TLD are registered by Amazon
Registrar. All other domains are registered by our registrar associate,
Gandi. The value for domains that are registered by Gandi is
"GANDI SAS"
.
$sel:registrarUrl:GetDomainDetailResponse'
, getDomainDetailResponse_registrarUrl
- Web address of the registrar.
$sel:registryDomainId:GetDomainDetailResponse'
, getDomainDetailResponse_registryDomainId
- Reserved for future use.
$sel:reseller:GetDomainDetailResponse'
, getDomainDetailResponse_reseller
- Reseller of the domain. Domains registered or transferred using Route 53
domains will have "Amazon"
as the reseller.
$sel:statusList:GetDomainDetailResponse'
, getDomainDetailResponse_statusList
- An array of domain name status codes, also known as Extensible
Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of
what each code means, go to the ICANN website
and search for epp status codes
. (Search on the ICANN website; web
searches sometimes return an old version of the document.)
$sel:techContact:GetDomainDetailResponse'
, getDomainDetailResponse_techContact
- Provides details about the domain technical contact.
$sel:techPrivacy:GetDomainDetailResponse'
, getDomainDetailResponse_techPrivacy
- Specifies whether contact information is concealed from WHOIS queries.
If the value is true
, WHOIS ("who is") queries return contact
information either for Amazon Registrar (for .com, .net, and .org
domains) or for our registrar associate, Gandi (for all other TLDs). If
the value is false
, WHOIS queries return the information that you
entered for the technical contact.
$sel:updatedDate:GetDomainDetailResponse'
, getDomainDetailResponse_updatedDate
- The last updated date of the domain as found in the response to a WHOIS
query. The date and time is in Unix time format and Coordinated
Universal time (UTC).
$sel:whoIsServer:GetDomainDetailResponse'
, getDomainDetailResponse_whoIsServer
- The fully qualified name of the WHOIS server that can answer the WHOIS
query for the domain.
$sel:httpStatus:GetDomainDetailResponse'
, getDomainDetailResponse_httpStatus
- The response's http status code.
Response Lenses
getDomainDetailResponse_abuseContactEmail :: Lens' GetDomainDetailResponse (Maybe Text) Source #
Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.
getDomainDetailResponse_abuseContactPhone :: Lens' GetDomainDetailResponse (Maybe Text) Source #
Phone number for reporting abuse.
getDomainDetailResponse_adminContact :: Lens' GetDomainDetailResponse (Maybe ContactDetail) Source #
Provides details about the domain administrative contact.
getDomainDetailResponse_adminPrivacy :: Lens' GetDomainDetailResponse (Maybe Bool) Source #
Specifies whether contact information is concealed from WHOIS queries.
If the value is true
, WHOIS ("who is") queries return contact
information either for Amazon Registrar (for .com, .net, and .org
domains) or for our registrar associate, Gandi (for all other TLDs). If
the value is false
, WHOIS queries return the information that you
entered for the admin contact.
getDomainDetailResponse_autoRenew :: Lens' GetDomainDetailResponse (Maybe Bool) Source #
Specifies whether the domain registration is set to renew automatically.
getDomainDetailResponse_creationDate :: Lens' GetDomainDetailResponse (Maybe UTCTime) Source #
The date when the domain was created as found in the response to a WHOIS query. The date and time is in Unix time format and Coordinated Universal time (UTC).
getDomainDetailResponse_dnsSec :: Lens' GetDomainDetailResponse (Maybe Text) Source #
Deprecated.
getDomainDetailResponse_dnssecKeys :: Lens' GetDomainDetailResponse (Maybe [DnssecKey]) Source #
A complex type that contains information about the DNSSEC configuration.
getDomainDetailResponse_domainName :: Lens' GetDomainDetailResponse (Maybe Text) Source #
The name of a domain.
getDomainDetailResponse_expirationDate :: Lens' GetDomainDetailResponse (Maybe UTCTime) Source #
The date when the registration for the domain is set to expire. The date and time is in Unix time format and Coordinated Universal time (UTC).
getDomainDetailResponse_nameservers :: Lens' GetDomainDetailResponse (Maybe [Nameserver]) Source #
The name servers of the domain.
getDomainDetailResponse_registrantContact :: Lens' GetDomainDetailResponse (Maybe ContactDetail) Source #
Provides details about the domain registrant.
getDomainDetailResponse_registrantPrivacy :: Lens' GetDomainDetailResponse (Maybe Bool) Source #
Specifies whether contact information is concealed from WHOIS queries.
If the value is true
, WHOIS ("who is") queries return contact
information either for Amazon Registrar (for .com, .net, and .org
domains) or for our registrar associate, Gandi (for all other TLDs). If
the value is false
, WHOIS queries return the information that you
entered for the registrant contact (domain owner).
getDomainDetailResponse_registrarName :: Lens' GetDomainDetailResponse (Maybe Text) Source #
Name of the registrar of the domain as identified in the registry.
Domains with a .com, .net, or .org TLD are registered by Amazon
Registrar. All other domains are registered by our registrar associate,
Gandi. The value for domains that are registered by Gandi is
"GANDI SAS"
.
getDomainDetailResponse_registrarUrl :: Lens' GetDomainDetailResponse (Maybe Text) Source #
Web address of the registrar.
getDomainDetailResponse_registryDomainId :: Lens' GetDomainDetailResponse (Maybe Text) Source #
Reserved for future use.
getDomainDetailResponse_reseller :: Lens' GetDomainDetailResponse (Maybe Text) Source #
Reseller of the domain. Domains registered or transferred using Route 53
domains will have "Amazon"
as the reseller.
getDomainDetailResponse_statusList :: Lens' GetDomainDetailResponse (Maybe [Text]) Source #
An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status codes and an explanation of
what each code means, go to the ICANN website
and search for epp status codes
. (Search on the ICANN website; web
searches sometimes return an old version of the document.)
getDomainDetailResponse_techContact :: Lens' GetDomainDetailResponse (Maybe ContactDetail) Source #
Provides details about the domain technical contact.
getDomainDetailResponse_techPrivacy :: Lens' GetDomainDetailResponse (Maybe Bool) Source #
Specifies whether contact information is concealed from WHOIS queries.
If the value is true
, WHOIS ("who is") queries return contact
information either for Amazon Registrar (for .com, .net, and .org
domains) or for our registrar associate, Gandi (for all other TLDs). If
the value is false
, WHOIS queries return the information that you
entered for the technical contact.
getDomainDetailResponse_updatedDate :: Lens' GetDomainDetailResponse (Maybe UTCTime) Source #
The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Unix time format and Coordinated Universal time (UTC).
getDomainDetailResponse_whoIsServer :: Lens' GetDomainDetailResponse (Maybe Text) Source #
The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.
getDomainDetailResponse_httpStatus :: Lens' GetDomainDetailResponse Int Source #
The response's http status code.