AgentsforBedrock / Paginator / ListKnowledgeBases

ListKnowledgeBases#

class AgentsforBedrock.Paginator.ListKnowledgeBases#

paginator = client.get_paginator('list_knowledge_bases')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from AgentsforBedrock.Client.list_knowledge_bases().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

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.

Return type:

dict

Returns:

Response Syntax

{
    'knowledgeBaseSummaries': [
        {
            'description': 'string',
            'knowledgeBaseId': 'string',
            'name': '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.
    - description (string) –
      
      The description of the knowledge base.
    - knowledgeBaseId (string) –
      
      The unique identifier of the knowledge base.
    - name (string) –
      
      The name 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.