:doc:`QBusiness <../../qbusiness>` / Paginator / ListRetrievers

**************
ListRetrievers
**************



.. py:class:: QBusiness.Paginator.ListRetrievers

  ::

    
    paginator = client.get_paginator('list_retrievers')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QBusiness.Client.list_retrievers`.

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


    **Request Syntax**
    ::

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

      The identifier of the Amazon Q Business application using the retriever.

      

    
    :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**

      
      ::

        {
            'retrievers': [
                {
                    'applicationId': 'string',
                    'retrieverId': 'string',
                    'type': 'NATIVE_INDEX'|'KENDRA_INDEX',
                    'status': 'CREATING'|'ACTIVE'|'FAILED',
                    'displayName': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **retrievers** *(list) --* 

          An array of summary information for one or more retrievers.

          
          

          - *(dict) --* 

            Summary information for the retriever used for your Amazon Q Business application.

            
            

            - **applicationId** *(string) --* 

              The identifier of the Amazon Q Business application using the retriever.

              
            

            - **retrieverId** *(string) --* 

              The identifier of the retriever used by your Amazon Q Business application.

              
            

            - **type** *(string) --* 

              The type of your retriever.

              
            

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

              The status of your retriever.

              
            

            - **displayName** *(string) --* 

              The name of your retriever.

              
        
      
        

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

          A token to resume pagination.

          
    