Skip to content

update_agent_knowledge_base

update_agent_knowledge_base(
    agent_id: Id,
    agent_version: DraftVersion,
    knowledge_base_id: Id,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    description: Optional[Description] = None,
    knowledge_base_state: Optional[KnowledgeBaseState] = None,
) -> UpdateAgentKnowledgeBaseResponse

Updates the configuration for a knowledge base that has been associated with an agent.

Parameters:

  • agent_id (Id) –

    The unique identifier of the agent associated with the knowledge base that you want to update.

  • agent_version (DraftVersion) –

    The version of the agent associated with the knowledge base that you want to update.

  • knowledge_base_id (Id) –

    The unique identifier of the knowledge base that has been associated with an agent.

  • description (Optional[Description], default: None ) –

    Specifies a new description for the knowledge base associated with an agent.

  • knowledge_base_state (Optional[KnowledgeBaseState], default: None ) –

    Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
def update_agent_knowledge_base(
    self,
    agent_id: "capo_bedrock_agent.types.id.Id",
    agent_version: "capo_bedrock_agent.types.draft_version.DraftVersion",
    knowledge_base_id: "capo_bedrock_agent.types.id.Id",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    description: Optional[
        "capo_bedrock_agent.types.description.Description"
    ] = None,
    knowledge_base_state: Optional[
        "capo_bedrock_agent.types.knowledge_base_state.KnowledgeBaseState"
    ] = None,
) -> "capo_bedrock_agent.types.update_agent_knowledge_base_response.UpdateAgentKnowledgeBaseResponse":
    """<p>Updates the configuration for a knowledge base that has been associated with an agent.</p>

    Args:
        agent_id: <p>The unique identifier of the agent associated with the knowledge base that you want to update.</p>
        agent_version: <p>The version of the agent associated with the knowledge base that you want to update.</p>
        knowledge_base_id: <p>The unique identifier of the knowledge base that has been associated with an agent.</p>
        description: <p>Specifies a new description for the knowledge base associated with an agent.</p>
        knowledge_base_state: <p>Specifies whether the agent uses the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>

    Raises:
        capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock_agent.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation.</p>
        capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent.types.update_agent_knowledge_base_request.UpdateAgentKnowledgeBaseRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.update_agent_knowledge_base_response.UpdateAgentKnowledgeBaseResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.update_agent_knowledge_base

        output, http_response = (
            capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.update_agent_knowledge_base.update_agent_knowledge_base(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAgentKnowledgeBase")
    )
    input_: capo_bedrock_agent.types.update_agent_knowledge_base_request.UpdateAgentKnowledgeBaseRequest = {
        "agent_id": agent_id,
        "agent_version": agent_version,
        "knowledge_base_id": knowledge_base_id,
    }
    if description is not None:
        input_["description"] = description
    if knowledge_base_state is not None:
        input_["knowledge_base_state"] = knowledge_base_state

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output