QApps / Paginator / ListLibraryItems

ListLibraryItems#

class QApps.Paginator.ListLibraryItems#
paginator = client.get_paginator('list_library_items')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from QApps.Client.list_library_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    instanceId='string',
    categoryId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • instanceId (string) –

    [REQUIRED]

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

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'libraryItems': [
        {
            'libraryItemId': 'string',
            'appId': 'string',
            'appVersion': 123,
            'categories': [
                {
                    'id': 'string',
                    'title': 'string'
                },
            ],
            'status': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'ratingCount': 123,
            'isRatedByUser': True|False,
            'userCount': 123
        },
    ],
    '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.

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

    • NextToken (string) –

      A token to resume pagination.