AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore ]

start-batch-evaluation

Description

Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.

See also: AWS API Documentation

Synopsis

  start-batch-evaluation
--batch-evaluation-name <value>
[--evaluators <value>]
--data-source-config <value>
[--client-token <value>]
[--evaluation-metadata <value>]
[--description <value>]
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--batch-evaluation-name (string)

The name of the batch evaluation. Must be unique within your account.

--evaluators (list)

The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

(structure)

An evaluator to run against sessions

evaluatorId -> (string)

The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness ) or custom evaluators.

Shorthand Syntax:

evaluatorId=string ...

JSON Syntax:

[
  {
    "evaluatorId": "string"
  }
  ...
]

--data-source-config (tagged union structure)

The data source configuration that specifies where to pull agent session traces from for evaluation.

Note

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

cloudWatchLogs -> (structure)

Pull session spans from CloudWatch

serviceNames -> (list)

The list of agent service names to filter traces within the specified log groups.

(string)

logGroupNames -> (list)

The list of CloudWatch log group names to read agent traces from. Maximum of 5 log groups.

(string)

filterConfig -> (structure)

Optional filter configuration to narrow down which sessions to evaluate.

sessionIds -> (list)

A list of specific session IDs to evaluate. If specified, only these sessions are included in the evaluation.

(string)

timeRange -> (structure)

The time range filter for selecting sessions to evaluate.

startTime -> (timestamp)

The start time of the time range. Only sessions with activity at or after this timestamp are included.

endTime -> (timestamp)

The end time of the time range. Only sessions with activity before this timestamp are included.

JSON Syntax:

{
  "cloudWatchLogs": {
    "serviceNames": ["string", ...],
    "logGroupNames": ["string", ...],
    "filterConfig": {
      "sessionIds": ["string", ...],
      "timeRange": {
        "startTime": timestamp,
        "endTime": timestamp
      }
    }
  }
}

--client-token (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

--evaluation-metadata (tagged union structure)

Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.

Note

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

sessionMetadata -> (list)

A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.

(structure)

Metadata for a specific session in a batch evaluation, including ground truth data and test scenario identifiers.

sessionId -> (string)

The unique identifier of the session this metadata applies to.

testScenarioId -> (string)

An optional test scenario identifier for categorizing and tracking evaluation results.

groundTruth -> (tagged union structure)

The ground truth data for this session, including expected responses and assertions.

Note

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

inline -> (structure)

Provide ground truth inline

assertions -> (list)

assertions for evaluation, reuses common model EvaluationContentList

(tagged union structure)

A content block for ground truth data in evaluation reference inputs. Supports text content for expected responses and assertions.

Note

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

text -> (string)

The text content of the ground truth data. Used for expected response text and assertion statements.

expectedTrajectory -> (structure)

expectedTrajectory for evaluation, reuses common model EvaluationExpectedTrajectory

toolNames -> (list)

The list of tool names representing the expected tool call sequence.

(string)

turns -> (list)

A list of per-turn ground truth data, each containing an input prompt and expected response.

(structure)

Ground truth data for a single conversation turn.

input -> (tagged union structure)

The input for this conversation turn.

Note

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

prompt -> (string)

The text prompt for this conversation turn.

expectedResponse -> (tagged union structure)

The expected response for this conversation turn.

Note

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

text -> (string)

The text content of the ground truth data. Used for expected response text and assertion statements.

metadata -> (map)

Additional key-value metadata associated with this session.

key -> (string)

value -> (string)

JSON Syntax:

{
  "sessionMetadata": [
    {
      "sessionId": "string",
      "testScenarioId": "string",
      "groundTruth": {
        "inline": {
          "assertions": [
            {
              "text": "string"
            }
            ...
          ],
          "expectedTrajectory": {
            "toolNames": ["string", ...]
          },
          "turns": [
            {
              "input": {
                "prompt": "string"
              },
              "expectedResponse": {
                "text": "string"
              }
            }
            ...
          ]
        }
      },
      "metadata": {"string": "string"
        ...}
    }
    ...
  ]
}

--description (string)

The description of the batch evaluation.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

batchEvaluationId -> (string)

The unique identifier of the created batch evaluation.

batchEvaluationArn -> (string)

The Amazon Resource Name (ARN) of the created batch evaluation.

batchEvaluationName -> (string)

The name of the batch evaluation.

evaluators -> (list)

The list of evaluators applied during the batch evaluation.

(structure)

An evaluator to run against sessions

evaluatorId -> (string)

The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness ) or custom evaluators.

status -> (string)

The status of the batch evaluation.

createdAt -> (timestamp)

The timestamp when the batch evaluation was created.

outputConfig -> (tagged union structure)

The output configuration specifying where evaluation results are written.

Note

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

cloudWatchConfig -> (structure)

The CloudWatch Logs configuration for writing evaluation results.

logGroupName -> (string)

The name of the CloudWatch log group where evaluation results will be written.

logStreamName -> (string)

The name of the CloudWatch log stream where evaluation results will be written.

description -> (string)

The description of the batch evaluation.