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:

For .NET Core and PCL this operation is only available in asynchronous form. Please refer to DeleteBranchAsync.

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

Syntax

C#
public virtual DeleteBranchResponse DeleteBranch(
         DeleteBranchRequest request
)
Parameters
request
Type: Amazon.CodeCommit.Model.DeleteBranchRequest

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

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 At least one specified repository name is not valid. This exception only occurs 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 Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also