Skip to content

update_default_branch 

update_default_branch(
    repository_name: RepositoryName,
    default_branch_name: BranchName,
    *,
    config_overrides: Optional[CodeCommitClientConfig] = None,
) -> None

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

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.

Parameters:

  • repository_name (RepositoryName) –

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

  • default_branch_name (BranchName) –

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

Raises:

Source code in docs_src/capo_codecommit/_services/code_commit.py 
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
def update_default_branch(
    self,
    repository_name: "capo_codecommit.types.repository_name.RepositoryName",
    default_branch_name: "capo_codecommit.types.branch_name.BranchName",
    *,
    config_overrides: Optional[CodeCommitClientConfig] = None,
) -> None:
    """<p>Sets or changes the default branch name for the specified repository.</p> <note> <p>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.</p> </note>

    Args:
        repository_name: <p>The name of the repository for which you want to set or change the default branch.</p>
        default_branch_name: <p>The name of the branch to set as the default branch.</p>

    Raises:
        capo_codecommit.errors.branch_does_not_exist_exception.BranchDoesNotExistException: <p>The specified branch does not exist.</p>
        capo_codecommit.errors.branch_name_required_exception.BranchNameRequiredException: <p>A branch name is required, but was not specified.</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.
    """

    def _handler(
        req: "OperationRequest[capo_codecommit.types.update_default_branch_input.UpdateDefaultBranchInput]",
    ) -> OperationResponse[None]:
        import capo_codecommit._operations.code_commit_20150413.update_default_branch

        output, http_response = (
            capo_codecommit._operations.code_commit_20150413.update_default_branch.update_default_branch(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDefaultBranch")
    )
    input_: capo_codecommit.types.update_default_branch_input.UpdateDefaultBranchInput = {
        "repository_name": repository_name,
        "default_branch_name": default_branch_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output