MachineLearning / Client / delete_batch_prediction

delete_batch_prediction#

MachineLearning.Client.delete_batch_prediction(**kwargs)#

Assigns the DELETED status to a BatchPrediction , rendering it unusable.

After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED.

Caution: The result of the DeleteBatchPrediction operation is irreversible.

See also: AWS API Documentation

Request Syntax

response = client.delete_batch_prediction(
    BatchPredictionId='string'
)
Parameters:

BatchPredictionId (string) –

[REQUIRED]

A user-supplied ID that uniquely identifies the BatchPrediction .

Return type:

dict

Returns:

Response Syntax

{
    'BatchPredictionId': 'string'
}

Response Structure

  • (dict) –

    Represents the output of a DeleteBatchPrediction operation.

    You can use the GetBatchPrediction operation and check the value of the Status parameter to see whether a BatchPrediction is marked as DELETED .

    • BatchPredictionId (string) –

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

Exceptions

  • MachineLearning.Client.exceptions.InvalidInputException

  • MachineLearning.Client.exceptions.ResourceNotFoundException

  • MachineLearning.Client.exceptions.InternalServerException