BedrockAgentCore / Client / stop_batch_evaluation

stop_batch_evaluation

BedrockAgentCore.Client.stop_batch_evaluation(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.stop_batch_evaluation(
    batchEvaluationId='string'
)

Parameters:

batchEvaluationId (string) –

[REQUIRED]

The unique identifier of the batch evaluation to stop.

Return type:

dict

Returns:

Response Syntax

{
    'batchEvaluationId': 'string',
    'batchEvaluationArn': 'string',
    'status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED'|'STOPPING'|'STOPPED'|'DELETING',
    'description': 'string'
}

Response Structure

• (dict) –

  • batchEvaluationId (string) –

    The unique identifier of the stopped batch evaluation.

  • batchEvaluationArn (string) –

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

  • status (string) –

    The status of the batch evaluation after the stop request.

  • description (string) –

    The description of the batch evaluation.

Exceptions

• BedrockAgentCore.Client.exceptions.UnauthorizedException

• BedrockAgentCore.Client.exceptions.ValidationException

• BedrockAgentCore.Client.exceptions.AccessDeniedException

• BedrockAgentCore.Client.exceptions.ConflictException

• BedrockAgentCore.Client.exceptions.ThrottlingException

• BedrockAgentCore.Client.exceptions.ResourceNotFoundException

• BedrockAgentCore.Client.exceptions.InternalServerException