View a markdown version of this page

Stop batch evaluation - Amazon Bedrock AgentCore
Code samplesRequest parametersResponseErrors

Stop batch evaluation

Stop a running batch evaluation job. The job transitions to STOPPING and then STOPPED. Partial results from sessions that were already evaluated may be available in the response.

Stopping a batch evaluation is useful when you realize the job was started with incorrect parameters, or when you no longer need the results.

Code samples

Example
AgentCore CLI
agentcore stop batch-evaluation --id <batch-evaluation-id>
AWS SDK (boto3)
import boto3

client = boto3.client("bedrock-agentcore", region_name="us-west-2")

response = client.stop_batch_evaluation(batchEvaluationId=batch_eval_id)
print(f"Status: {response['status']}")  # STOPPING or STOPPED

Request parameters

Parameter Type Required Description

batchEvaluationId

String

Yes

The batch evaluation ID to stop. Passed as a path parameter.

Response

Field Type Description

batchEvaluationId

String

The batch evaluation ID.

batchEvaluationArn

String

ARN of the batch evaluation.

status

String

Updated status: STOPPING or STOPPED.

Errors

Error HTTP status Description

ResourceNotFoundException

404

No batch evaluation found with the specified ID.

ConflictException

409

The batch evaluation is not in a state that can be stopped (for example, already completed or stopped).

ValidationException

400

Invalid batch evaluation ID format.

AccessDeniedException

403

Insufficient permissions.

ThrottlingException

429

Request rate exceeded.

InternalServerException

500

Service-side error.