delete_branch async ¶

async def delete_branch(
    self,
    repository_name: "capo_codecommit.types.repository_name.RepositoryName",
    branch_name: "capo_codecommit.types.branch_name.BranchName",
    *,
    config_overrides: Optional[AsyncCodeCommitClientConfig] = None,
) -> "capo_codecommit.types.delete_branch_output.DeleteBranchOutput":
    """<p>Deletes a branch from a repository, unless that branch is the default branch for the repository. </p>

    Args:
        repository_name: <p>The name of the repository that contains the branch to be deleted.</p>
        branch_name: <p>The name of the branch to delete.</p>

    Raises:
        capo_codecommit.errors.branch_name_required_exception.BranchNameRequiredException: <p>A branch name is required, but was not specified.</p>
        capo_codecommit.errors.default_branch_cannot_be_deleted_exception.DefaultBranchCannotBeDeletedException: <p>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.</p>
        capo_codecommit.errors.encryption_integrity_checks_failed_exception.EncryptionIntegrityChecksFailedException: <p>An encryption integrity check failed.</p>
        capo_codecommit.errors.encryption_key_access_denied_exception.EncryptionKeyAccessDeniedException: <p>An encryption key could not be accessed.</p>
        capo_codecommit.errors.encryption_key_disabled_exception.EncryptionKeyDisabledException: <p>The encryption key is disabled.</p>
        capo_codecommit.errors.encryption_key_not_found_exception.EncryptionKeyNotFoundException: <p>No encryption key was found.</p>
        capo_codecommit.errors.encryption_key_unavailable_exception.EncryptionKeyUnavailableException: <p>The encryption key is not available.</p>
        capo_codecommit.errors.invalid_branch_name_exception.InvalidBranchNameException: <p>The specified reference name is not valid.</p>
        capo_codecommit.errors.invalid_repository_name_exception.InvalidRepositoryNameException: <p>A specified repository name is not valid.</p> <note> <p>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.</p> </note>
        capo_codecommit.errors.repository_does_not_exist_exception.RepositoryDoesNotExistException: <p>The specified repository does not exist.</p>
        capo_codecommit.errors.repository_name_required_exception.RepositoryNameRequiredException: <p>A repository name is required, but was not specified.</p>
        capo_codecommit.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codecommit.types.delete_branch_input.DeleteBranchInput]",
    ) -> AsyncOperationResponse[
        "capo_codecommit.types.delete_branch_output.DeleteBranchOutput"
    ]:
        import capo_codecommit._operations.code_commit_20150413.delete_branch

        (
            output,
            http_response,
        ) = await capo_codecommit._operations.code_commit_20150413.delete_branch.async_delete_branch(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteBranch")
    )
    input_: capo_codecommit.types.delete_branch_input.DeleteBranchInput = {
        "repository_name": repository_name,
        "branch_name": branch_name,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output