AgentsforBedrock / Client / list_knowledge_bases

list_knowledge_bases#

AgentsforBedrock.Client.list_knowledge_bases(**kwargs)#

Lists the knowledge bases in an account and information about each of them.

See also: AWS API Documentation

Request Syntax

response = client.list_knowledge_bases(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • 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

{
    '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 objects, each of which contains information about a 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 at which the knowledge base 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