[ aws . bedrock-agentcore ]

get-batch-evaluation

Description

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

See also: AWS API Documentation

Synopsis

  get-batch-evaluation
--batch-evaluation-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]
[--cli-error-format <value>]

Options

--batch-evaluation-id (string) [required]

The unique identifier of the batch evaluation to retrieve.

Constraints:

• pattern: [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
• off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

batchEvaluationId -> (string)

The unique identifier of the batch evaluation.

Constraints:

• pattern: [a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

batchEvaluationArn -> (string)

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

batchEvaluationName -> (string)

The name of the batch evaluation.

Constraints:

• pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}

status -> (string)

The current status of the batch evaluation.

Possible values:

• PENDING
• IN_PROGRESS
• COMPLETED
• COMPLETED_WITH_ERRORS
• FAILED
• STOPPING
• STOPPED
• DELETING

createdAt -> (timestamp)

The timestamp when the batch evaluation was created.

evaluators -> (list)

The list of evaluators applied during the batch evaluation.

(structure)

An evaluator to run against sessions

evaluatorId -> (string) [required]

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

Constraints:

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

insights -> (list)

The list of insight analyses applied during the batch evaluation.

Constraints:

• min: 0
• max: 10

(structure)

A reference to an insight analysis to run against sessions.

insightId -> (string) [required]

Canonical insight identifiers using the Builtin.Insight.* naming convention. Used by BatchEvaluate, InternalEvaluate, and ServiceEngineEvaluate flows.

Constraints:

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

dataSourceConfig -> (tagged union structure)

The data source configuration specifying where agent traces are pulled from.

Note

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

cloudWatchLogs -> (structure)

Configuration for pulling agent session traces from CloudWatch Logs.

serviceNames -> (list) [required]

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

Constraints:

• min: 1
• max: 1

(string)

logGroupNames -> (list) [required]

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

Constraints:

• min: 1
• max: 5

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

Constraints:

• min: 0
• max: 500

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

onlineEvaluationConfigSource -> (structure)

Reference an existing OnlineEvaluationConfig as session source

onlineEvaluationConfigArn -> (string) [required]

The Amazon Resource Name (ARN) of the online evaluation configuration to use as the session source.

Constraints:

• pattern: arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:online-evaluation-config\/[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}

sessionFilterConfig -> (structure)

Optional session filter configuration to narrow down which sessions from the online evaluation configuration to include.

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.

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) [required]

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

logStreamName -> (string) [required]

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

evaluationResults -> (structure)

The aggregated evaluation results, including session completion counts and evaluator score summaries.

numberOfSessionsCompleted -> (integer)

The number of sessions that have been successfully evaluated.

numberOfSessionsInProgress -> (integer)

The number of sessions currently being evaluated.

numberOfSessionsFailed -> (integer)

The number of sessions that failed evaluation.

totalNumberOfSessions -> (integer)

The total number of sessions included in the batch evaluation.

numberOfSessionsIgnored -> (integer)

The number of sessions that were ignored during evaluation.

evaluatorSummaries -> (list)

A list of per-evaluator summary statistics.

(structure)

Summary statistics for a single evaluator within a batch evaluation.

evaluatorId -> (string)

The unique identifier of the evaluator.

statistics -> (structure)

The aggregated statistics for this evaluator.

averageScore -> (double)

The average score across all evaluated sessions for this evaluator.

totalEvaluated -> (integer)

The total number of sessions evaluated by this evaluator.

totalFailed -> (integer)

The total number of sessions that failed evaluation by this evaluator.

failureAnalysisResult -> (structure)

Unified customer-facing clustering result written to S3.

failures -> (list) [required]

The list of failure category clusters identified across analyzed sessions.

Constraints:

• min: 0

(structure)

A top-level failure category identified by clustering similar failure patterns across sessions.

clusterId -> (integer) [required]

The unique identifier of the failure category cluster.

name -> (string) [required]

The name of the failure category.

description -> (string) [required]

A description of the failure category pattern.

affectedSessionCount -> (integer) [required]

The number of sessions affected by this failure category.

subCategories -> (list) [required]

The list of failure subcategories within this category.

Constraints:

• min: 0

(structure)

A subcategory of failures within a top-level failure category.

clusterId -> (integer) [required]

The unique identifier of the failure subcategory cluster.

name -> (string) [required]

The name of the failure subcategory.

description -> (string) [required]

A description of the failure subcategory pattern.

affectedSessionCount -> (integer) [required]

The number of sessions affected by this failure subcategory.

rootCauses -> (list) [required]

The list of root cause clusters identified within this subcategory.

Constraints:

• min: 0

(structure)

A cluster of similar root causes identified within a failure subcategory.

clusterId -> (integer) [required]

The unique identifier of the root cause cluster.

name -> (string) [required]

The name of the root cause cluster.

rootCause -> (string) [required]

The root cause explanation for this cluster of failures.

recommendation -> (string) [required]

The recommended fix for this root cause.

affectedSessionCount -> (integer) [required]

The number of sessions affected by this root cause.

affectedSessions -> (list) [required]

The list of sessions affected by this root cause.

Constraints:

• min: 0

(structure)

A session affected by a detected failure pattern, including root cause details.

sessionId -> (string) [required]

The unique identifier of the affected session.

explanation -> (string) [required]

An explanation of how the failure manifested in this session.

fixType -> (string) [required]

The type of fix recommended for this failure.

recommendation -> (string) [required]

The specific fix recommendation for this session.

failureSpans -> (list) [required]

The list of spans where failures were detected in this session.

Constraints:

• min: 0

(structure)

Details about a specific span where a failure was detected.

spanId -> (string) [required]

The unique identifier of the span where the failure occurred.

traceId -> (string) [required]

The trace identifier associated with the failure span.

signals -> (list) [required]

The failure signals detected in this span.

(structure)

A signal indicating a detected failure within a span.

category -> (string) [required]

Failure category taxonomy for agent session insights. Values must stay in sync with the category registry in AgentCoreLens (amzn_agentcore_lens.config.failure_detection.FAILURE_CATEGORIES).

Possible values:

• execution-error-category-authentication
• execution-error-category-resource-not-found
• execution-error-category-service-errors
• execution-error-category-rate-limiting
• execution-error-category-formatting
• execution-error-category-timeout
• execution-error-category-resource-exhaustion
• execution-error-category-environment
• execution-error-category-tool-schema
• task-instruction-category-non-compliance
• task-instruction-category-problem-id
• incorrect-actions-category-tool-selection
• incorrect-actions-category-poor-information-retrieval
• incorrect-actions-category-clarification
• incorrect-actions-category-inappropriate-info-request
• context-handling-error-category-context-handling-failures
• hallucination-category-hall-capabilities
• hallucination-category-hall-misunderstand
• hallucination-category-hall-usage
• hallucination-category-hall-history
• hallucination-category-hall-params
• hallucination-category-fabricate-tool-outputs
• repetitive-behavior-category-repetition-tool
• repetitive-behavior-category-repetition-info
• repetitive-behavior-category-step-repetition
• orchestration-related-errors-category-reasoning-mismatch
• orchestration-related-errors-category-goal-deviation
• orchestration-related-errors-category-premature-termination
• orchestration-related-errors-category-unaware-termination
• llm-output-category-nonsensical
• configuration-mismatch-category-tool-definition
• coding-use-case-specific-failure-types-category-edge-case-oversights
• coding-use-case-specific-failure-types-category-dependency-issues

evidence -> (string) [required]

The evidence supporting the failure detection.

confidence -> (double) [required]

The confidence score of the failure detection.

userIntentResult -> (structure)

Customer-facing user intent clustering result written to S3.

userIntents -> (list) [required]

The list of user intent clusters identified across analyzed sessions.

Constraints:

• min: 0

(structure)

A cluster of similar user intents identified across sessions.

clusterId -> (integer) [required]

The unique identifier of the user intent cluster.

name -> (string) [required]

The name of the user intent cluster.

description -> (string) [required]

A description of the user intent pattern.

affectedSessionCount -> (integer) [required]

The number of sessions with this user intent.

affectedSessions -> (list) [required]

The list of sessions with this user intent.

Constraints:

• min: 0

(structure)

A session associated with a user intent cluster.

sessionId -> (string) [required]

The unique identifier of the session.

userMessages -> (list) [required]

The user messages from this session that contributed to the intent cluster.

(string)

executionSummaryResult -> (structure)

Customer-facing execution summary clustering result written to S3.

executionSummaries -> (list) [required]

The list of execution summary clusters identified across analyzed sessions.

Constraints:

• min: 0

(structure)

A cluster of similar execution patterns identified across sessions.

clusterId -> (integer) [required]

The unique identifier of the execution summary cluster.

name -> (string) [required]

The name of the execution pattern cluster.

description -> (string) [required]

A description of the execution pattern.

affectedSessionCount -> (integer) [required]

The number of sessions with this execution pattern.

affectedSessions -> (list) [required]

The list of sessions with this execution pattern.

Constraints:

• min: 0

(structure)

A session associated with an execution summary cluster.

sessionId -> (string) [required]

The unique identifier of the session.

approachTaken -> (string) [required]

The approach taken by the agent during this session.

finalOutcome -> (string) [required]

The final outcome of the session.

errorDetails -> (list)

The error details if the batch evaluation encountered failures.

Constraints:

• min: 0
• max: 1

(string)

Constraints:

• min: 0
• max: 1000

description -> (string)

The description of the batch evaluation.

Constraints:

• min: 0
• max: 200

updatedAt -> (timestamp)

The timestamp when the batch evaluation was last updated.

kmsKeyArn -> (string)

The ARN of the KMS key used to encrypt evaluation data.

Constraints:

• min: 1
• max: 2048
• pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}