Bedrock Agentcore  >  Operations  >  stop_batch_evaluation

stop_batch_evaluation

Operation

stop_batch_evaluation async

stop_batch_evaluation(input: StopBatchEvaluationInput, plugins: list[Plugin] | None = None) -> StopBatchEvaluationOutput

Stops a running batch evaluation. Sessions that have already been evaluated retain their results.

Parameters:

Name	Type	Description	Default
input	StopBatchEvaluationInput	An instance of StopBatchEvaluationInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
StopBatchEvaluationOutput	An instance of StopBatchEvaluationOutput.

Input

StopBatchEvaluationInput dataclass

Dataclass for StopBatchEvaluationInput structure.

Attributes

batch_evaluation_id class-attribute instance-attribute

batch_evaluation_id: str | None = None

The unique identifier of the batch evaluation to stop.

Output

StopBatchEvaluationOutput dataclass

Dataclass for StopBatchEvaluationOutput structure.

Attributes

batch_evaluation_arn instance-attribute

batch_evaluation_arn: str

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

batch_evaluation_id instance-attribute

batch_evaluation_id: str

The unique identifier of the stopped batch evaluation.

description class-attribute instance-attribute

description: str | None = None

The description of the batch evaluation.

status instance-attribute

status: BatchEvaluationStatus

The status of the batch evaluation after the stop request.