[ aws . codecommit ]

get-comment

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-comment
--comment-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--comment-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view details of a comment

This example demonstrates how to view details of a comment with the system-generated comment ID of ‘ff30b348EXAMPLEb9aa670f’:

aws codecommit get-comment --comment-id ff30b348EXAMPLEb9aa670f

Output:

{
 "comment": {
    "authorArn": "arn:aws:iam::111111111111: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
  }
}

Output

comment -> (structure)

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 -> (timestamp)

The date and time the comment was created, in timestamp format.

lastModifiedDate -> (timestamp)

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 -> (map)

A string to integer map that represents the number of individual users who have responded to a comment with the specified reactions.

key -> (string)

value -> (integer)