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

******************
ListKnowledgeBases
******************



.. py:class:: AgentsforBedrock.Paginator.ListKnowledgeBases

  ::

    
    paginator = client.get_paginator('list_knowledge_bases')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'knowledgeBaseSummaries': [
                {
                    'knowledgeBaseId': 'string',
                    'name': 'string',
                    'description': 'string',
                    'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'FAILED'|'DELETE_UNSUCCESSFUL',
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **knowledgeBaseSummaries** *(list) --* 

          A list of knowledge bases with information about each knowledge base.

          
          

          - *(dict) --* 

            Contains details about a knowledge base.

            
            

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

              The unique identifier of the knowledge base.

              
            

            - **name** *(string) --* 

              The name of the knowledge base.

              
            

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

              The description of the knowledge base.

              
            

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

              The status of the knowledge base.

              
            

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

              The time the knowledge base was last updated.

              
        
      
        

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

          A token to resume pagination.

          
    