Route53Domains / Client / update_domain_contact_privacy

update_domain_contact_privacy#

Route53Domains.Client.update_domain_contact_privacy(**kwargs)#

This operation updates the specified domain contact’s privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase “REDACTED FOR PRIVACY”, or “On behalf of <domain name> owner.”

Note

While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all 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.

Warning

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

See also: AWS API Documentation

Request Syntax

response = client.update_domain_contact_privacy(
    DomainName='string',
    AdminPrivacy=True|False,
    RegistrantPrivacy=True|False,
    TechPrivacy=True|False,
    BillingPrivacy=True|False
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

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

  • AdminPrivacy (boolean) –

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the admin contact.

    Note

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

  • RegistrantPrivacy (boolean) –

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

    Note

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

  • TechPrivacy (boolean) –

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the technical contact.

    Note

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

  • BillingPrivacy (boolean) –

    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 or for our registrar associate, Gandi. If you specify false, WHOIS queries return the information that you entered for the billing contact.

    Note

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

Return type:

dict

Returns:

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

  • (dict) –

    The UpdateDomainContactPrivacy response includes the following element.

    • OperationId (string) –

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

Exceptions

  • Route53Domains.Client.exceptions.InvalidInput

  • Route53Domains.Client.exceptions.DuplicateRequest

  • Route53Domains.Client.exceptions.TLDRulesViolation

  • Route53Domains.Client.exceptions.OperationLimitExceeded

  • Route53Domains.Client.exceptions.UnsupportedTLD