Deletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects that request with ConflictException while the retrieval instruction has versions or while lastTransitionStatus is CREATING or UPDATING. Specify retrievalInstructionVersion to delete only that version; the retrieval instruction and its other versions are unaffected.
Parameters:
-
retrieval_instruction_id
(RetrievalInstructionId)
–
The identifier of the retrieval instruction to delete.
-
retrieval_instruction_version
(Optional[RetrievalInstructionNumericalVersion], default:
None
)
–
The version to delete. Omit this field to delete the retrieval instruction itself, which you can do only when it has no versions; while any version exists the service rejects the request with ConflictException. You cannot delete DRAFT on its own; deleting the retrieval instruction removes it.
Raises:
Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
| def delete_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_numerical_version.RetrievalInstructionNumericalVersion"
] = None,
) -> "capo_bedrock_agent.types.delete_retrieval_instruction_response.DeleteRetrievalInstructionResponse":
"""<p>Deletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects that request with ConflictException while the retrieval instruction has versions or while lastTransitionStatus is CREATING or UPDATING. Specify retrievalInstructionVersion to delete only that version; the retrieval instruction and its other versions are unaffected.</p>
Args:
retrieval_instruction_id: <p>The identifier of the retrieval instruction to delete.</p>
retrieval_instruction_version: <p>The version to delete. Omit this field to delete the retrieval instruction itself, which you can do only when it has no versions; while any version exists the service rejects the request with ConflictException. You cannot delete DRAFT on its own; deleting the retrieval instruction removes it.</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.delete_retrieval_instruction_request.DeleteRetrievalInstructionRequest]",
) -> OperationResponse[
"capo_bedrock_agent.types.delete_retrieval_instruction_response.DeleteRetrievalInstructionResponse"
]:
import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.delete_retrieval_instruction
output, http_response = (
capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.delete_retrieval_instruction.delete_retrieval_instruction(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteRetrievalInstruction")
)
input_: capo_bedrock_agent.types.delete_retrieval_instruction_request.DeleteRetrievalInstructionRequest = {
"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
|