CodeCommit / Client / get_comment

get_comment#

CodeCommit.Client.get_comment(**kwargs)#

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

response = client.get_comment(
    commentId='string'
)

Parameters:

commentId (string) –

[REQUIRED]

The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

Return type:

dict

Returns:

Response Syntax

{
    'comment': {
        'commentId': 'string',
        'content': 'string',
        'inReplyTo': 'string',
        'creationDate': datetime(2015, 1, 1),
        'lastModifiedDate': datetime(2015, 1, 1),
        'authorArn': 'string',
        'deleted': True|False,
        'clientRequestToken': 'string',
        'callerReactions': [
            'string',
        ],
        'reactionCounts': {
            'string': 123
        }
    }
}

Response Structure

(dict) –
- comment (dict) –
  
  The contents of the comment.
  - commentId (string) –
    
    The system-generated comment ID.
  - content (string) –
    
    The content of the comment.
  - inReplyTo (string) –
    
    The ID of the comment for which this comment is a reply, if any.
  - creationDate (datetime) –
    
    The date and time the comment was created, in timestamp format.
  - lastModifiedDate (datetime) –
    
    The date and time the comment was most recently modified, in timestamp format.
  - authorArn (string) –
    
    The Amazon Resource Name (ARN) of the person who posted the comment.
  - deleted (boolean) –
    
    A Boolean value indicating whether the comment has been deleted.
  - clientRequestToken (string) –
    
    A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
  - callerReactions (list) –
    
    The emoji reactions to a comment, if any, submitted by the user whose credentials are associated with the call to the API.
    - (string) –
  - reactionCounts (dict) –
    
    A string to integer map that represents the number of individual users who have responded to a comment with the specified reactions.
    - (string) –
      - (integer) –

Exceptions

CodeCommit.Client.exceptions.CommentDoesNotExistException
CodeCommit.Client.exceptions.CommentDeletedException
CodeCommit.Client.exceptions.CommentIdRequiredException
CodeCommit.Client.exceptions.InvalidCommentIdException
CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException
CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException
CodeCommit.Client.exceptions.EncryptionKeyDisabledException
CodeCommit.Client.exceptions.EncryptionKeyNotFoundException
CodeCommit.Client.exceptions.EncryptionKeyUnavailableException