UpdateHostedZoneComment - Amazon Route 53
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

UpdateHostedZoneComment

Updates the comment for a specified hosted zone.

Request Syntax

POST /2013-04-01/hostedzone/Id HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <UpdateHostedZoneCommentRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <Comment>string</Comment> </UpdateHostedZoneCommentRequest>

URI Request Parameters

The request uses the following URI parameters.

Id

The ID for the hosted zone that you want to update the comment for.

Length Constraints: Maximum length of 32.

Required: Yes

Request Body

The request accepts the following data in XML format.

UpdateHostedZoneCommentRequest

Root level tag for the UpdateHostedZoneCommentRequest parameters.

Required: Yes

Comment

The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <UpdateHostedZoneCommentResponse> <HostedZone> <CallerReference>string</CallerReference> <Config> <Comment>string</Comment> <PrivateZone>boolean</PrivateZone> </Config> <Id>string</Id> <LinkedService> <Description>string</Description> <ServicePrincipal>string</ServicePrincipal> </LinkedService> <Name>string</Name> <ResourceRecordSetCount>long</ResourceRecordSetCount> </HostedZone> </UpdateHostedZoneCommentResponse>

Response Elements

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

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

UpdateHostedZoneCommentResponse

Root level tag for the UpdateHostedZoneCommentResponse parameters.

Required: Yes

HostedZone

A complex type that contains the response to the UpdateHostedZoneComment request.

Type: HostedZone object

Errors

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

InvalidInput

The input is not valid.

HTTP Status Code: 400

NoSuchHostedZone

No hosted zone exists with the ID that you specified.

HTTP Status Code: 404

PriorRequestNotComplete

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

HTTP Status Code: 400

Examples

Example Request

This example illustrates one usage of UpdateHostedZoneComment.

POST /2013-04-01/hostedzone/hosted zone ID HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <UpdateHostedZoneCommentRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <Comment>for internal testing</Comment> </UpdateHostedZoneCommentRequest>

Example Response

This example illustrates one usage of UpdateHostedZoneComment.

HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <UpdateHostedZoneCommentResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <HostedZone> <Id>/hostedzone/Z1D633PJN98FT9</Id> <Name>example.com</Name> <CallerReference>2014-10-15T01:36:41.958Z</CallerReference> <Config> <Comment>for internal testing</Comment> <PrivateZone>false</PrivateZone> </Config> <ResourceRecordSetCount>42</ResourceRecordSetCount> </HostedZone> </UpdateHostedZoneCommentResponse>

See Also

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