QApps / Client / list_library_items

list_library_items#

QApps.Client.list_library_items(**kwargs)#

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_library_items(
    instanceId='string',
    limit=123,
    nextToken='string',
    categoryId='string'
)
Parameters:

  • instanceId (string) –

    [REQUIRED]

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

  • limit (integer) – The maximum number of library items to return in the response.

  • nextToken (string) – The token to request the next page of results.

  • categoryId (string) – Optional category to filter the library items by.

Return type:

dict

Returns:

Response Syntax

{
    'libraryItems': [
        {
            '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
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • libraryItems (list) –

      The list of library items meeting the request criteria.

      • (dict) –

        A library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.

        • 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.

          • (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.

        • 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.

        • isRatedByUser (boolean) –

          Whether the current user has rated the library item.

        • userCount (integer) –

          The number of users who have the associated Q App.

        • isVerified (boolean) –

          Indicates whether the library item has been verified.

    • nextToken (string) –

      The token to use to request the next page of results.

Exceptions