CodeCommit / Client / get_commit

get_commit#

CodeCommit.Client.get_commit(**kwargs)#

Returns information about a commit, including commit message and committer information.

Request Syntax

response = client.get_commit(
    repositoryName='string',
    commitId='string'
)

Parameters:

repositoryName (string) –
[REQUIRED]

The name of the repository to which the commit was made.
commitId (string) –
[REQUIRED]

The commit ID. Commit IDs are the full SHA ID of the commit.

Return type:

dict

Returns:

Response Syntax

{
    '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'
    }
}

Response Structure

(dict) –

Represents the output of a get commit operation.
- commit (dict) –
  
  A commit data type object that contains information about the specified 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.

Exceptions

CodeCommit.Client.exceptions.RepositoryNameRequiredException
CodeCommit.Client.exceptions.InvalidRepositoryNameException
CodeCommit.Client.exceptions.RepositoryDoesNotExistException
CodeCommit.Client.exceptions.CommitIdRequiredException
CodeCommit.Client.exceptions.InvalidCommitIdException
CodeCommit.Client.exceptions.CommitIdDoesNotExistException
CodeCommit.Client.exceptions.EncryptionIntegrityChecksFailedException
CodeCommit.Client.exceptions.EncryptionKeyAccessDeniedException
CodeCommit.Client.exceptions.EncryptionKeyDisabledException
CodeCommit.Client.exceptions.EncryptionKeyNotFoundException
CodeCommit.Client.exceptions.EncryptionKeyUnavailableException