Skip to content

list_branches

list_branches(
    repository_name: RepositoryName,
    *,
    config_overrides: Optional[CodeCommitClientConfig] = None,
    next_token: Optional[NextToken] = None,
) -> ListBranchesOutput

Gets information about one or more branches in a repository.

Parameters:

  • repository_name (RepositoryName) –

    The name of the repository that contains the branches.

  • next_token (Optional[NextToken], default: None ) –

    An enumeration token that allows the operation to batch the results.

Raises:

Source code in docs_src/capo_codecommit/_services/code_commit.py
def list_branches(
    self,
    repository_name: "capo_codecommit.types.repository_name.RepositoryName",
    *,
    config_overrides: Optional[CodeCommitClientConfig] = None,
    next_token: Optional["capo_codecommit.types.next_token.NextToken"] = None,
) -> "capo_codecommit.types.list_branches_output.ListBranchesOutput":
    """<p>Gets information about one or more branches in a repository.</p>

    Args:
        repository_name: <p>The name of the repository that contains the branches.</p>
        next_token: <p>An enumeration token that allows the operation to batch the results.</p>

    Raises:
        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_continuation_token_exception.InvalidContinuationTokenException: <p>The specified continuation token 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.list_branches_input.ListBranchesInput]",
    ) -> OperationResponse[
        "capo_codecommit.types.list_branches_output.ListBranchesOutput"
    ]:
        import capo_codecommit._operations.code_commit_20150413.list_branches

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBranches")
    )
    input_: capo_codecommit.types.list_branches_input.ListBranchesInput = {
        "repository_name": repository_name
    }
    if next_token is not None:
        input_["next_token"] = next_token

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