AWS CodeCommit
API Reference (API Version 2015-04-13)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateComment

Replaces the contents of a comment.

Request Syntax

{ "commentId": "string", "content": "string" }

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.

commentId

The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

Type: String

Required: Yes

content

The updated content with which you want to replace the existing content of the comment.

Type: String

Required: Yes

Response Syntax

{ "comment": { "authorArn": "string", "clientRequestToken": "string", "commentId": "string", "content": "string", "creationDate": number, "deleted": boolean, "inReplyTo": "string", "lastModifiedDate": number } }

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.

comment

Information about the updated comment.

Type: Comment object

Errors

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

CommentContentRequiredException

The comment is empty. You must provide some content for a comment. The content cannot be null.

HTTP Status Code: 400

CommentContentSizeLimitExceededException

The comment is too large. Comments are limited to 1,000 characters.

HTTP Status Code: 400

CommentDeletedException

This comment has already been deleted. You cannot edit or delete a deleted comment.

HTTP Status Code: 400

CommentDoesNotExistException

No comment exists with the provided ID. Verify that you have provided the correct ID, and then try again.

HTTP Status Code: 400

CommentIdRequiredException

The comment ID is missing or null. A comment ID is required.

HTTP Status Code: 400

CommentNotCreatedByCallerException

You cannot modify or delete this comment. Only comment authors can modify or delete their comments.

HTTP Status Code: 400

InvalidCommentIdException

The comment ID is not in a valid format. Make sure that you have provided the full comment ID.

HTTP Status Code: 400

Example

Sample Request

>POST / HTTP/1.1 Host: codecommit.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 350 X-Amz-Target: CodeCommit_20150413.UpdateComment X-Amz-Date: 20171025T132023Z User-Agent: aws-cli/1.11.187 Python/2.7.9 Windows/8 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20171025/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE { "commentId": "442b498bEXAMPLE5756813", "content": "Fixed as requested. I'll update the pull request." }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 0728aaa8-EXAMPLE Content-Type: application/x-amz-json-1.1 Content-Length: 847 Date: Wed, 25 Oct 2017 20:20:13 GMT { "comment": { "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", "clientRequestToken": "", "commentId": "442b498bEXAMPLE5756813", "content": "Fixed as requested. I'll update the pull request.", "creationDate": 1508369929.783, "deleted": false, "lastModifiedDate": 1508369929.287 } }

See Also

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