Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetComment

Returns the content of a comment made on a change, file, or commit in a repository.

Note

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.

Request Syntax


{
   "commentId": "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 unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

Type: String

Required: Yes

Response Syntax


{
   "comment": { 
      "authorArn": "string",
      "callerReactions": [ "string" ],
      "clientRequestToken": "string",
      "commentId": "string",
      "content": "string",
      "creationDate": number,
      "deleted": boolean,
      "inReplyTo": "string",
      "lastModifiedDate": number,
      "reactionCounts": { 
         "string" : 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

The contents of the comment.

Type: Comment object

Errors

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

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 used 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

EncryptionIntegrityChecksFailedException

An encryption integrity check failed.

HTTP Status Code: 500

EncryptionKeyAccessDeniedException

An encryption key could not be accessed.

HTTP Status Code: 400

EncryptionKeyDisabledException

The encryption key is disabled.

HTTP Status Code: 400

EncryptionKeyNotFoundException

No encryption key was found.

HTTP Status Code: 400

EncryptionKeyUnavailableException

The encryption key is not available.

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

Examples

Example

This example illustrates one usage of GetComment.

Sample Request


>POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 350
X-Amz-Target: CodeCommit_20150413.GetComment
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": "ff30b348EXAMPLEb9aa670f"
}

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:18:13 GMT

{
   "comment": { 
      "authorArn": "arn:aws:iam::123456789012:user/Li_Juan",
      "clientRequestToken": "123Example",
      "commentId": "ff30b348EXAMPLEb9aa670f",
      "content": "Whoops - I meant to add this comment to the line, but I don't see how to delete it.",
      "creationDate": 1508369768.142,
      "deleted": false,
      "commentId": "",
      "lastModifiedDate": 1508369842.278,
      "reactionCounts":{
         "THUMBSUP": 20,
         "THUMBSDOWN": 2,
         "SMILE": 5,
         "ANGRY": 7
        }
   }
}