stop_batch_evaluation ¶

stop_batch_evaluation(
    batch_evaluation_id: BatchEvaluationId,
    *,
    config_overrides: Optional[BedrockAgentCoreClientConfig] = None,
) -> StopBatchEvaluationResponse

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

Parameters:

batch_evaluation_id (BatchEvaluationId) –

The unique identifier of the batch evaluation to stop.

Raises:

AccessDeniedException –

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.
ConflictException –

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.
InternalServerException –

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.
ResourceNotFoundException –

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.
ThrottlingException –

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.
UnauthorizedException –

This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access
ValidationException –

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agentcore/_services/bedrock_agent_core.py

def stop_batch_evaluation(
    self,
    batch_evaluation_id: "capo_bedrock_agentcore.types.batch_evaluation_id.BatchEvaluationId",
    *,
    config_overrides: Optional[BedrockAgentCoreClientConfig] = None,
) -> "capo_bedrock_agentcore.types.stop_batch_evaluation_response.StopBatchEvaluationResponse":
    """<p>Stops a running batch evaluation. Sessions that have already been evaluated retain their results.</p>

    Args:
        batch_evaluation_id: <p>The unique identifier of the batch evaluation to stop.</p>

    Raises:
        capo_bedrock_agentcore.errors.access_denied_exception.AccessDeniedException: <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
        capo_bedrock_agentcore.errors.conflict_exception.ConflictException: <p>The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.</p>
        capo_bedrock_agentcore.errors.internal_server_exception.InternalServerException: <p>The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.</p>
        capo_bedrock_agentcore.errors.resource_not_found_exception.ResourceNotFoundException: <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
        capo_bedrock_agentcore.errors.throttling_exception.ThrottlingException: <p>The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.</p>
        capo_bedrock_agentcore.errors.unauthorized_exception.UnauthorizedException: <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
        capo_bedrock_agentcore.errors.validation_exception.ValidationException: <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
        capo_bedrock_agentcore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore.types.stop_batch_evaluation_request.StopBatchEvaluationRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore.types.stop_batch_evaluation_response.StopBatchEvaluationResponse"
    ]:
        import capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.stop_batch_evaluation

        output, http_response = (
            capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.stop_batch_evaluation.stop_batch_evaluation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopBatchEvaluation")
    )
    input_: capo_bedrock_agentcore.types.stop_batch_evaluation_request.StopBatchEvaluationRequest = {
        "batch_evaluation_id": batch_evaluation_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output