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

Amazonka.Route53Domains.GetDomainDetail

Description

This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output.

Synopsis

Creating a Request

data GetDomainDetail Source #

The GetDomainDetail request includes the following element.

See: newGetDomainDetail smart constructor.

Constructors

GetDomainDetail' 

Fields

  • domainName :: Text

    The name of the domain that you want to get detailed information about.

Instances

Instances details
Eq GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Read GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Show GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Generic GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Associated Types

type Rep GetDomainDetail :: Type -> Type #

NFData GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Methods

rnf :: GetDomainDetail -> () #

Hashable GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

ToJSON GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

AWSRequest GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Associated Types

type AWSResponse GetDomainDetail #

ToHeaders GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

ToPath GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

ToQuery GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

type Rep GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

type Rep GetDomainDetail = D1 ('MetaData "GetDomainDetail" "Amazonka.Route53Domains.GetDomainDetail" "libZSservicesZSamazonka-route53-domainsZSamazonka-route53-domains" 'False) (C1 ('MetaCons "GetDomainDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetDomainDetail Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

newGetDomainDetail Source #

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:

$sel:domainName: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.

Constructors

GetDomainDetailResponse' 

Fields

  • techPrivacy :: Maybe Bool

    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.

  • dnsSec :: Maybe Text

    Reserved for future use.

  • whoIsServer :: Maybe Text

    The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

  • registryDomainId :: Maybe Text

    Reserved for future use.

  • registrantPrivacy :: Maybe Bool

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

  • updatedDate :: Maybe POSIX

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

  • adminPrivacy :: Maybe Bool

    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.

  • autoRenew :: Maybe Bool

    Specifies whether the domain registration is set to renew automatically.

  • abuseContactPhone :: Maybe Text

    Phone number for reporting abuse.

  • registrarUrl :: Maybe Text

    Web address of the registrar.

  • abuseContactEmail :: Maybe Text

    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.

  • expirationDate :: Maybe POSIX

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

  • creationDate :: Maybe POSIX

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

  • registrarName :: Maybe Text

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

  • reseller :: Maybe Text

    Reseller of the domain. Domains registered or transferred using Route 53 domains will have "Amazon" as the reseller.

  • statusList :: Maybe [Text]

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

  • httpStatus :: Int

    The response's http status code.

  • domainName :: Text

    The name of a domain.

  • nameservers :: [Nameserver]

    The name of the domain.

  • adminContact :: Sensitive ContactDetail

    Provides details about the domain administrative contact.

  • registrantContact :: Sensitive ContactDetail

    Provides details about the domain registrant.

  • techContact :: Sensitive ContactDetail

    Provides details about the domain technical contact.

Instances

Instances details
Eq GetDomainDetailResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Show GetDomainDetailResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Generic GetDomainDetailResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Associated Types

type Rep GetDomainDetailResponse :: Type -> Type #

NFData GetDomainDetailResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

Methods

rnf :: GetDomainDetailResponse -> () #

type Rep GetDomainDetailResponse Source # 
Instance details

Defined in Amazonka.Route53Domains.GetDomainDetail

type Rep GetDomainDetailResponse = D1 ('MetaData "GetDomainDetailResponse" "Amazonka.Route53Domains.GetDomainDetail" "libZSservicesZSamazonka-route53-domainsZSamazonka-route53-domains" 'False) (C1 ('MetaCons "GetDomainDetailResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "techPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dnsSec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "whoIsServer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "registryDomainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "registrantPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "updatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "adminPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "autoRenew") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "abuseContactPhone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "registrarUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "abuseContactEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "registrarName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reseller") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "nameservers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Nameserver]))) :*: (S1 ('MetaSel ('Just "adminContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ContactDetail)) :*: (S1 ('MetaSel ('Just "registrantContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ContactDetail)) :*: S1 ('MetaSel ('Just "techContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive ContactDetail))))))))

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: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:dnsSec:GetDomainDetailResponse', getDomainDetailResponse_dnsSec - Reserved for future use.

$sel:whoIsServer:GetDomainDetailResponse', getDomainDetailResponse_whoIsServer - The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

$sel:registryDomainId:GetDomainDetailResponse', getDomainDetailResponse_registryDomainId - Reserved for future use.

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

$sel:autoRenew:GetDomainDetailResponse', getDomainDetailResponse_autoRenew - Specifies whether the domain registration is set to renew automatically.

$sel:abuseContactPhone:GetDomainDetailResponse', getDomainDetailResponse_abuseContactPhone - Phone number for reporting abuse.

$sel:registrarUrl:GetDomainDetailResponse', getDomainDetailResponse_registrarUrl - Web address of the registrar.

$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: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: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: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: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:httpStatus:GetDomainDetailResponse', getDomainDetailResponse_httpStatus - The response's http status code.

$sel:domainName:GetDomainDetail', getDomainDetailResponse_domainName - The name of a domain.

$sel:nameservers:GetDomainDetailResponse', getDomainDetailResponse_nameservers - The name of the domain.

$sel:adminContact:GetDomainDetailResponse', getDomainDetailResponse_adminContact - Provides details about the domain administrative contact.

$sel:registrantContact:GetDomainDetailResponse', getDomainDetailResponse_registrantContact - Provides details about the domain registrant.

$sel:techContact:GetDomainDetailResponse', getDomainDetailResponse_techContact - Provides details about the domain technical contact.

Response Lenses

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_whoIsServer :: Lens' GetDomainDetailResponse (Maybe Text) Source #

The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

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_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_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_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_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_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_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_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_adminContact :: Lens' GetDomainDetailResponse ContactDetail Source #

Provides details about the domain administrative contact.

getDomainDetailResponse_techContact :: Lens' GetDomainDetailResponse ContactDetail Source #

Provides details about the domain technical contact.