Bedrock Agentcore Control  >  Operations  >  get_evaluator

get_evaluator

Operation

get_evaluator async

get_evaluator(input: GetEvaluatorInput, plugins: list[Plugin] | None = None) -> GetEvaluatorOutput

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

Parameters:

Name	Type	Description	Default
input	GetEvaluatorInput	An instance of GetEvaluatorInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
GetEvaluatorOutput	An instance of GetEvaluatorOutput.

Input

GetEvaluatorInput dataclass

Dataclass for GetEvaluatorInput structure.

Attributes

evaluator_id class-attribute instance-attribute

evaluator_id: str | None = None

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

included_data class-attribute instance-attribute

included_data: IncludedData | None = None

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 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 KMS permissions.

Output

GetEvaluatorOutput dataclass

Dataclass for GetEvaluatorOutput structure.

Attributes

created_at instance-attribute

created_at: datetime

The timestamp when the evaluator was created.

description class-attribute instance-attribute

description: str | None = field(repr=False, default=None)

The description of the evaluator.

evaluator_arn instance-attribute

evaluator_arn: str

The Amazon Resource Name (ARN) of the evaluator.

evaluator_config instance-attribute

evaluator_config: EvaluatorConfig

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

evaluator_id instance-attribute

evaluator_id: str

The unique identifier of the evaluator.

evaluator_name instance-attribute

evaluator_name: str

The name of the evaluator.

kms_key_arn class-attribute instance-attribute

kms_key_arn: str | None = None

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

level instance-attribute

level: EvaluatorLevel

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

locked_for_modification class-attribute instance-attribute

locked_for_modification: bool | None = None

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

status instance-attribute

status: EvaluatorStatus

The current status of the evaluator.

updated_at instance-attribute

updated_at: datetime

The timestamp when the evaluator was last updated.