[[reference-ml-stop_trained_model_deployment]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.ml.stopTrainedModelDeployment

Stop a trained model deployment.

{ref}/stop-trained-model-deployment.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(MlStopTrainedModelDeploymentRequest, options?): Promise<MlStopTrainedModelDeploymentResponse>
----

[discrete]
===== `MlStopTrainedModelDeploymentRequest`

[source,ts]
----
interface MlStopTrainedModelDeploymentRequest extends <<shared-type-request-base, RequestBase>> {
  model_id: <<shared-type-id, Id>>
  allow_no_match?: boolean
  force?: boolean
}
----

[discrete]
===== `MlStopTrainedModelDeploymentResponse`

[source,ts]
----
interface MlStopTrainedModelDeploymentResponse {
  stopped: boolean
}
----