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

UpdateEvaluator

Updates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.

Request Syntax


PUT /evaluators/evaluatorId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "evaluatorConfig": { ... },
   "level": "string"
}

URI Request Parameters

The request uses the following URI parameters.

evaluatorId

The unique identifier of the evaluator to update.

Pattern: (Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

description

The updated description of the evaluator.

Type: String

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

Required: No

evaluatorConfig

The updated configuration for the evaluator, including LLM-as-a-Judge settings with instructions, rating scale, and model configuration.

Type: EvaluatorConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

level

The updated evaluation level (TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.

Type: String

Valid Values: TOOL_CALL | TRACE | SESSION

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "evaluatorArn": "string",
   "evaluatorId": "string",
   "status": "string",
   "updatedAt": number
}

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.

evaluatorArn

The Amazon Resource Name (ARN) of the updated evaluator.

Type: String

Pattern: arn:aws:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:evaluator\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}$|^arn:aws:bedrock-agentcore:::evaluator/Builtin.[a-zA-Z0-9_-]+

evaluatorId

The unique identifier of the updated evaluator.

Type: String

Pattern: (Builtin.[a-zA-Z0-9_-]+|[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10})

status

The status of the evaluator update operation.

Type: String

updatedAt

The timestamp when the evaluator was last updated.

Type: Timestamp

Errors

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

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400