Menu
Amazon Route 53
API Reference

UpdateDomainContactPrivacy

This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Request Syntax

{
   "AdminPrivacy": boolean,
   "DomainName": "string",
   "RegistrantPrivacy": boolean,
   "TechPrivacy": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AdminPrivacy

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Required: No

DomainName

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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

RegistrantPrivacy

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Required: No

TechPrivacy

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Required: No

Response Syntax

{
   "OperationId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

OperationId

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

Type: String

Length Constraints: Maximum length of 255.

Errors

For information about the errors that are common to all actions, see Common Errors.

DuplicateRequest

The request is already in progress for the domain.

HTTP Status Code: 400

InvalidInput

The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

HTTP Status Code: 400

OperationLimitExceeded

The number of operations or jobs running exceeded the allowed threshold for the account.

HTTP Status Code: 400

TLDRulesViolation

The top-level domain does not support this operation.

HTTP Status Code: 400

UnsupportedTLD

Amazon Route 53 does not support this top-level domain (TLD).

HTTP Status Code: 400

Example

UpdateDomainContactPrivacy Example

Sample Request

POST / HTTP/1.1
host:route53domains.us-east-1.amazonaws.com
x-amz-date:20140711T205230Z
authorization:AWS4-HMAC-SHA256
              Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,
              SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
              Signature=[calculated-signature]
x-amz-target:Route53Domains_v20140515.UpdateDomainContactPrivacy
user-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
"DomainName":"example.com",
"AdminPrivacy":true,
"RegistrantPrivacy":true,
"TechPrivacy":true,
}

Sample Response

HTTP/1.1 200
Content-Length:[number of characters in the JSON string]
{
"OperationId":"777bc5da-fbf7-482c-b2ba-8946884a7dd6"
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: