AgentsforBedrock / Client / list_agent_knowledge_bases

list_agent_knowledge_bases#

AgentsforBedrock.Client.list_agent_knowledge_bases(**kwargs)#

Lists knowledge bases associated with an agent and information about each one.

See also: AWS API Documentation

Request Syntax

response = client.list_agent_knowledge_bases(
    agentId='string',
    agentVersion='string',
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

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) –

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions