Request Syntax Request Parameters Response Elements Errors Examples See Also

UpdateDefaultBranch

Sets or changes the default branch name for the specified repository.

Note

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

Request Syntax


{
   "defaultBranchName": "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.

defaultBranchName

The name of the branch to set as the default branch.

Type: String

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

Required: Yes

repositoryName

The name of the repository for which you want to set or change the default branch.

Type: String

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

Pattern: [\w\.-]+

Required: Yes

Response Elements

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

Errors

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

BranchDoesNotExistException

The specified branch does not exist.

message: Any message associated with the exception.

HTTP Status Code: 400

BranchNameRequiredException

A branch name is required, but was not specified.

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 UpdateDefaultBranch.

Sample Request


POST / HTTP/1.1
Host: codecommit.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 71
X-Amz-Target: CodeCommit_20150413.UpdateDefaultBranch
X-Amz-Date: 20151029T151143Z
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/20151029/us-east-1/codecommit/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

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

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: 0728aaa8-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0
Date: Thu, 29 Oct 2015 15:11:44 GMT