v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1422138111.2 KB

Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel.

After the model hosting stops, the Status of the model is TRAINED.

This operation requires permissions to perform the lookoutvision:StopModel operation.

post/2020-11-20/projects/{projectName}/models/{modelVersion}/stop

Path parameters

projectNamestring required

The name of the project that contains the model that you want to stop.

modelVersionstring required

The version of the model that you want to stop.

Headers

X-Amzn-Client-Tokenstring
<p>ClientToken is an idempotency token that ensures a call to <code>StopModel</code> completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from <code>StopModel</code>. In this case, safely retry your call to <code>StopModel</code> by using the same <code>ClientToken</code> parameter value.</p> <p>If you don't supply a value for <code>ClientToken</code>, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple stop requests. You'll need to provide your own value for other use cases. </p> <p>An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>StopModel</code>. An idempotency token is active for 8 hours. </p>

Response

Success

Status'STARTING_HOSTING' | 'HOSTED' | 'HOSTING_FAILED' | 'STOPPING_HOSTING' | 'SYSTEM_UPDATING'

The status of the model.