Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRetrievalInstruction

Updates the content of a retrieval instruction. The update is processed asynchronously; the stored content is a candidate until content review passes, and the served content does not change while the update is in flight. The service rejects the request with ConflictException while lastTransitionStatus is CREATING or UPDATING.

Request Syntax


PUT /retrievalinstructions/retrievalInstructionId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "instruction": { 
      "answerFormat": "string",
      "answerPolicy": "string",
      "persona": "string",
      "retrievalGuidance": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

retrievalInstructionId

The identifier of the retrieval instruction to update.

Length Constraints: Fixed length of 10.

Pattern: [a-z0-9]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

A replacement description; applied together with the content when the review passes. Omit to clear.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

instruction

The replacement instruction content. This is a full replacement of all four fields, not a patch. During UPDATING, Get continues to return the previously-served content until the update review passes.

Type: RetrievalInstructionContent object

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "createdAt": "string",
   "lastTransitionStatus": "string",
   "name": "string",
   "retrievalInstructionArn": "string",
   "retrievalInstructionId": "string",
   "status": "string",
   "updatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

createdAt

When you created the retrieval instruction.

Type: Timestamp

lastTransitionStatus

Always UPDATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.

Type: String

name

The name of the retrieval instruction.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ([0-9a-zA-Z][_-]?){1,100}

retrievalInstructionArn

The ARN of the retrieval instruction.

Type: String

Pattern: arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:retrieval-instruction/[a-z0-9]{10}

retrievalInstructionId

The identifier of the retrieval instruction.

Type: String

Length Constraints: Fixed length of 10.

Pattern: [a-z0-9]{10}

status

Whether the instruction can be used. An update never lowers status. Unchanged from the previous value on this response.

Type: String

Valid Values: ACTIVE | INACTIVE

updatedAt

When the retrieval instruction was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The request is denied because of missing access permissions.

HTTP Status Code: 403

ConflictException

There was a conflict performing an operation.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

HTTP Status Code: 404

ThrottlingException

The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 429

ValidationException

Input validation failed. Check your request parameters and retry the request.

fieldList: A list of objects containing fields that caused validation errors and their corresponding validation error messages.

HTTP Status Code: 400