list_categories async ¶

async def list_categories(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
) -> "capo_qapps.types.list_categories_output.ListCategoriesOutput":
    """<p>Lists the categories of a Amazon Q Business application environment instance. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom labels for Amazon Q Apps</a>.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>

    Raises:
        capo_qapps.errors.access_denied_exception.AccessDeniedException: <p>The client is not authorized to perform the requested operation.</p>
        capo_qapps.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred while processing the request.</p>
        capo_qapps.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_qapps.errors.throttling_exception.ThrottlingException: <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
        capo_qapps.errors.unauthorized_exception.UnauthorizedException: <p>The client is not authenticated or authorized to perform the requested operation.</p>
        capo_qapps.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by the service.</p>
        capo_qapps.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List categories available for the library items in this instance

        >>> await client.list_categories(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qapps.types.list_categories_input.ListCategoriesInput]",
    ) -> AsyncOperationResponse[
        "capo_qapps.types.list_categories_output.ListCategoriesOutput"
    ]:
        import capo_qapps._operations.q_apps_service.list_categories

        (
            output,
            http_response,
        ) = await capo_qapps._operations.q_apps_service.list_categories.async_list_categories(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCategories")
    )
    input_: capo_qapps.types.list_categories_input.ListCategoriesInput = {
        "instance_id": instance_id
    }

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