AgentsforBedrock / Paginator / ListAgentKnowledgeBases
ListAgentKnowledgeBases#
- class AgentsforBedrock.Paginator.ListAgentKnowledgeBases#
paginator = client.get_paginator('list_agent_knowledge_bases')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
AgentsforBedrock.Client.list_agent_knowledge_bases()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( agentId='string', agentVersion='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
agentId (string) –
[REQUIRED]
Id generated at the server side when an Agent is created
agentVersion (string) –
[REQUIRED]
Version number generated when a version is created
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
{ 'agentKnowledgeBaseSummaries': [ { 'knowledgeBaseId': 'string', 'description': 'string', 'knowledgeBaseState': 'ENABLED'|'DISABLED', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
List Agent Knowledge Bases Response
agentKnowledgeBaseSummaries (list) –
List of Agent Knowledge Base Summaries
(dict) –
Agent Knowledge Base Summary
knowledgeBaseId (string) –
Identifier for a resource.
description (string) –
Description of the Resource.
knowledgeBaseState (string) –
State of the knowledge base; whether it is enabled or disabled
updatedAt (datetime) –
Time Stamp.
NextToken (string) –
A token to resume pagination.