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]

  The unique identifier of the agent for which to return information about knowledge bases associated with it.

• agentVersion (string) –

  [REQUIRED]

  The version of the agent for which to return information about knowledge bases associated with it.

• 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': [
        {
            'description': 'string',
            'knowledgeBaseId': 'string',
            'knowledgeBaseState': 'ENABLED'|'DISABLED',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • agentKnowledgeBaseSummaries (list) –

    A list of objects, each of which contains information about a knowledge base associated with the agent.

    • (dict) –

      Contains details about a knowledge base associated with an agent.

      • description (string) –

        The description of the knowledge base associated with an agent.

      • knowledgeBaseId (string) –

        The unique identifier of the knowledge base associated with an agent.

      • knowledgeBaseState (string) –

        Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

      • updatedAt (datetime) –

        The time at which the knowledge base associated with an agent was last updated.

  • NextToken (string) –

    A token to resume pagination.