AWS CLI Command Reference

[ aws . bedrock-agentcore-control ]

get-evaluator

Description

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

See also: AWS API Documentation

get-evaluator uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  get-evaluator
--evaluator-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--evaluator-id (string) [required]

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

Constraints:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

evaluatorArn -> (string)

The Amazon Resource Name (ARN) of the evaluator.

Constraints:

  • 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 -> (string)

The unique identifier of the evaluator.

Constraints:

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

evaluatorName -> (string)

The name of the evaluator.

Constraints:

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

description -> (string)

The description of the evaluator.

Constraints:

  • min: 1
  • max: 200

evaluatorConfig -> (tagged union structure)

The configuration of the evaluator, including LLM-as-a-Judge settings for custom evaluators.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: llmAsAJudge.

llmAsAJudge -> (structure)

The LLM-as-a-Judge configuration that uses a language model to evaluate agent performance based on custom instructions and rating scales.

instructions -> (string) [required]

The evaluation instructions that guide the language model in assessing agent performance, including criteria and evaluation guidelines.

ratingScale -> (tagged union structure) [required]

The rating scale that defines how the evaluator should score agent performance, either numerical or categorical.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: numerical, categorical.

numerical -> (list)

The numerical rating scale with defined score values and descriptions for quantitative evaluation.

(structure)

The definition of a numerical rating scale option that provides a numeric value with its description for evaluation scoring.

definition -> (string) [required]

The description that explains what this numerical rating represents and when it should be used.

value -> (double) [required]

The numerical value for this rating scale option.

Constraints:

  • min: 0

label -> (string) [required]

The label or name that describes this numerical rating option.

Constraints:

  • min: 1
  • max: 100

categorical -> (list)

The categorical rating scale with named categories and definitions for qualitative evaluation.

(structure)

The definition of a categorical rating scale option that provides a named category with its description for evaluation scoring.

definition -> (string) [required]

The description that explains what this categorical rating represents and when it should be used.

label -> (string) [required]

The label or name of this categorical rating option.

Constraints:

  • min: 1
  • max: 100

modelConfig -> (tagged union structure) [required]

The model configuration that specifies which foundation model to use and how to configure it for evaluation.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bedrockEvaluatorModelConfig.

bedrockEvaluatorModelConfig -> (structure)

The Amazon Bedrock model configuration for evaluation.

modelId -> (string) [required]

The identifier of the Amazon Bedrock model to use for evaluation. Must be a supported foundation model available in your region.

inferenceConfig -> (structure)

The inference configuration parameters that control model behavior during evaluation, including temperature, token limits, and sampling settings.

maxTokens -> (integer)

The maximum number of tokens to generate in the model response during evaluation.

Constraints:

  • min: 1

temperature -> (float)

The temperature value that controls randomness in the model’s responses. Lower values produce more deterministic outputs.

Constraints:

  • min: 0
  • max: 1

topP -> (float)

The top-p sampling parameter that controls the diversity of the model’s responses by limiting the cumulative probability of token choices.

Constraints:

  • min: 0
  • max: 1

stopSequences -> (list)

The list of sequences that will cause the model to stop generating tokens when encountered.

Constraints:

  • min: 0
  • max: 2500

(string)

Constraints:

  • min: 1

additionalModelRequestFields -> (document)

Additional model-specific request fields to customize model behavior beyond the standard inference configuration.

level -> (string)

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

Possible values:

  • TOOL_CALL
  • TRACE
  • SESSION

status -> (string)

The current status of the evaluator.

Possible values:

  • ACTIVE
  • CREATING
  • CREATE_FAILED
  • UPDATING
  • UPDATE_FAILED
  • DELETING

createdAt -> (timestamp)

The timestamp when the evaluator was created.

updatedAt -> (timestamp)

The timestamp when the evaluator was last updated.

lockedForModification -> (boolean)

Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.
© Copyright 2025, Amazon Web Services. Created using Sphinx.