AgentsforBedrock / Client / associate_agent_knowledge_base

associate_agent_knowledge_base#

AgentsforBedrock.Client.associate_agent_knowledge_base(**kwargs)#

Associate a Knowledge Base to an existing Amazon Bedrock Agent

Request Syntax

response = client.associate_agent_knowledge_base(
    agentId='string',
    agentVersion='string',
    knowledgeBaseId='string',
    description='string',
    knowledgeBaseState='ENABLED'|'DISABLED'
)

Parameters:

agentId (string) –
[REQUIRED]

Id generated at the server side when an Agent is created
agentVersion (string) –
[REQUIRED]

Draft Version of the Agent.
knowledgeBaseId (string) –
[REQUIRED]

Identifier for a resource.
description (string) –
[REQUIRED]

Description of the Resource.
knowledgeBaseState (string) – State of the knowledge base; whether it is enabled or disabled

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Associate Agent Knowledge Base Response
- agentKnowledgeBase (dict) –
  
  Contains the information of an Agent Knowledge Base.
  - agentId (string) –
    
    Identifier for a resource.
  - agentVersion (string) –
    
    Agent Version.
  - knowledgeBaseId (string) –
    
    Identifier for a resource.
  - description (string) –
    
    Description of the Resource.
  - createdAt (datetime) –
    
    Time Stamp.
  - updatedAt (datetime) –
    
    Time Stamp.
  - knowledgeBaseState (string) –
    
    State of the knowledge base; whether it is enabled or disabled

Exceptions

AgentsforBedrock.Client.exceptions.ThrottlingException
AgentsforBedrock.Client.exceptions.AccessDeniedException
AgentsforBedrock.Client.exceptions.ValidationException
AgentsforBedrock.Client.exceptions.InternalServerException
AgentsforBedrock.Client.exceptions.ResourceNotFoundException
AgentsforBedrock.Client.exceptions.ConflictException
AgentsforBedrock.Client.exceptions.ServiceQuotaExceededException