QApps / Client / get_library_item

get_library_item#

QApps.Client.get_library_item(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_library_item(
    instanceId='string',
    libraryItemId='string',
    appId='string'
)
Parameters:

  • instanceId (string) –

    [REQUIRED]

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

  • libraryItemId (string) –

    [REQUIRED]

    The unique identifier of the library item to retrieve.

  • appId (string) – The unique identifier of the Amazon Q App associated with the library item.

Return type:

dict

Returns:

Response Syntax

{
    'libraryItemId': 'string',
    'appId': 'string',
    'appVersion': 123,
    'categories': [
        {
            'id': 'string',
            'title': 'string',
            'color': 'string',
            'appCount': 123
        },
    ],
    'status': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'ratingCount': 123,
    'isRatedByUser': True|False,
    'userCount': 123,
    'isVerified': True|False
}

Response Structure

  • (dict) –

    • libraryItemId (string) –

      The unique identifier of the library item.

    • appId (string) –

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

    • appVersion (integer) –

      The version of the Q App associated with the library item.

    • categories (list) –

      The categories associated with the library item for discovery.

      • (dict) –

        A category used to classify and filter library items for Amazon Q Apps.

        • id (string) –

          The unique identifier of the category.

        • title (string) –

          The title or name of the category.

        • color (string) –

          The color of the category

        • appCount (integer) –

          The number of published Amazon Q Apps associated with a category

    • status (string) –

      The status of the library item, such as “Published”.

    • createdAt (datetime) –

      The date and time the library item was created.

    • createdBy (string) –

      The user who created the library item.

    • updatedAt (datetime) –

      The date and time the library item was last updated.

    • updatedBy (string) –

      The user who last updated the library item.

    • ratingCount (integer) –

      The number of ratings the library item has received from users.

    • isRatedByUser (boolean) –

      Whether the current user has rated the library item.

    • userCount (integer) –

      The number of users who have associated the Q App with their account.

    • isVerified (boolean) –

      Indicates whether the library item has been verified.

Exceptions