MachineLearning / Client / delete_evaluation

delete_evaluation#

MachineLearning.Client.delete_evaluation(**kwargs)#

Assigns the DELETED status to an Evaluation, rendering it unusable.

After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.

Caution: The results of the DeleteEvaluation operation are irreversible.

See also: AWS API Documentation

Request Syntax

response = client.delete_evaluation(
    EvaluationId='string'
)
Parameters:

EvaluationId (string) –

[REQUIRED]

A user-supplied ID that uniquely identifies the Evaluation to delete.

Return type:

dict

Returns:

Response Syntax

{
    'EvaluationId': 'string'
}

Response Structure

  • (dict) –

    Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.

    You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.

    • EvaluationId (string) –

      A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

Exceptions

  • MachineLearning.Client.exceptions.InvalidInputException

  • MachineLearning.Client.exceptions.ResourceNotFoundException

  • MachineLearning.Client.exceptions.InternalServerException