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

GetEvaluator

Retrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.

Request Syntax


GET /evaluators/evaluatorId?includedData=includedData HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

evaluatorId

The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.

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

Required: Yes

includedData

Controls which data is returned in the response. ALL_DATA (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed AWS KMS key, this requires kms:Decrypt permission on the key. METADATA_ONLY returns evaluator metadata and model configuration without instructions or rating scale, and does not require any AWS KMS permissions.

Valid Values: ALL_DATA | METADATA_ONLY

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "description": "string",
   "evaluatorArn": "string",
   "evaluatorConfig": { ... },
   "evaluatorId": "string",
   "evaluatorName": "string",
   "kmsKeyArn": "string",
   "level": "string",
   "lockedForModification": boolean,
   "status": "string",
   "updatedAt": number
}

Response Elements

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

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

createdAt

The timestamp when the evaluator was created.

Type: Timestamp

description

The description of the evaluator.

Type: String

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

evaluatorArn

The Amazon Resource Name (ARN) of the 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_-]+

evaluatorConfig

The configuration of the evaluator, including LLM-as-a-Judge or code-based settings.

Type: EvaluatorConfig object

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

evaluatorId

The unique identifier of the evaluator.

Type: String

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

evaluatorName

The name of the evaluator.

Type: String

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

kmsKeyArn

The Amazon Resource Name (ARN) of the customer managed AWS KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.

Type: String

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

Pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

level

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

Type: String

Valid Values: TOOL_CALL | TRACE | SESSION

lockedForModification

Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.

Type: Boolean

status

The current status of the evaluator.

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 Error Types.

AccessDeniedException

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

HTTP Status Code: 403

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

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