Copyright	(c) 2013-2021 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

Amazonka.Route53Domains.UpdateDomainContactPrivacy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.

This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.

By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. For more information on our privacy practices, see https://aws.amazon.com/privacy/.

Synopsis

Creating a Request

data UpdateDomainContactPrivacy Source #

The UpdateDomainContactPrivacy request includes the following elements.

See: newUpdateDomainContactPrivacy smart constructor.

Constructors

UpdateDomainContactPrivacy'

Fields

techPrivacy :: Maybe Bool
Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the technical contact.
registrantPrivacy :: Maybe Bool
Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).
adminPrivacy :: Maybe Bool
Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the admin contact.
domainName :: Text
The name of the domain that you want to update the privacy setting for.

Instances

Instances details

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

newUpdateDomainContactPrivacy Source #

Arguments

:: Text	`$sel:domainName:UpdateDomainContactPrivacy'`
-> UpdateDomainContactPrivacy

Create a value of UpdateDomainContactPrivacy 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:UpdateDomainContactPrivacy', updateDomainContactPrivacy_techPrivacy - Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the technical contact.

$sel:registrantPrivacy:UpdateDomainContactPrivacy', updateDomainContactPrivacy_registrantPrivacy - Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

$sel:adminPrivacy:UpdateDomainContactPrivacy', updateDomainContactPrivacy_adminPrivacy - Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the admin contact.

$sel:domainName:UpdateDomainContactPrivacy', updateDomainContactPrivacy_domainName - The name of the domain that you want to update the privacy setting for.

Request Lenses

updateDomainContactPrivacy_techPrivacy :: Lens' UpdateDomainContactPrivacy (Maybe Bool) Source #

Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the technical contact.

updateDomainContactPrivacy_registrantPrivacy :: Lens' UpdateDomainContactPrivacy (Maybe Bool) Source #

Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

updateDomainContactPrivacy_adminPrivacy :: Lens' UpdateDomainContactPrivacy (Maybe Bool) Source #

Whether you want to conceal contact information from WHOIS queries. If you specify 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 you specify false, WHOIS queries return the information that you entered for the admin contact.

updateDomainContactPrivacy_domainName :: Lens' UpdateDomainContactPrivacy Text Source #

The name of the domain that you want to update the privacy setting for.

Destructuring the Response

data UpdateDomainContactPrivacyResponse Source #

The UpdateDomainContactPrivacy response includes the following element.

See: newUpdateDomainContactPrivacyResponse smart constructor.

Constructors

UpdateDomainContactPrivacyResponse'
Fields httpStatus :: Int The response's http status code. operationId :: Text Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Instances

Instances details

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

newUpdateDomainContactPrivacyResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDomainContactPrivacyResponse'`
-> Text	`$sel:operationId:UpdateDomainContactPrivacyResponse'`
-> UpdateDomainContactPrivacyResponse

Create a value of UpdateDomainContactPrivacyResponse 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:httpStatus:UpdateDomainContactPrivacyResponse', updateDomainContactPrivacyResponse_httpStatus - The response's http status code.

$sel:operationId:UpdateDomainContactPrivacyResponse', updateDomainContactPrivacyResponse_operationId - Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Response Lenses

updateDomainContactPrivacyResponse_httpStatus :: Lens' UpdateDomainContactPrivacyResponse Int Source #

The response's http status code.

updateDomainContactPrivacyResponse_operationId :: Lens' UpdateDomainContactPrivacyResponse Text Source #

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.