LookoutforVision / Client / stop_model
stop_model#
- LookoutforVision.Client.stop_model(**kwargs)#
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 isTRAINED
.This operation requires permissions to perform the
lookoutvision:StopModel
operation.See also: AWS API Documentation
Request Syntax
response = client.stop_model( ProjectName='string', ModelVersion='string', ClientToken='string' )
- Parameters:
ProjectName (string) –
[REQUIRED]
The name of the project that contains the model that you want to stop.
ModelVersion (string) –
[REQUIRED]
The version of the model that you want to stop.
ClientToken (string) –
ClientToken is an idempotency token that ensures a call to
StopModel
completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response fromStopModel
. In this case, safely retry your call toStopModel
by using the sameClientToken
parameter value.If you don’t supply a value for
ClientToken
, 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.An error occurs if the other input parameters are not the same as in the first request. Using a different value for
ClientToken
is considered a new call toStopModel
. An idempotency token is active for 8 hours.This field is autopopulated if not provided.
- Return type:
dict
- Returns:
Response Syntax
{ 'Status': 'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING' }
Response Structure
(dict) –
Status (string) –
The status of the model.
Exceptions
LookoutforVision.Client.exceptions.AccessDeniedException
LookoutforVision.Client.exceptions.InternalServerException
LookoutforVision.Client.exceptions.ValidationException
LookoutforVision.Client.exceptions.ConflictException
LookoutforVision.Client.exceptions.ResourceNotFoundException
LookoutforVision.Client.exceptions.ThrottlingException