[[reference-ml-update_model_snapshot]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    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.updateModelSnapshot

Update a snapshot. Updates certain properties of a snapshot.

{ref}/ml-update-snapshot.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(MlUpdateModelSnapshotRequest, options?): Promise<MlUpdateModelSnapshotResponse>
----

[discrete]
===== `MlUpdateModelSnapshotRequest`

[source,ts]
----
interface MlUpdateModelSnapshotRequest extends <<shared-type-request-base, RequestBase>> {
  job_id: <<shared-type-id, Id>>
  snapshot_id: <<shared-type-id, Id>>
  description?: string
  retain?: boolean
}
----

[discrete]
===== `MlUpdateModelSnapshotResponse`

[source,ts]
----
interface MlUpdateModelSnapshotResponse {
  acknowledged: boolean
  model: MlModelSnapshot
}
----

