delete_batch_prediction `async` ¶

delete_batch_prediction(
    batch_prediction_id: EntityId,
    *,
    config_overrides: Optional[AsyncMachineLearningClientConfig] = None,
) -> DeleteBatchPredictionOutput

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.

Parameters:

batch_prediction_id (EntityId) –

A user-supplied ID that uniquely identifies the BatchPrediction.

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/async_machine_learning.py

async def delete_batch_prediction(
    self,
    batch_prediction_id: "capo_machine_learning.types.entity_id.EntityId",
    *,
    config_overrides: Optional[AsyncMachineLearningClientConfig] = None,
) -> "capo_machine_learning.types.delete_batch_prediction_output.DeleteBatchPredictionOutput":
    """<p>Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable.</p> <p>After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED.</p> <p> <b>Caution:</b> The result of the <code>DeleteBatchPrediction</code> operation is irreversible.</p>

    Args:
        batch_prediction_id: <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_machine_learning.types.delete_batch_prediction_input.DeleteBatchPredictionInput]",
    ) -> AsyncOperationResponse[
        "capo_machine_learning.types.delete_batch_prediction_output.DeleteBatchPredictionOutput"
    ]:
        import capo_machine_learning._operations.amazon_ml_20141212.delete_batch_prediction

        (
            output,
            http_response,
        ) = await capo_machine_learning._operations.amazon_ml_20141212.delete_batch_prediction.async_delete_batch_prediction(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteBatchPrediction")
    )
    input_: capo_machine_learning.types.delete_batch_prediction_input.DeleteBatchPredictionInput = {
        "batch_prediction_id": batch_prediction_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_batch_prediction async ¶

delete_batch_prediction `async` ¶