Skip to content

get_agent_knowledge_base 

get_agent_knowledge_base(
    agent_id: Id,
    agent_version: Version,
    knowledge_base_id: Id,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> GetAgentKnowledgeBaseResponse

Gets information about a knowledge base associated with an agent.

Parameters:

  • agent_id (Id) –

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

  • agent_version (Version) –

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

  • knowledge_base_id (Id) –

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

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py 
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
def get_agent_knowledge_base(
    self,
    agent_id: "capo_bedrock_agent.types.id.Id",
    agent_version: "capo_bedrock_agent.types.version.Version",
    knowledge_base_id: "capo_bedrock_agent.types.id.Id",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
) -> "capo_bedrock_agent.types.get_agent_knowledge_base_response.GetAgentKnowledgeBaseResponse":
    """<p>Gets information about a knowledge base associated with an agent.</p>

    Args:
        agent_id: <p>The unique identifier of the agent with which the knowledge base is associated.</p>
        agent_version: <p>The version of the agent with which the knowledge base is associated.</p>
        knowledge_base_id: <p>The unique identifier of the knowledge base associated with the agent.</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.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.get_agent_knowledge_base_request.GetAgentKnowledgeBaseRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.get_agent_knowledge_base_response.GetAgentKnowledgeBaseResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_agent_knowledge_base

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAgentKnowledgeBase")
    )
    input_: capo_bedrock_agent.types.get_agent_knowledge_base_request.GetAgentKnowledgeBaseRequest = {
        "agent_id": agent_id,
        "agent_version": agent_version,
        "knowledge_base_id": knowledge_base_id,
    }

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