create_retrieval_instruction
¶
create_retrieval_instruction(
name: RetrievalInstructionName,
instruction: RetrievalInstructionContent,
*,
config_overrides: Optional[BedrockAgentClientConfig] = None,
client_token: Optional[ClientToken] = None,
description: Optional[RetrievalInstructionDescription] = None,
customer_encryption_key_arn: Optional[KmsKeyArn] = None,
tags: Optional[TagsMap] = None,
) -> CreateRetrievalInstructionResponse
Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is ready.
Parameters:
-
client_token(Optional[ClientToken], default:None) –A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.
-
name(RetrievalInstructionName) –Specifies the name of the retrieval instruction.
-
instruction(RetrievalInstructionContent) –The instruction content, as a set of named fields. Get does not return this field until the create review passes.
-
description(Optional[RetrievalInstructionDescription], default:None) –Specifies a description of the retrieval instruction.
-
customer_encryption_key_arn(Optional[KmsKeyArn], default:None) –The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.
-
tags(Optional[TagsMap], default:None) –Tags for the retrieval instruction.
Raises:
-
AccessDeniedException–The request is denied because of missing access permissions.
-
ConflictException–There was a conflict performing an operation.
-
InternalServerException–An internal server error occurred. Retry your request.
-
ServiceQuotaExceededException–The number of requests exceeds the service quota. Resubmit your request later.
-
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
6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 | |