Skip to content

get_retrieval_instruction

get_retrieval_instruction(
    retrieval_instruction_id: RetrievalInstructionId,
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    retrieval_instruction_version: Optional[RetrievalInstructionVersionSelector] = None,
) -> GetRetrievalInstructionResponse

Gets a retrieval instruction. Also used to poll the terminal reporting of an asynchronous create or update.

Parameters:

  • retrieval_instruction_id (RetrievalInstructionId) –

    The identifier of the retrieval instruction to get.

  • retrieval_instruction_version (Optional[RetrievalInstructionVersionSelector], default: None ) –

    The version to return: a version number, or DRAFT for the retrieval instruction's current reviewed content. When omitted, DRAFT is used. This default is permanent: omitting retrievalInstructionVersion will never resolve to a numbered version.

Raises:

Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
def get_retrieval_instruction(
    self,
    retrieval_instruction_id: "capo_bedrock_agent.types.retrieval_instruction_id.RetrievalInstructionId",
    *,
    config_overrides: Optional[BedrockAgentClientConfig] = None,
    retrieval_instruction_version: Optional[
        "capo_bedrock_agent.types.retrieval_instruction_version_selector.RetrievalInstructionVersionSelector"
    ] = None,
) -> "capo_bedrock_agent.types.get_retrieval_instruction_response.GetRetrievalInstructionResponse":
    """<p>Gets a retrieval instruction. Also used to poll the terminal reporting of an asynchronous create or update.</p>

    Args:
        retrieval_instruction_id: <p>The identifier of the retrieval instruction to get.</p>
        retrieval_instruction_version: <p>The version to return: a version number, or DRAFT for the retrieval instruction's current reviewed content. When omitted, DRAFT is used. This default is permanent: omitting retrievalInstructionVersion will never resolve to a numbered version.</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_retrieval_instruction_request.GetRetrievalInstructionRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent.types.get_retrieval_instruction_response.GetRetrievalInstructionResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.get_retrieval_instruction

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

    def _redact_output(
        output: "capo_bedrock_agent.types.get_retrieval_instruction_response.GetRetrievalInstructionResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent.types.get_retrieval_instruction_response

        return capo_bedrock_agent.types.get_retrieval_instruction_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetRetrievalInstruction", redact_output=_redact_output),
    )
    input_: capo_bedrock_agent.types.get_retrieval_instruction_request.GetRetrievalInstructionRequest = {
        "retrieval_instruction_id": retrieval_instruction_id
    }
    if retrieval_instruction_version is not None:
        input_["retrieval_instruction_version"] = retrieval_instruction_version

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