IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete data frame analytics jobs API
editDelete data frame analytics jobs API
editDeletes an existing data frame analytics job.
Request
editDELETE _ml/data_frame/analytics/<data_frame_analytics_id>
Prerequisites
editRequires the manage_ml
cluster privilege. This privilege is included in the
machine_learning_admin
built-in role.
Path parameters
edit-
<data_frame_analytics_id>
- (Required, string) Identifier for the data frame analytics job.
Query parameters
edit-
force
-
(Optional, Boolean) If
true
, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. -
timeout
- (Optional, time units) The time to wait for the job to be deleted. Defaults to 1 minute.
Examples
editThe following example deletes the loganalytics
data frame analytics job:
resp = client.ml.delete_data_frame_analytics( id="loganalytics", ) print(resp)
response = client.ml.delete_data_frame_analytics( id: 'loganalytics' ) puts response
const response = await client.ml.deleteDataFrameAnalytics({ id: "loganalytics", }); console.log(response);
DELETE _ml/data_frame/analytics/loganalytics
The API returns the following result:
{ "acknowledged" : true }