AWS CodeCommit

2020/06/24 - AWS CodeCommit - 2 new 8 updated api methods

Changes  This release introduces support for reactions to CodeCommit comments. Users will be able to select from a pre-defined list of emojis to express their reaction to any comments.

PutCommentReaction (new) Link ¶

Adds or updates a reaction to a specified comment for the user whose identity is used to make the request. You can only add or update a reaction for yourself. You cannot add, modify, or delete a reaction for another user.

See also: AWS API Documentation

Request Syntax

client.put_comment_reaction(
    commentId='string',
    reactionValue='string'
)
type commentId

string

param commentId

[REQUIRED]

The ID of the comment to which you want to add or update a reaction.

type reactionValue

string

param reactionValue

[REQUIRED]

The emoji reaction you want to add or update. To remove a reaction, provide a value of blank or null. You can also provide the value of none. For information about emoji reaction values supported in AWS CodeCommit, see the AWS CodeCommit User Guide.

returns

None

GetCommentReactions (new) Link ¶

Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.

See also: AWS API Documentation

Request Syntax

client.get_comment_reactions(
    commentId='string',
    reactionUserArn='string',
    nextToken='string',
    maxResults=123
)
type commentId

string

param commentId

[REQUIRED]

The ID of the comment for which you want to get reactions information.

type reactionUserArn

string

param reactionUserArn

Optional. The Amazon Resource Name (ARN) of the user or identity for which you want to get reaction information.

type nextToken

string

param nextToken

An enumeration token that, when provided in a request, returns the next batch of the results.

type maxResults

integer

param maxResults

A non-zero, non-negative integer used to limit the number of returned results. The default is the same as the allowed maximum, 1,000.

rtype

dict

returns

Response Syntax

{
    'reactionsForComment': [
        {
            'reaction': {
                'emoji': 'string',
                'shortCode': 'string',
                'unicode': 'string'
            },
            'reactionUsers': [
                'string',
            ],
            'reactionsFromDeletedUsersCount': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • reactionsForComment (list) --

      An array of reactions to the specified comment.

      • (dict) --

        Information about the reaction values provided by users on a comment.

        • reaction (dict) --

          The reaction for a specified comment.

          • emoji (string) --

            The Emoji Version 1.0 graphic of the reaction. These graphics are interpreted slightly differently on different operating systems.

          • shortCode (string) --

            The emoji short code for the reaction. Short codes are interpreted slightly differently on different operating systems.

          • unicode (string) --

            The Unicode codepoint for the reaction.

        • reactionUsers (list) --

          The Amazon Resource Names (ARNs) of users who have provided reactions to the comment.

          • (string) --

        • reactionsFromDeletedUsersCount (integer) --

          A numerical count of users who reacted with the specified emoji whose identities have been subsequently deleted from IAM. While these IAM users or roles no longer exist, the reactions might still appear in total reaction counts.

    • nextToken (string) --

      An enumeration token that can be used in a request to return the next batch of the results.

DeleteCommentContent (updated) Link ¶
Changes (response)
{'comment': {'callerReactions': ['string'],
             'reactionCounts': {'string': 'integer'}}}

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

See also: AWS API Documentation

Request Syntax

client.delete_comment_content(
    commentId='string'
)
type commentId

string

param commentId

[REQUIRED]

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

rtype

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

      Information about the comment you just deleted.

      • 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) --

GetComment (updated) Link ¶
Changes (response)
{'comment': {'callerReactions': ['string'],
             'reactionCounts': {'string': 'integer'}}}

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

Request Syntax

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

string

param commentId

[REQUIRED]

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

rtype

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

GetCommentsForComparedCommit (updated) Link ¶
Changes (response)
{'commentsForComparedCommitData': {'comments': {'callerReactions': ['string'],
                                                'reactionCounts': {'string': 'integer'}}}}

Returns information about comments made on the comparison between two commits.

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

Request Syntax

client.get_comments_for_compared_commit(
    repositoryName='string',
    beforeCommitId='string',
    afterCommitId='string',
    nextToken='string',
    maxResults=123
)
type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository where you want to compare commits.

type beforeCommitId

string

param beforeCommitId

To establish the directionality of the comparison, the full commit ID of the before commit.

type afterCommitId

string

param afterCommitId

[REQUIRED]

To establish the directionality of the comparison, the full commit ID of the after commit.

type nextToken

string

param nextToken

An enumeration token that when provided in a request, returns the next batch of the results.

type maxResults

integer

param maxResults

A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments, but you can configure up to 500.

rtype

dict

returns

Response Syntax

{
    'commentsForComparedCommitData': [
        {
            'repositoryName': 'string',
            'beforeCommitId': 'string',
            'afterCommitId': 'string',
            'beforeBlobId': 'string',
            'afterBlobId': 'string',
            'location': {
                'filePath': 'string',
                'filePosition': 123,
                'relativeFileVersion': 'BEFORE'|'AFTER'
            },
            'comments': [
                {
                    '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
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • commentsForComparedCommitData (list) --

      A list of comment objects on the compared commit.

      • (dict) --

        Returns information about comments on the comparison between two commits.

        • repositoryName (string) --

          The name of the repository that contains the compared commits.

        • beforeCommitId (string) --

          The full commit ID of the commit used to establish the before of the comparison.

        • afterCommitId (string) --

          The full commit ID of the commit used to establish the after of the comparison.

        • beforeBlobId (string) --

          The full blob ID of the commit used to establish the before of the comparison.

        • afterBlobId (string) --

          The full blob ID of the commit used to establish the after of the comparison.

        • location (dict) --

          Location information about the comment on the comparison, including the file name, line number, and whether the version of the file where the comment was made is BEFORE or AFTER.

          • filePath (string) --

            The name of the file being compared, including its extension and subdirectory, if any.

          • filePosition (integer) --

            The position of a change in a compared file, in line number format.

          • relativeFileVersion (string) --

            In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

        • comments (list) --

          An array of comment objects. Each comment object contains information about a comment on the comparison between commits.

          • (dict) --

            Returns information about a specific 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) --

    • nextToken (string) --

      An enumeration token that can be used in a request to return the next batch of the results.

GetCommentsForPullRequest (updated) Link ¶
Changes (response)
{'commentsForPullRequestData': {'comments': {'callerReactions': ['string'],
                                             'reactionCounts': {'string': 'integer'}}}}

Returns comments made on a pull request.

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

Request Syntax

client.get_comments_for_pull_request(
    pullRequestId='string',
    repositoryName='string',
    beforeCommitId='string',
    afterCommitId='string',
    nextToken='string',
    maxResults=123
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

type repositoryName

string

param repositoryName

The name of the repository that contains the pull request.

type beforeCommitId

string

param beforeCommitId

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

type afterCommitId

string

param afterCommitId

The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.

type nextToken

string

param nextToken

An enumeration token that, when provided in a request, returns the next batch of the results.

type maxResults

integer

param maxResults

A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.

rtype

dict

returns

Response Syntax

{
    'commentsForPullRequestData': [
        {
            'pullRequestId': 'string',
            'repositoryName': 'string',
            'beforeCommitId': 'string',
            'afterCommitId': 'string',
            'beforeBlobId': 'string',
            'afterBlobId': 'string',
            'location': {
                'filePath': 'string',
                'filePosition': 123,
                'relativeFileVersion': 'BEFORE'|'AFTER'
            },
            'comments': [
                {
                    '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
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • commentsForPullRequestData (list) --

      An array of comment objects on the pull request.

      • (dict) --

        Returns information about comments on a pull request.

        • pullRequestId (string) --

          The system-generated ID of the pull request.

        • repositoryName (string) --

          The name of the repository that contains the pull request.

        • beforeCommitId (string) --

          The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.

        • afterCommitId (string) --

          The full commit ID of the commit that was the tip of the source branch at the time the comment was made.

        • beforeBlobId (string) --

          The full blob ID of the file on which you want to comment on the destination commit.

        • afterBlobId (string) --

          The full blob ID of the file on which you want to comment on the source commit.

        • location (dict) --

          Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).

          • filePath (string) --

            The name of the file being compared, including its extension and subdirectory, if any.

          • filePosition (integer) --

            The position of a change in a compared file, in line number format.

          • relativeFileVersion (string) --

            In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

        • comments (list) --

          An array of comment objects. Each comment object contains information about a comment on the pull request.

          • (dict) --

            Returns information about a specific 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) --

    • nextToken (string) --

      An enumeration token that can be used in a request to return the next batch of the results.

PostCommentForComparedCommit (updated) Link ¶
Changes (response)
{'comment': {'callerReactions': ['string'],
             'reactionCounts': {'string': 'integer'}}}

Posts a comment on the comparison between two commits.

See also: AWS API Documentation

Request Syntax

client.post_comment_for_compared_commit(
    repositoryName='string',
    beforeCommitId='string',
    afterCommitId='string',
    location={
        'filePath': 'string',
        'filePosition': 123,
        'relativeFileVersion': 'BEFORE'|'AFTER'
    },
    content='string',
    clientRequestToken='string'
)
type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository where you want to post a comment on the comparison between commits.

type beforeCommitId

string

param beforeCommitId

To establish the directionality of the comparison, the full commit ID of the before commit. Required for commenting on any commit unless that commit is the initial commit.

type afterCommitId

string

param afterCommitId

[REQUIRED]

To establish the directionality of the comparison, the full commit ID of the after commit.

type location

dict

param location

The location of the comparison where you want to comment.

  • filePath (string) --

    The name of the file being compared, including its extension and subdirectory, if any.

  • filePosition (integer) --

    The position of a change in a compared file, in line number format.

  • relativeFileVersion (string) --

    In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

type content

string

param content

[REQUIRED]

The content of the comment you want to make.

type clientRequestToken

string

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

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'repositoryName': 'string',
    'beforeCommitId': 'string',
    'afterCommitId': 'string',
    'beforeBlobId': 'string',
    'afterBlobId': 'string',
    'location': {
        'filePath': 'string',
        'filePosition': 123,
        'relativeFileVersion': 'BEFORE'|'AFTER'
    },
    '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) --

    • repositoryName (string) --

      The name of the repository where you posted a comment on the comparison between commits.

    • beforeCommitId (string) --

      In the directionality you established, the full commit ID of the before commit.

    • afterCommitId (string) --

      In the directionality you established, the full commit ID of the after commit.

    • beforeBlobId (string) --

      In the directionality you established, the blob ID of the before blob.

    • afterBlobId (string) --

      In the directionality you established, the blob ID of the after blob.

    • location (dict) --

      The location of the comment in the comparison between the two commits.

      • filePath (string) --

        The name of the file being compared, including its extension and subdirectory, if any.

      • filePosition (integer) --

        The position of a change in a compared file, in line number format.

      • relativeFileVersion (string) --

        In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

    • comment (dict) --

      The content of the comment you posted.

      • 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) --

PostCommentForPullRequest (updated) Link ¶
Changes (response)
{'comment': {'callerReactions': ['string'],
             'reactionCounts': {'string': 'integer'}}}

Posts a comment on a pull request.

See also: AWS API Documentation

Request Syntax

client.post_comment_for_pull_request(
    pullRequestId='string',
    repositoryName='string',
    beforeCommitId='string',
    afterCommitId='string',
    location={
        'filePath': 'string',
        'filePosition': 123,
        'relativeFileVersion': 'BEFORE'|'AFTER'
    },
    content='string',
    clientRequestToken='string'
)
type pullRequestId

string

param pullRequestId

[REQUIRED]

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository where you want to post a comment on a pull request.

type beforeCommitId

string

param beforeCommitId

[REQUIRED]

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

type afterCommitId

string

param afterCommitId

[REQUIRED]

The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

type location

dict

param location

The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

  • filePath (string) --

    The name of the file being compared, including its extension and subdirectory, if any.

  • filePosition (integer) --

    The position of a change in a compared file, in line number format.

  • relativeFileVersion (string) --

    In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

type content

string

param content

[REQUIRED]

The content of your comment on the change.

type clientRequestToken

string

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

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'repositoryName': 'string',
    'pullRequestId': 'string',
    'beforeCommitId': 'string',
    'afterCommitId': 'string',
    'beforeBlobId': 'string',
    'afterBlobId': 'string',
    'location': {
        'filePath': 'string',
        'filePosition': 123,
        'relativeFileVersion': 'BEFORE'|'AFTER'
    },
    '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) --

    • repositoryName (string) --

      The name of the repository where you posted a comment on a pull request.

    • pullRequestId (string) --

      The system-generated ID of the pull request.

    • beforeCommitId (string) --

      The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.

    • afterCommitId (string) --

      The full commit ID of the commit in the destination branch where the pull request is merged.

    • beforeBlobId (string) --

      In the directionality of the pull request, the blob ID of the before blob.

    • afterBlobId (string) --

      In the directionality of the pull request, the blob ID of the after blob.

    • location (dict) --

      The location of the change where you posted your comment.

      • filePath (string) --

        The name of the file being compared, including its extension and subdirectory, if any.

      • filePosition (integer) --

        The position of a change in a compared file, in line number format.

      • relativeFileVersion (string) --

        In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.

    • comment (dict) --

      The content of the comment you posted.

      • 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) --

PostCommentReply (updated) Link ¶
Changes (response)
{'comment': {'callerReactions': ['string'],
             'reactionCounts': {'string': 'integer'}}}

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

See also: AWS API Documentation

Request Syntax

client.post_comment_reply(
    inReplyTo='string',
    clientRequestToken='string',
    content='string'
)
type inReplyTo

string

param inReplyTo

[REQUIRED]

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

type clientRequestToken

string

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

This field is autopopulated if not provided.

type content

string

param content

[REQUIRED]

The contents of your reply to a comment.

rtype

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

      Information about the reply to a 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) --

UpdateComment (updated) Link ¶
Changes (response)
{'comment': {'callerReactions': ['string'],
             'reactionCounts': {'string': 'integer'}}}

Replaces the contents of a comment.

See also: AWS API Documentation

Request Syntax

client.update_comment(
    commentId='string',
    content='string'
)
type commentId

string

param commentId

[REQUIRED]

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

type content

string

param content

[REQUIRED]

The updated content to replace the existing content of the comment.

rtype

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

      Information about the updated 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) --