Menu
Amazon Route 53
API Reference

UpdateTrafficPolicyComment

Updates the comment for a specified traffic policy version.

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.

Id

The value of Id for the traffic policy that you want to update the comment for.

Length Constraints: Minimum length of 1. Maximum length of 36.

Version

The value of Version for the traffic policy that you want to update the comment for.

Valid Range: Minimum value of 1. Maximum value of 1000.

Request Body

The request accepts the following data in XML format.

UpdateTrafficPolicyCommentRequest

Root level tag for the UpdateTrafficPolicyCommentRequest parameters.

Required: Yes

Comment

The new comment for the specified traffic policy and version.

Type: String

Length Constraints: Maximum length of 1024.

Required: Yes

Response Syntax

HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<UpdateTrafficPolicyCommentResponse>
   <TrafficPolicy>
      <Comment>string</Comment>
      <Document>string</Document>
      <Id>string</Id>
      <Name>string</Name>
      <Type>string</Type>
      <Version>integer</Version>
   </TrafficPolicy>
</UpdateTrafficPolicyCommentResponse>

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.

UpdateTrafficPolicyCommentResponse

Root level tag for the UpdateTrafficPolicyCommentResponse parameters.

Required: Yes

TrafficPolicy

A complex type that contains settings for the specified traffic policy.

Type: TrafficPolicy object

Errors

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

ConcurrentModification

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

HTTP Status Code: 400

InvalidInput

The input is not valid.

HTTP Status Code: 400

NoSuchTrafficPolicy

No traffic policy exists with the specified ID.

HTTP Status Code: 404

Examples

Example Request

Copy
POST /2013-04-01/trafficpolicy/12345678-abcd-9876-fedc-1a2b3c4de5f6/42 HTTP/1.1 <?xml version="1.0" encoding="UTF-8"?> <UpdateTrafficPolicyCommentRequest xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <Comment>Updated comment</Comment> </UpdateTrafficPolicyCommentRequest>

Example Response

Copy
HTTP/1.1 200 OK <?xml version="1.0" encoding="UTF-8"?> <UpdateTrafficPolicyCommentResponse xmlns="https://route53.amazonaws.com/doc/2013-04-01/"> <Id>12345678-abcd-9876-fedc-1a2b3c4de5f6</Id> <VersionNumber>42</VersionNumber> <Name>MyTrafficPolicy</Name> <Type>A</Type> <Document>definition of the traffic policy</Document> <Comment>Updated comment</Comment> </UpdateTrafficPolicyCommentResponse>

See Also

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