2026/09/03 - Amazon Bedrock AgentCore - 2 updated api methods
Changes Adds log group name prefix trace source selection, custom or source log group result destinations, and metrics namespace customization
{'dataSourceConfig': {'cloudWatchLogs': {'logGroupNamePrefixes': ['string']}},
'outputConfig': {'cloudWatchConfig': {'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP '
'| '
'SOURCE_LOG_GROUP'}}}
Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
See also: AWS API Documentation
Request Syntax
client.get_batch_evaluation(
batchEvaluationId='string'
)
string
[REQUIRED]
The unique identifier of the batch evaluation to retrieve.
dict
Response Syntax
{
'batchEvaluationId': 'string',
'batchEvaluationArn': 'string',
'batchEvaluationName': 'string',
'status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'|'STOPPING'|'STOPPED'|'DELETING',
'createdAt': datetime(2015, 1, 1),
'evaluators': [
{
'evaluatorId': 'string'
},
],
'insights': [
{
'insightId': 'string'
},
],
'dataSourceConfig': {
'cloudWatchLogs': {
'serviceNames': [
'string',
],
'logGroupNames': [
'string',
],
'logGroupNamePrefixes': [
'string',
],
'filterConfig': {
'sessionIds': [
'string',
],
'timeRange': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
}
},
'onlineEvaluationConfigSource': {
'onlineEvaluationConfigArn': 'string',
'timeRange': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
}
},
'outputConfig': {
'cloudWatchConfig': {
'logGroupName': 'string',
'logStreamName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP'|'SOURCE_LOG_GROUP'
}
},
'evaluationResults': {
'numberOfSessionsCompleted': 123,
'numberOfSessionsInProgress': 123,
'numberOfSessionsFailed': 123,
'totalNumberOfSessions': 123,
'numberOfSessionsIgnored': 123,
'evaluatorSummaries': [
{
'evaluatorId': 'string',
'statistics': {
'averageScore': 123.0
},
'totalEvaluated': 123,
'totalFailed': 123
},
]
},
'failureAnalysisResult': {
'failures': [
{
'clusterId': 123,
'name': 'string',
'description': 'string',
'affectedSessionCount': 123,
'subCategories': [
{
'clusterId': 123,
'name': 'string',
'description': 'string',
'affectedSessionCount': 123,
'rootCauses': [
{
'clusterId': 123,
'name': 'string',
'rootCause': 'string',
'recommendation': 'string',
'affectedSessionCount': 123,
'affectedSessions': [
{
'sessionId': 'string',
'explanation': 'string',
'fixType': 'string',
'recommendation': 'string',
'failureSpans': [
{
'spanId': 'string',
'traceId': 'string',
'signals': [
{
'category': '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'|'other',
'evidence': 'string',
'confidence': 123.0
},
]
},
]
},
]
},
]
},
]
},
]
},
'userIntentResult': {
'userIntents': [
{
'clusterId': 123,
'name': 'string',
'description': 'string',
'affectedSessionCount': 123,
'affectedSessions': [
{
'sessionId': 'string',
'userMessages': [
'string',
]
},
]
},
]
},
'executionSummaryResult': {
'executionSummaries': [
{
'clusterId': 123,
'name': 'string',
'description': 'string',
'affectedSessionCount': 123,
'affectedSessions': [
{
'sessionId': 'string',
'approachTaken': 'string',
'finalOutcome': 'string'
},
]
},
]
},
'errorDetails': [
'string',
],
'description': 'string',
'updatedAt': datetime(2015, 1, 1),
'kmsKeyArn': 'string'
}
Response Structure
(dict) --
batchEvaluationId (string) --
The unique identifier of the batch evaluation.
batchEvaluationArn (string) --
The Amazon Resource Name (ARN) of the batch evaluation.
batchEvaluationName (string) --
The name of the batch evaluation.
status (string) --
The current status of the batch evaluation.
createdAt (datetime) --
The timestamp when the batch evaluation was created.
evaluators (list) --
The list of evaluators applied during the batch evaluation.
(dict) --
An evaluator to run against sessions during batch evaluation.
evaluatorId (string) --
The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
insights (list) --
The list of insight analyses applied during the batch evaluation.
(dict) --
A reference to an insight analysis to run against sessions during batch evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
insightId (string) --
The unique identifier of the insight to run.
dataSourceConfig (dict) --
The data source configuration specifying where agent traces are pulled from.
cloudWatchLogs (dict) --
Configuration for pulling agent session traces from CloudWatch Logs.
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 10 log groups.
(string) --
logGroupNamePrefixes (list) --
The list of CloudWatch log group name prefixes to read agent traces from. Specify this instead of logGroupNames to match log groups by prefix. Maximum of 5 prefixes. Specify either logGroupNames or logGroupNamePrefixes, not both. One of the two is required.
(string) --
Prefix of a CloudWatch Logs log group name.
filterConfig (dict) --
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 (dict) --
The time range filter for selecting sessions to evaluate.
startTime (datetime) --
The start time of the time range. Only sessions with activity at or after this timestamp are included.
endTime (datetime) --
The end time of the time range. Only sessions with activity before this timestamp are included.
onlineEvaluationConfigSource (dict) --
Reference an existing OnlineEvaluationConfig as session source
onlineEvaluationConfigArn (string) --
The Amazon Resource Name (ARN) of the online evaluation configuration to use as the session source.
timeRange (dict) --
Optional session filter configuration to narrow down which sessions from the online evaluation configuration to include.
startTime (datetime) --
The start time of the time range. Only sessions with activity at or after this timestamp are included.
endTime (datetime) --
The end time of the time range. Only sessions with activity before this timestamp are included.
outputConfig (dict) --
The output configuration specifying where evaluation results are written.
cloudWatchConfig (dict) --
The CloudWatch Logs configuration for writing evaluation results.
logGroupName (string) --
The name of the CloudWatch log group where evaluation results will be written. This value doesn't apply when resultDestination is SOURCE_LOG_GROUP, because results are written back to the trace source log group. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from the service-managed default group.
logStreamName (string) --
The name of the CloudWatch log stream where evaluation results will be written.
metricsNamespace (string) --
The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.
resultDestination (string) --
The destination where evaluation results are written. Valid values:
DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.
SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.
evaluationResults (dict) --
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.
(dict) --
Summary statistics for a single evaluator within a batch evaluation.
evaluatorId (string) --
The unique identifier of the evaluator.
statistics (dict) --
The aggregated statistics for this evaluator.
averageScore (float) --
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 (dict) --
The failure analysis results from insights, containing categorized failure clusters with root causes and recommendations.
failures (list) --
The list of failure category clusters identified across analyzed sessions.
(dict) --
A top-level failure category identified by clustering similar failure patterns across sessions.
clusterId (integer) --
The unique identifier of the failure category cluster.
name (string) --
The name of the failure category.
description (string) --
A description of the failure category pattern.
affectedSessionCount (integer) --
The number of sessions affected by this failure category.
subCategories (list) --
The list of failure subcategories within this category.
(dict) --
A subcategory of failures within a top-level failure category.
clusterId (integer) --
The unique identifier of the failure subcategory cluster.
name (string) --
The name of the failure subcategory.
description (string) --
A description of the failure subcategory pattern.
affectedSessionCount (integer) --
The number of sessions affected by this failure subcategory.
rootCauses (list) --
The list of root cause clusters identified within this subcategory.
(dict) --
A cluster of similar root causes identified within a failure subcategory.
clusterId (integer) --
The unique identifier of the root cause cluster.
name (string) --
The name of the root cause cluster.
rootCause (string) --
The root cause explanation for this cluster of failures.
recommendation (string) --
The recommended fix for this root cause.
affectedSessionCount (integer) --
The number of sessions affected by this root cause.
affectedSessions (list) --
The list of sessions affected by this root cause.
(dict) --
A session affected by a detected failure pattern, including root cause details.
sessionId (string) --
The unique identifier of the affected session.
explanation (string) --
An explanation of how the failure manifested in this session.
fixType (string) --
The type of fix recommended for this failure.
recommendation (string) --
The specific fix recommendation for this session.
failureSpans (list) --
The list of spans where failures were detected in this session.
(dict) --
Details about a specific span where a failure was detected.
spanId (string) --
The unique identifier of the span where the failure occurred.
traceId (string) --
The trace identifier associated with the failure span.
signals (list) --
The failure signals detected in this span.
(dict) --
A signal indicating a detected failure within a span.
category (string) --
The failure category classification for this signal.
evidence (string) --
The evidence supporting the failure detection.
confidence (float) --
The confidence score of the failure detection.
userIntentResult (dict) --
The user intent clustering results from insights, containing grouped user intents across evaluated sessions.
userIntents (list) --
The list of user intent clusters identified across analyzed sessions.
(dict) --
A cluster of similar user intents identified across sessions.
clusterId (integer) --
The unique identifier of the user intent cluster.
name (string) --
The name of the user intent cluster.
description (string) --
A description of the user intent pattern.
affectedSessionCount (integer) --
The number of sessions with this user intent.
affectedSessions (list) --
The list of sessions with this user intent.
(dict) --
A session associated with a user intent cluster.
sessionId (string) --
The unique identifier of the session.
userMessages (list) --
The user messages from this session that contributed to the intent cluster.
(string) --
executionSummaryResult (dict) --
The execution summary clustering results from insights, containing grouped execution patterns across evaluated sessions.
executionSummaries (list) --
The list of execution summary clusters identified across analyzed sessions.
(dict) --
A cluster of similar execution patterns identified across sessions.
clusterId (integer) --
The unique identifier of the execution summary cluster.
name (string) --
The name of the execution pattern cluster.
description (string) --
A description of the execution pattern.
affectedSessionCount (integer) --
The number of sessions with this execution pattern.
affectedSessions (list) --
The list of sessions with this execution pattern.
(dict) --
A session associated with an execution summary cluster.
sessionId (string) --
The unique identifier of the session.
approachTaken (string) --
The approach taken by the agent during this session.
finalOutcome (string) --
The final outcome of the session.
errorDetails (list) --
The error details if the batch evaluation encountered failures.
(string) --
description (string) --
The description of the batch evaluation.
updatedAt (datetime) --
The timestamp when the batch evaluation was last updated.
kmsKeyArn (string) --
The ARN of the KMS key used to encrypt evaluation data.
{'dataSourceConfig': {'cloudWatchLogs': {'logGroupNamePrefixes': ['string']}},
'outputConfig': {'cloudWatchConfig': {'logGroupName': 'string',
'logStreamName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP '
'| '
'SOURCE_LOG_GROUP'}}}
Response {'outputConfig': {'cloudWatchConfig': {'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP '
'| '
'SOURCE_LOG_GROUP'}}}
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
Request Syntax
client.start_batch_evaluation(
batchEvaluationName='string',
evaluators=[
{
'evaluatorId': 'string'
},
],
insights=[
{
'insightId': 'string'
},
],
dataSourceConfig={
'cloudWatchLogs': {
'serviceNames': [
'string',
],
'logGroupNames': [
'string',
],
'logGroupNamePrefixes': [
'string',
],
'filterConfig': {
'sessionIds': [
'string',
],
'timeRange': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
}
},
'onlineEvaluationConfigSource': {
'onlineEvaluationConfigArn': 'string',
'timeRange': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
}
},
clientToken='string',
evaluationMetadata={
'sessionMetadata': [
{
'sessionId': 'string',
'testScenarioId': 'string',
'groundTruth': {
'inline': {
'assertions': [
{
'text': 'string'
},
],
'expectedTrajectory': {
'toolNames': [
'string',
]
},
'turns': [
{
'input': {
'prompt': 'string'
},
'expectedResponse': {
'text': 'string'
}
},
]
}
},
'metadata': {
'string': 'string'
}
},
]
},
tags={
'string': 'string'
},
kmsKeyArn='string',
description='string',
outputConfig={
'cloudWatchConfig': {
'logGroupName': 'string',
'logStreamName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP'|'SOURCE_LOG_GROUP'
}
}
)
string
[REQUIRED]
The name of the batch evaluation. Must be unique within your account.
list
The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.
(dict) --
An evaluator to run against sessions during batch evaluation.
evaluatorId (string) -- [REQUIRED]
The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
list
The list of insight analyses to run against sessions during the batch evaluation. Maximum of 10 insights.
(dict) --
A reference to an insight analysis to run against sessions during batch evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
insightId (string) -- [REQUIRED]
The unique identifier of the insight to run.
dict
[REQUIRED]
The data source configuration that specifies where to pull agent session traces from for evaluation.
cloudWatchLogs (dict) --
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.
(string) --
logGroupNames (list) --
The list of CloudWatch log group names to read agent traces from. Maximum of 10 log groups.
(string) --
logGroupNamePrefixes (list) --
The list of CloudWatch log group name prefixes to read agent traces from. Specify this instead of logGroupNames to match log groups by prefix. Maximum of 5 prefixes. Specify either logGroupNames or logGroupNamePrefixes, not both. One of the two is required.
(string) --
Prefix of a CloudWatch Logs log group name.
filterConfig (dict) --
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 (dict) --
The time range filter for selecting sessions to evaluate.
startTime (datetime) --
The start time of the time range. Only sessions with activity at or after this timestamp are included.
endTime (datetime) --
The end time of the time range. Only sessions with activity before this timestamp are included.
onlineEvaluationConfigSource (dict) --
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.
timeRange (dict) --
Optional session filter configuration to narrow down which sessions from the online evaluation configuration to include.
startTime (datetime) --
The start time of the time range. Only sessions with activity at or after this timestamp are included.
endTime (datetime) --
The end time of the time range. Only sessions with activity before this timestamp are included.
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.
This field is autopopulated if not provided.
dict
Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.
sessionMetadata (list) --
A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.
(dict) --
Metadata for a specific session in a batch evaluation, including ground truth data and test scenario identifiers.
sessionId (string) -- [REQUIRED]
The unique identifier of the session this metadata applies to.
testScenarioId (string) --
An optional test scenario identifier for categorizing and tracking evaluation results.
groundTruth (dict) --
The ground truth data for this session, including expected responses and assertions.
inline (dict) --
Inline ground truth data provided directly in the request.
assertions (list) --
Assertions for evaluation, reuses common model EvaluationContentList.
(dict) --
A content block for ground truth data in evaluation reference inputs. Supports text content for expected responses and assertions.
text (string) --
The text content of the ground truth data. Used for expected response text and assertion statements.
expectedTrajectory (dict) --
The expected tool call sequence for trajectory evaluation.
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.
(dict) --
Ground truth data for a single conversation turn.
input (dict) --
The input for this conversation turn.
prompt (string) --
The text prompt for this conversation turn.
expectedResponse (dict) --
The expected response for this conversation turn.
text (string) --
The text content of the ground truth data. Used for expected response text and assertion statements.
metadata (dict) --
Additional key-value metadata associated with this session.
(string) --
(string) --
dict
A map of tag keys and values to associate with the batch evaluation.
(string) --
(string) --
string
The ARN of the KMS key used to encrypt evaluation data. If provided, customer data is encrypted at rest with the specified key.
string
The description of the batch evaluation.
dict
Output destination configuration.
cloudWatchConfig (dict) --
The CloudWatch Logs configuration for writing evaluation results.
logGroupName (string) --
The name of the CloudWatch log group where evaluation results will be written. This value doesn't apply when resultDestination is SOURCE_LOG_GROUP, because results are written back to the trace source log group. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from the service-managed default group.
logStreamName (string) --
The name of the CloudWatch log stream where evaluation results will be written.
metricsNamespace (string) --
The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.
resultDestination (string) --
The destination where evaluation results are written. Valid values:
DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.
SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.
dict
Response Syntax
{
'batchEvaluationId': 'string',
'batchEvaluationArn': 'string',
'batchEvaluationName': 'string',
'evaluators': [
{
'evaluatorId': 'string'
},
],
'insights': [
{
'insightId': 'string'
},
],
'status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'|'STOPPING'|'STOPPED'|'DELETING',
'createdAt': datetime(2015, 1, 1),
'outputConfig': {
'cloudWatchConfig': {
'logGroupName': 'string',
'logStreamName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP'|'SOURCE_LOG_GROUP'
}
},
'tags': {
'string': 'string'
},
'kmsKeyArn': 'string',
'description': 'string'
}
Response Structure
(dict) --
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.
(dict) --
An evaluator to run against sessions during batch evaluation.
evaluatorId (string) --
The unique identifier of the evaluator. Can reference built-in evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
insights (list) --
The list of insight analyses applied during the batch evaluation.
(dict) --
A reference to an insight analysis to run against sessions during batch evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
insightId (string) --
The unique identifier of the insight to run.
status (string) --
The status of the batch evaluation.
createdAt (datetime) --
The timestamp when the batch evaluation was created.
outputConfig (dict) --
The output configuration specifying where evaluation results are written.
cloudWatchConfig (dict) --
The CloudWatch Logs configuration for writing evaluation results.
logGroupName (string) --
The name of the CloudWatch log group where evaluation results will be written. This value doesn't apply when resultDestination is SOURCE_LOG_GROUP, because results are written back to the trace source log group. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from the service-managed default group.
logStreamName (string) --
The name of the CloudWatch log stream where evaluation results will be written.
metricsNamespace (string) --
The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.
resultDestination (string) --
The destination where evaluation results are written. Valid values:
DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.
SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.
tags (dict) --
The tags associated with the batch evaluation.
(string) --
(string) --
kmsKeyArn (string) --
The ARN of the KMS key used to encrypt evaluation data.
description (string) --
The description of the batch evaluation.