AgentsforBedrock / Client / get_agent_knowledge_base

get_agent_knowledge_base

AgentsforBedrock.Client.get_agent_knowledge_base(**kwargs)

Gets information about a knowledge base associated with an agent.

See also: AWS API Documentation

Request Syntax

response = client.get_agent_knowledge_base(
    agentId='string',
    agentVersion='string',
    knowledgeBaseId='string'
)

Parameters:

• agentId (string) –

  [REQUIRED]

  The unique identifier of the agent with which the knowledge base is associated.

• agentVersion (string) –

  [REQUIRED]

  The version of the agent with which the knowledge base is associated.

• knowledgeBaseId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'agentKnowledgeBase': {
        'agentId': 'string',
        'agentVersion': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'knowledgeBaseId': 'string',
        'knowledgeBaseState': 'ENABLED'|'DISABLED',
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • agentKnowledgeBase (dict) –

    Contains details about a knowledge base attached to an agent.

    • agentId (string) –

      The unique identifier of the agent with which the knowledge base is associated.

    • agentVersion (string) –

      The version of the agent with which the knowledge base is associated.

    • createdAt (datetime) –

      The time at which the association between the agent and the knowledge base was created.

    • description (string) –

      The description of the association between the agent and the knowledge base.

    • knowledgeBaseId (string) –

      The unique identifier of the association between the agent and the knowledge base.

    • knowledgeBaseState (string) –

      Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

    • updatedAt (datetime) –

      The time at which the association between the agent and the knowledge base was last updated.

Exceptions

• AgentsforBedrock.Client.exceptions.ThrottlingException

• AgentsforBedrock.Client.exceptions.AccessDeniedException

• AgentsforBedrock.Client.exceptions.ValidationException

• AgentsforBedrock.Client.exceptions.InternalServerException

• AgentsforBedrock.Client.exceptions.ResourceNotFoundException