PostCommentReply - AWS CodeCommit

PostCommentReply

Posts a comment in reply to an existing comment on a comparison between commits or a pull request.

Request Syntax

{ "clientRequestToken": "string", "content": "string", "inReplyTo": "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.

clientRequestToken

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.

Type: String

Required: No

content

The contents of your reply to a comment.

Type: String

Required: Yes

inReplyTo

The system-generated ID of the comment to which you want to reply. 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

Information about the reply to a comment.

Type: Comment object

Errors

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

ClientRequestTokenRequiredException

A client request token is required. A client request token is an 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.

HTTP Status Code: 400

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 10,240 characters.

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

IdempotencyParameterMismatchException

The client request token is not valid. Either the token is not in a valid format, or the token has been used in a previous request and cannot be reused.

HTTP Status Code: 400

InvalidClientRequestTokenException

The client request token is not valid.

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 PostCommentReply.

Sample Request

>POST / HTTP/1.1 Host: codecommit.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 350 X-Amz-Target: CodeCommit_20150413.PostCommentReply 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 { "clientRequestToken": "123Example", "content": "Good catch. I'll remove them.", "commentId": "abcd1234EXAMPLEb5678efgh" }

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::123456789012:user/Li_Juan", "clientRequestToken": "123Example", "commentId": "442b498bEXAMPLE5756813", "content": "Good catch. I'll remove them.", "creationDate": 1508369829.136, "deleted": false, "lastModifiedDate": 150836912.221, "callerReactions": [], "reactionCounts": [] } }

See Also

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