CodeCommit / Client / list_file_commit_history

list_file_commit_history#

CodeCommit.Client.list_file_commit_history(**kwargs)#

Retrieves a list of commits and changes to a specified file.

See also: AWS API Documentation

Request Syntax

response = client.list_file_commit_history(
    repositoryName='string',
    commitSpecifier='string',
    filePath='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • repositoryName (string) –

    [REQUIRED]

    The name of the repository that contains the file.

  • commitSpecifier (string) – The fully quaified reference that identifies the commit that contains the file. For example, you can specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/main. If none is provided, the head commit is used.

  • filePath (string) –

    [REQUIRED]

    The full path of the file whose history you want to retrieve, including the name of the file.

  • maxResults (integer) – A non-zero, non-negative integer used to limit the number of returned results.

  • nextToken (string) – An enumeration token that allows the operation to batch the results.

Return type:

dict

Returns:

Response Syntax

{
    'revisionDag': [
        {
            'commit': {
                'commitId': 'string',
                'treeId': 'string',
                'parents': [
                    'string',
                ],
                'message': 'string',
                'author': {
                    'name': 'string',
                    'email': 'string',
                    'date': 'string'
                },
                'committer': {
                    'name': 'string',
                    'email': 'string',
                    'date': 'string'
                },
                'additionalData': 'string'
            },
            'blobId': 'string',
            'path': 'string',
            'revisionChildren': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • revisionDag (list) –

      An array of FileVersion objects that form a directed acyclic graph (DAG) of the changes to the file made by the commits that changed the file.

      • (dict) –

        Information about a version of a file.

        • commit (dict) –

          Returns information about a specific commit.

          • commitId (string) –

            The full SHA ID of the specified commit.

          • treeId (string) –

            Tree information for the specified commit.

          • parents (list) –

            A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.

            • (string) –

          • message (string) –

            The commit message associated with the specified commit.

          • author (dict) –

            Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.

            • name (string) –

              The name of the user who made the specified commit.

            • email (string) –

              The email address associated with the user who made the commit, if any.

            • date (string) –

              The date when the specified commit was commited, in timestamp format with GMT offset.

          • committer (dict) –

            Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

            For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

            • name (string) –

              The name of the user who made the specified commit.

            • email (string) –

              The email address associated with the user who made the commit, if any.

            • date (string) –

              The date when the specified commit was commited, in timestamp format with GMT offset.

          • additionalData (string) –

            Any other data associated with the specified commit.

        • blobId (string) –

          The blob ID of the object that represents the content of the file in this version.

        • path (string) –

          The name and path of the file at which this blob is indexed which contains the data for this version of the file. This value will vary between file versions if a file is renamed or if its path changes.

        • revisionChildren (list) –

          An array of commit IDs that contain more recent versions of this file. If there are no additional versions of the file, this array will be empty.

          • (string) –

    • nextToken (string) –

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

Exceptions