Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DeleteBranch

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

Request Syntax


{
   "branchName": "string",
   "repositoryName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

branchName

The name of the branch to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

repositoryName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\w\.-]+

Required: Yes

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

deletedBranch

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

Type: BranchInfo object

Errors

For information about the errors that are common to all actions, see Common Error Types.

BranchNameRequiredException

A branch name is required, but was not specified.

message: Any message associated with the exception.

HTTP Status Code: 400

DefaultBranchCannotBeDeletedException

The specified branch is the default branch for the repository, and cannot be deleted. To delete this branch, you must first set another branch as the default branch.

message: Any message associated with the exception.

HTTP Status Code: 400

EncryptionIntegrityChecksFailedException

An encryption integrity check failed.

message: Any message associated with the exception.

HTTP Status Code: 500

EncryptionKeyAccessDeniedException

An encryption key could not be accessed.

message: Any message associated with the exception.

HTTP Status Code: 400

EncryptionKeyDisabledException

The encryption key is disabled.

message: Any message associated with the exception.

HTTP Status Code: 400

EncryptionKeyNotFoundException

No encryption key was found.

message: Any message associated with the exception.

HTTP Status Code: 400

EncryptionKeyUnavailableException

The encryption key is not available.

message: Any message associated with the exception.

HTTP Status Code: 400

InvalidBranchNameException

The specified reference name is not valid.

message: Any message associated with the exception.

HTTP Status Code: 400

InvalidRepositoryNameException

A specified repository name is not valid.

Note

This exception occurs only when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

message: Any message associated with the exception.

HTTP Status Code: 400

RepositoryDoesNotExistException

The specified repository does not exist.

message: Any message associated with the exception.

HTTP Status Code: 400

RepositoryNameRequiredException

A repository name is required, but was not specified.

message: Any message associated with the exception.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteBranch.

Sample Request


HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 57
X-Amz-Target: CodeCommit_20150413.DeleteBranch
X-Amz-Date: 20151028T224659Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151028/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "repositoryName": "MyDemoRepo", 
  "branchName": "MyNewBranch"
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 88
Date: Wed, 28 Oct 2015 22:47:03 GMT

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