delete-branch¶

Description¶

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

Synopsis¶

  delete-branch
--repository-name <value>
--branch-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--repository-name (string)

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

--branch-name (string)

The name of the branch to delete.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To delete a branch

This example shows how to delete a branch in an AWS CodeCommit repository.

Command:

aws codecommit delete-branch --repository-name MyDemoRepo --branch-name MyNewBranch

Output:

{
  "branch": {
      "commitId": "317f8570EXAMPLE",
      "branchName": "MyNewBranch"
  }
}

Output¶

deletedBranch -> (structure)

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.

Table of Contents

Feedback

User Guide