:doc:`QApps <../../qapps>` / Client / list_library_items

******************
list_library_items
******************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListLibraryItems>`_  


  **Request Syntax**
  ::

    response = client.list_library_items(
        instanceId='string',
        limit=123,
        nextToken='string',
        categoryId='string'
    )
    
  :type instanceId: string
  :param instanceId: **[REQUIRED]** 

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

    

  
  :type limit: integer
  :param limit: 

    The maximum number of library items to return in the response.

    

  
  :type nextToken: string
  :param nextToken: 

    The token to request the next page of results.

    

  
  :type categoryId: string
  :param categoryId: 

    Optional category to filter the library items by.

    

  
  
  :rtype: 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**
  
  *   :py:class:`QApps.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QApps.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QApps.Client.exceptions.ValidationException`

  
  *   :py:class:`QApps.Client.exceptions.InternalServerException`

  
  *   :py:class:`QApps.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`QApps.Client.exceptions.ThrottlingException`

  