AWS CodeCommit

Deletes a branch from a repository, unless that branch is the default branch for the repository.

See also: AWS API Documentation

Request Syntax

client.delete_branch(
    repositoryName='string',
    branchName='string'
)

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository that contains the branch to be deleted.

type branchName

string

param branchName

[REQUIRED]

The name of the branch to delete.

rtype

dict

returns

Response Syntax

{
    'deletedBranch': {
        'branchName': 'string',
        'commitId': 'string'
    }
}

Response Structure

• (dict) --

  Represents the output of a delete branch operation.

  • deletedBranch (dict) --

    Information about the branch deleted by the operation, including the branch name and the commit ID that was the tip of the branch.

    • branchName (string) --

      The name of the branch.

    • commitId (string) --

      The ID of the last commit made to the branch.

{'commit': {'commitId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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

type repositoryName

string

param repositoryName

[REQUIRED]

The name of the repository to which the commit was made.

type commitId

string

param commitId

[REQUIRED]

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

rtype

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 of the specified commit.

    • treeId (string) --

      Tree information for the specified commit.

    • parents (list) --

      The parent list for the specified commit.

      • (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 pushed to the repository.

    • 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 pushed to the repository.

    • additionalData (string) --

      Any additional data associated with the specified commit.