Skip to content

get_library_item async

get_library_item(
    instance_id: InstanceId,
    library_item_id: UUID,
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
    app_id: Optional[UUID] = None,
) -> GetLibraryItemOutput

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

Parameters:

  • instance_id (InstanceId) –

    The unique identifier of the Amazon Q Business application environment instance.

  • library_item_id (UUID) –

    The unique identifier of the library item to retrieve.

  • app_id (Optional[UUID], default: None ) –

    The unique identifier of the Amazon Q App associated with the library item.

Raises:

Examples:

Retrieve a library item

>>> await client.get_library_item(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', library_item_id='18cbebaa-196a-4aa5-a840-88d548e07f8f')
Source code in docs_src/capo_qapps/_services/async_q_apps.py
async def get_library_item(
    self,
    instance_id: "capo_qapps.types.instance_id.InstanceId",
    library_item_id: "capo_qapps.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncQAppsClientConfig] = None,
    app_id: Optional["capo_qapps.types.uuid.UUID"] = None,
) -> "capo_qapps.types.get_library_item_output.GetLibraryItemOutput":
    """<p>Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.</p>

    Args:
        instance_id: <p>The unique identifier of the Amazon Q Business application environment instance.</p>
        library_item_id: <p>The unique identifier of the library item to retrieve.</p>
        app_id: <p>The unique identifier of the Amazon Q App associated with the library item.</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:
        Retrieve a library item

        >>> await client.get_library_item(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', library_item_id='18cbebaa-196a-4aa5-a840-88d548e07f8f')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qapps.types.get_library_item_input.GetLibraryItemInput]",
    ) -> AsyncOperationResponse[
        "capo_qapps.types.get_library_item_output.GetLibraryItemOutput"
    ]:
        import capo_qapps._operations.q_apps_service.get_library_item

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetLibraryItem")
    )
    input_: capo_qapps.types.get_library_item_input.GetLibraryItemInput = {
        "instance_id": instance_id,
        "library_item_id": library_item_id,
    }
    if app_id is not None:
        input_["app_id"] = app_id

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