CodeCommit / Client / batch_get_commits

batch_get_commits#

CodeCommit.Client.batch_get_commits(**kwargs)#

Returns information about the contents of one or more commits in a repository.

Request Syntax

response = client.batch_get_commits(
    commitIds=[
        'string',
    ],
    repositoryName='string'
)

Parameters:

commitIds (list) –
[REQUIRED]

The full commit IDs of the commits to get information about.

Note
You must supply the full SHA IDs of each commit. You cannot use shortened SHA IDs.
- (string) –
repositoryName (string) –
[REQUIRED]

The name of the repository that contains the commits.

Return type:

dict

Returns:

Response Syntax

{
    'commits': [
        {
            'commitId': 'string',
            'treeId': 'string',
            'parents': [
                'string',
            ],
            'message': 'string',
            'author': {
                'name': 'string',
                'email': 'string',
                'date': 'string'
            },
            'committer': {
                'name': 'string',
                'email': 'string',
                'date': 'string'
            },
            'additionalData': 'string'
        },
    ],
    'errors': [
        {
            'commitId': 'string',
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) –
- commits (list) –
  
  An array of commit data type objects, each of which contains information about a specified 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.
- errors (list) –
  
  Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a shortened SHA ID or that commit was not found in the specified repository, the ID returns an error object with more information.
  - (dict) –
    
    Returns information about errors in a BatchGetCommits operation.
    - commitId (string) –
      
      A commit ID that either could not be found or was not in a valid format.
    - errorCode (string) –
      
      An error code that specifies whether the commit ID was not valid or not found.
    - errorMessage (string) –
      
      An error message that provides detail about why the commit ID either was not found or was not valid.

Exceptions

CodeCommit.Client.exceptions.CommitIdsListRequiredException
CodeCommit.Client.exceptions.CommitIdsLimitExceededException
CodeCommit.Client.exceptions.RepositoryNameRequiredException
CodeCommit.Client.exceptions.InvalidRepositoryNameException
CodeCommit.Client.exceptions.RepositoryDoesNotExistException
CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException
CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException
CodeCommit.Client.exceptions.EncryptionKeyDisabledException
CodeCommit.Client.exceptions.EncryptionKeyNotFoundException
CodeCommit.Client.exceptions.EncryptionKeyUnavailableException