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()
.See also: AWS API Documentation
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': [ { 'knowledgeBaseId': 'string', 'name': 'string', 'description': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'FAILED', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
knowledgeBaseSummaries (list) –
List of KnowledgeBaseSummaries
(dict) –
Summary information of a knowledge base.
knowledgeBaseId (string) –
Identifier for a resource.
name (string) –
Name for a resource.
description (string) –
Description of the Resource.
status (string) –
The status of a knowledge base.
updatedAt (datetime) –
Time Stamp.
NextToken (string) –
A token to resume pagination.