:doc:`AgentsforBedrock <../../bedrock-agent>` / Paginator / ListKnowledgeBaseDocuments

**************************
ListKnowledgeBaseDocuments
**************************



.. py:class:: AgentsforBedrock.Paginator.ListKnowledgeBaseDocuments

  ::

    
    paginator = client.get_paginator('list_knowledge_base_documents')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`AgentsforBedrock.Client.list_knowledge_base_documents`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments>`_    


    **Request Syntax**
    ::

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

      The unique identifier of the knowledge base that is connected to the data source.

      

    
    :type dataSourceId: string
    :param dataSourceId: **[REQUIRED]** 

      The unique identifier of the data source that contains the documents.

      

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

      
      ::

        {
            'documentDetails': [
                {
                    'knowledgeBaseId': 'string',
                    'dataSourceId': 'string',
                    'status': 'INDEXED'|'PARTIALLY_INDEXED'|'PENDING'|'FAILED'|'METADATA_PARTIALLY_INDEXED'|'METADATA_UPDATE_FAILED'|'IGNORED'|'NOT_FOUND'|'STARTING'|'IN_PROGRESS'|'DELETING'|'DELETE_IN_PROGRESS',
                    'identifier': {
                        'dataSourceType': 'CUSTOM'|'S3',
                        's3': {
                            'uri': 'string'
                        },
                        'custom': {
                            'id': 'string'
                        }
                    },
                    'statusReason': 'string',
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **documentDetails** *(list) --* 

          A list of objects, each of which contains information about the documents that were retrieved.

          
          

          - *(dict) --* 

            Contains the details for a document that was ingested or deleted.

            
            

            - **knowledgeBaseId** *(string) --* 

              The identifier of the knowledge base that the document was ingested into or deleted from.

              
            

            - **dataSourceId** *(string) --* 

              The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.

              
            

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

              The ingestion status of the document. The following statuses are possible:

               

              
              * STARTING – You submitted the ingestion job containing the document.
               
              * PENDING – The document is waiting to be ingested.
               
              * IN_PROGRESS – The document is being ingested.
               
              * INDEXED – The document was successfully indexed.
               
              * PARTIALLY_INDEXED – The document was partially indexed.
               
              * METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.
               
              * METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.
               
              * FAILED – The document failed to be ingested.
               
              * NOT_FOUND – The document wasn't found.
               
              * IGNORED – The document was ignored during ingestion.
               
              * DELETING – You submitted the delete job containing the document.
               
              * DELETE_IN_PROGRESS – The document is being deleted.
              

              
            

            - **identifier** *(dict) --* 

              Contains information that identifies the document.

              
              

              - **dataSourceType** *(string) --* 

                The type of data source connected to the knowledge base that contains the document.

                
              

              - **s3** *(dict) --* 

                Contains information that identifies the document in an S3 data source.

                
                

                - **uri** *(string) --* 

                  The location's URI. For example, ``s3://my-bucket/chunk-processor/``.

                  
            
              

              - **custom** *(dict) --* 

                Contains information that identifies the document in a custom data source.

                
                

                - **id** *(string) --* 

                  The identifier of the document to ingest into a custom data source.

                  
            
          
            

            - **statusReason** *(string) --* 

              The reason for the status. Appears alongside the status ``IGNORED``.

              
            

            - **updatedAt** *(datetime) --* 

              The date and time at which the document was last updated.

              
        
      
        

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

          A token to resume pagination.

          
    