:doc:`MachineLearning <../../machinelearning>` / Client / delete_batch_prediction

***********************
delete_batch_prediction
***********************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/machinelearning-2014-12-12/DeleteBatchPrediction>`_  


  **Request Syntax**
  ::

    response = client.delete_batch_prediction(
        BatchPredictionId='string'
    )
    
  :type BatchPredictionId: string
  :param BatchPredictionId: **[REQUIRED]** 

    A user-supplied ID that uniquely identifies the ``BatchPrediction``.

    

  
  
  :rtype: 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**
  
  *   :py:class:`MachineLearning.Client.exceptions.InvalidInputException`

  
  *   :py:class:`MachineLearning.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`MachineLearning.Client.exceptions.InternalServerException`

  