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.

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

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 BeginDeleteBranch and EndDeleteBranch.

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

Syntax

C#
public virtual Task<DeleteBranchResponse> DeleteBranchAsync(
         DeleteBranchRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CodeCommit.Model.DeleteBranchRequest

Container for the necessary parameters to execute the DeleteBranch 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 DeleteBranch service method, as returned by CodeCommit.

Exceptions

ExceptionCondition
BranchNameRequiredException A branch name is required, but was not specified.
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.
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.
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