CodeCommit / Paginator / GetCommentsForComparedCommit

GetCommentsForComparedCommit

class CodeCommit.Paginator.GetCommentsForComparedCommit

paginator = client.get_paginator('get_comments_for_compared_commit')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCommit.Client.get_comments_for_compared_commit().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    repositoryName='string',
    beforeCommitId='string',
    afterCommitId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• repositoryName (string) –

  [REQUIRED]

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

• beforeCommitId (string) – To establish the directionality of the comparison, the full commit ID of the before commit.

• afterCommitId (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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

    A token to resume pagination.