AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a branch in a repository and points the branch to a commit.

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateBranch and EndCreateBranch.

Namespace: Amazon.CodeCommit
Assembly: AWSSDK.CodeCommit.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CreateBranchResponse> CreateBranchAsync(
         CreateBranchRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeCommit.Model.CreateBranchRequest

Container for the necessary parameters to execute the CreateBranch service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateBranch service method, as returned by CodeCommit.

Exceptions

ExceptionCondition
BranchNameExistsException Cannot create the branch with the specified name because the commit conflicts with an existing branch with the same name. Branch names must be unique.
BranchNameRequiredException A branch name is required, but was not specified.
CommitDoesNotExistException The specified commit does not exist or no commit was specified, and the specified repository has no default branch.
CommitIdRequiredException A commit ID was not specified.
EncryptionIntegrityChecksFailedException An encryption integrity check failed.
EncryptionKeyAccessDeniedException An encryption key could not be accessed.
EncryptionKeyDisabledException The encryption key is disabled.
EncryptionKeyNotFoundException No encryption key was found.
EncryptionKeyUnavailableException The encryption key is not available.
InvalidBranchNameException The specified reference name is not valid.
InvalidCommitIdException The specified commit ID is not valid.
InvalidRepositoryNameException A specified repository name is not valid. 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.
RepositoryDoesNotExistException The specified repository does not exist.
RepositoryNameRequiredException A repository name is required, but was not specified.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also