update_evaluation ¶

update_evaluation(
    evaluation_id: EntityId,
    evaluation_name: EntityName,
    *,
    config_overrides: Optional[MachineLearningClientConfig] = None,
) -> UpdateEvaluationOutput

Updates the EvaluationName of an Evaluation.

You can use the GetEvaluation operation to view the contents of the updated data element.

Parameters:

evaluation_id (EntityId) –

The ID assigned to the Evaluation during creation.
evaluation_name (EntityName) –

A new user-supplied name or description of the Evaluation that will replace the current content.

Raises:

InternalServerException –

An error on the server occurred when trying to process a request.
InvalidInputException –

An error on the client occurred. Typically, the cause is an invalid input value.
ResourceNotFoundException –

A specified resource cannot be located.
UnknownServiceError –

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

Source code in docs_src/capo_machine_learning/_services/machine_learning.py

def update_evaluation(
    self,
    evaluation_id: "capo_machine_learning.types.entity_id.EntityId",
    evaluation_name: "capo_machine_learning.types.entity_name.EntityName",
    *,
    config_overrides: Optional[MachineLearningClientConfig] = None,
) -> "capo_machine_learning.types.update_evaluation_output.UpdateEvaluationOutput":
    """<p>Updates the <code>EvaluationName</code> of an <code>Evaluation</code>.</p> <p>You can use the <code>GetEvaluation</code> operation to view the contents of the updated data element.</p>

    Args:
        evaluation_id: <p>The ID assigned to the <code>Evaluation</code> during creation.</p>
        evaluation_name: <p>A new user-supplied name or description of the <code>Evaluation</code> that will replace the current content. </p>

    Raises:
        capo_machine_learning.errors.internal_server_exception.InternalServerException: <p>An error on the server occurred when trying to process a request.</p>
        capo_machine_learning.errors.invalid_input_exception.InvalidInputException: <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
        capo_machine_learning.errors.resource_not_found_exception.ResourceNotFoundException: <p>A specified resource cannot be located.</p>
        capo_machine_learning.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_machine_learning.types.update_evaluation_input.UpdateEvaluationInput]",
    ) -> OperationResponse[
        "capo_machine_learning.types.update_evaluation_output.UpdateEvaluationOutput"
    ]:
        import capo_machine_learning._operations.amazon_ml_20141212.update_evaluation

        output, http_response = (
            capo_machine_learning._operations.amazon_ml_20141212.update_evaluation.update_evaluation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEvaluation")
    )
    input_: capo_machine_learning.types.update_evaluation_input.UpdateEvaluationInput = {
        "evaluation_id": evaluation_id,
        "evaluation_name": evaluation_name,
    }

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