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

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). 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

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.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
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).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
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.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
domainName :: Text
The name of the domain that you want to update the privacy setting for.

Instances

Instances details

ToJSON UpdateDomainContactPrivacy Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy Methods toJSON :: UpdateDomainContactPrivacy -> Value # toEncoding :: UpdateDomainContactPrivacy -> Encoding # toJSONList :: [UpdateDomainContactPrivacy] -> Value # toEncodingList :: [UpdateDomainContactPrivacy] -> Encoding #
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 #
AWSRequest UpdateDomainContactPrivacy Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy Associated Types type AWSResponse UpdateDomainContactPrivacy # Methods request :: (Service -> Service) -> UpdateDomainContactPrivacy -> Request UpdateDomainContactPrivacy # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDomainContactPrivacy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomainContactPrivacy))) #
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 #
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 #
NFData UpdateDomainContactPrivacy Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy Methods rnf :: UpdateDomainContactPrivacy -> () #
Eq UpdateDomainContactPrivacy Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy Methods (==) :: UpdateDomainContactPrivacy -> UpdateDomainContactPrivacy -> Bool # (/=) :: UpdateDomainContactPrivacy -> UpdateDomainContactPrivacy -> Bool #
Hashable UpdateDomainContactPrivacy Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy Methods hashWithSalt :: Int -> UpdateDomainContactPrivacy -> Int # hash :: UpdateDomainContactPrivacy -> Int #
type AWSResponse UpdateDomainContactPrivacy Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy type AWSResponse UpdateDomainContactPrivacy = UpdateDomainContactPrivacyResponse
type Rep UpdateDomainContactPrivacy Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy type Rep UpdateDomainContactPrivacy = D1 ('MetaData "UpdateDomainContactPrivacy" "Amazonka.Route53Domains.UpdateDomainContactPrivacy" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "UpdateDomainContactPrivacy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "adminPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "registrantPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "techPrivacy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateDomainContactPrivacy Source #

Arguments

:: Text	`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: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.

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

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

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

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

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

UpdateDomainContactPrivacy, updateDomainContactPrivacy_domainName - The name of the domain that you want to update the privacy setting for.

Request Lenses

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.

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

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

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

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.

You must specify the same privacy setting for the administrative, registrant, and technical contacts.

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 operationId :: Maybe Text Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail. httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData UpdateDomainContactPrivacyResponse Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy Methods rnf :: UpdateDomainContactPrivacyResponse -> () #
Eq UpdateDomainContactPrivacyResponse Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy Methods (==) :: UpdateDomainContactPrivacyResponse -> UpdateDomainContactPrivacyResponse -> Bool # (/=) :: UpdateDomainContactPrivacyResponse -> UpdateDomainContactPrivacyResponse -> Bool #
type Rep UpdateDomainContactPrivacyResponse Source #
Instance details Defined in Amazonka.Route53Domains.UpdateDomainContactPrivacy type Rep UpdateDomainContactPrivacyResponse = D1 ('MetaData "UpdateDomainContactPrivacyResponse" "Amazonka.Route53Domains.UpdateDomainContactPrivacy" "amazonka-route53-domains-2.0-6iruRSkjgLuDp958hFs0e" 'False) (C1 ('MetaCons "UpdateDomainContactPrivacyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateDomainContactPrivacyResponse Source #

Arguments

:: Int	`$sel:httpStatus: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:

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

$sel:httpStatus:UpdateDomainContactPrivacyResponse', updateDomainContactPrivacyResponse_httpStatus - The response's http status code.

Response Lenses

updateDomainContactPrivacyResponse_operationId :: Lens' UpdateDomainContactPrivacyResponse (Maybe Text) Source #

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

updateDomainContactPrivacyResponse_httpStatus :: Lens' UpdateDomainContactPrivacyResponse Int Source #

The response's http status code.