AgentsforBedrock / Client / list_knowledge_bases

list_knowledge_bases#

AgentsforBedrock.Client.list_knowledge_bases(**kwargs)#

List Knowledge Bases

See also: AWS API Documentation

Request Syntax

response = client.list_knowledge_bases(
    maxResults=123,
    nextToken='string'
)
Parameters:
  • maxResults (integer) – Max Results.

  • nextToken (string) – Opaque continuation token of previous paginated 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) –

      Opaque continuation token of previous paginated response.

Exceptions

  • AgentsforBedrock.Client.exceptions.ThrottlingException

  • AgentsforBedrock.Client.exceptions.AccessDeniedException

  • AgentsforBedrock.Client.exceptions.ValidationException

  • AgentsforBedrock.Client.exceptions.InternalServerException