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:
-
AccessDeniedException–The request is denied because of missing access permissions.
-
InternalServerException–An internal server error occurred. Retry your request.
-
ResourceNotFoundException–The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
-
ThrottlingException–The number of requests exceeds the limit. Resubmit your request later.
-
ValidationException–Input validation failed. Check your request parameters and retry the request.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_bedrock_agent/_services/bedrock_agent.py
6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 | |