:doc:`QApps <../../qapps>` / Paginator / ListQApps

*********
ListQApps
*********



.. py:class:: QApps.Paginator.ListQApps

  ::

    
    paginator = client.get_paginator('list_q_apps')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`QApps.Client.list_q_apps`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListQApps>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          instanceId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type instanceId: string
    :param instanceId: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'apps': [
                {
                    'appId': 'string',
                    'appArn': 'string',
                    'title': 'string',
                    'description': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'canEdit': True|False,
                    'status': 'string',
                    'isVerified': True|False
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **apps** *(list) --* 

          The list of Amazon Q Apps meeting the request criteria.

          
          

          - *(dict) --* 

            An Amazon Q App associated with a user, either owned by the user or favorited.

            
            

            - **appId** *(string) --* 

              The unique identifier of the Q App.

              
            

            - **appArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Q App.

              
            

            - **title** *(string) --* 

              The title of the Q App.

              
            

            - **description** *(string) --* 

              The description of the Q App.

              
            

            - **createdAt** *(datetime) --* 

              The date and time the user's association with the Q App was created.

              
            

            - **canEdit** *(boolean) --* 

              A flag indicating whether the user can edit the Q App.

              
            

            - **status** *(string) --* 

              The status of the user's association with the Q App.

              
            

            - **isVerified** *(boolean) --* 

              Indicates whether the Q App has been verified.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    