Start batch evaluation
Start a batch evaluation to run evaluators against multiple agent sessions. The service discovers sessions from CloudWatch Logs, runs each evaluator against each session, and produces aggregate results.
Code samples
Example
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
|
|
String |
Yes |
A name for the batch evaluation job. Pattern: starts with a letter, alphanumeric and underscores, max 48 characters. |
|
|
Object |
Yes |
Where to find agent sessions. Specify a |
|
|
List |
Yes |
List of evaluators. Each entry has an |
|
|
Object |
No |
Contains |
|
|
String |
No |
Idempotency token. If you retry a request with the same client token, the service returns the existing job instead of creating a new one. |
Session source
The dataSourceConfig parameter specifies the CloudWatch Logs location where the service discovers agent sessions.
Required fields
| Field | Type | Description |
|---|---|---|
|
|
List of strings (exactly 1) |
The service name that identifies your agent’s traces in CloudWatch. Convention: |
|
|
List of strings (1–5) |
CloudWatch log group names where agent telemetry is stored. Convention: |
Optional fields
| Field | Type | Description |
|---|---|---|
|
|
List of strings |
Evaluate only these specific session IDs. When omitted, the service discovers all sessions in the log group. |
|
|
ISO 8601 datetime |
Filter sessions created after this time. |
|
|
ISO 8601 datetime |
Filter sessions created before this time. |
Response
| Field | Type | Description |
|---|---|---|
|
|
String |
Unique identifier for the batch evaluation. |
|
|
String |
ARN of the batch evaluation. |
|
|
String |
The name you specified. |
|
|
String |
Initial status. One of: |
|
|
List |
The evaluators used. |
|
|
Timestamp |
When the job was created. |
|
|
Object |
CloudWatch Logs destination for per-session results. |
Errors
| Error | HTTP status | Description |
|---|---|---|
|
|
400 |
Invalid request parameters. Check field constraints and required fields. |
|
|
403 |
Insufficient permissions. Verify IAM policies. |
|
|
409 |
A batch evaluation with the same client token already exists with different parameters. |
|
|
429 |
Request rate exceeded. Retry with exponential backoff. |
|
|
500 |
Service-side error. Retry the request. |