Skip to content

batch_get_repositories async

batch_get_repositories(
    repository_names: RepositoryNameList,
    *,
    config_overrides: Optional[AsyncCodeCommitClientConfig] = None,
) -> BatchGetRepositoriesOutput

Returns information about one or more repositories.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.

Parameters:

  • repository_names (RepositoryNameList) –

    The names of the repositories to get information about.

    The length constraint limit is for each string in the array. The array itself can be empty.

Raises:

Source code in docs_src/capo_codecommit/_services/async_code_commit.py
async def batch_get_repositories(
    self,
    repository_names: "capo_codecommit.types.repository_name_list.RepositoryNameList",
    *,
    config_overrides: Optional[AsyncCodeCommitClientConfig] = None,
) -> (
    "capo_codecommit.types.batch_get_repositories_output.BatchGetRepositoriesOutput"
):
    """<p>Returns information about one or more repositories.</p> <note> <p>The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a webpage can expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a webpage.</p> </note>

    Args:
        repository_names: <p>The names of the repositories to get information about.</p> <note> <p>The length constraint limit is for each string in the array. The array itself can be empty.</p> </note>

    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_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.maximum_repository_names_exceeded_exception.MaximumRepositoryNamesExceededException: <p>The maximum number of allowed repository names was exceeded. Currently, this number is 100.</p>
        capo_codecommit.errors.repository_names_required_exception.RepositoryNamesRequiredException: <p>At least one repository name object 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.batch_get_repositories_input.BatchGetRepositoriesInput]",
    ) -> AsyncOperationResponse[
        "capo_codecommit.types.batch_get_repositories_output.BatchGetRepositoriesOutput"
    ]:
        import capo_codecommit._operations.code_commit_20150413.batch_get_repositories

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGetRepositories")
    )
    input_: capo_codecommit.types.batch_get_repositories_input.BatchGetRepositoriesInput = {
        "repository_names": repository_names
    }

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