2021/02/17 - Amazon Lookout for Vision - 2 updated api methods
Changes This release for Amazon Lookout for Vision includes documentation updates and a correction to the Status field returned in the response from StartModel and StopModel.
{'Status': {'HOSTED',
'HOSTING_FAILED',
'STARTING_HOSTING',
'STOPPING_HOSTING',
'SYSTEM_UPDATING'}}
Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use DescribeModel.
A model is ready to use when its status is HOSTED .
Once the model is running, you can detect custom labels in new images by calling DetectAnomalies.
Note
You are charged for the amount of time that the model is running. To stop a running model, call StopModel.
This operation requires permissions to perform the lookoutvision:StartModel operation.
See also: AWS API Documentation
Request Syntax
client.start_model(
ProjectName='string',
ModelVersion='string',
MinInferenceUnits=123,
ClientToken='string'
)
string
[REQUIRED]
The name of the project that contains the model that you want to start.
string
[REQUIRED]
The version of the model that you want to start.
integer
[REQUIRED]
The minimum number of inference units to use. A single inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.
string
ClientToken is an idempotency token that ensures a call to StartModel completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from StartModel . In this case, safely retry your call to StartModel by using the same ClientToken parameter value. 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 to StartModel . An idempotency token is active for 8 hours.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Status': 'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'
}
Response Structure
(dict) --
Status (string) --
The current running status of the model.
{'Status': {'HOSTED',
'HOSTING_FAILED',
'STARTING_HOSTING',
'STOPPING_HOSTING',
'SYSTEM_UPDATING'}}
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.
See also: AWS API Documentation
Request Syntax
client.stop_model(
ProjectName='string',
ModelVersion='string',
ClientToken='string'
)
string
[REQUIRED]
The name of the project that contains the model that you want to stop.
string
[REQUIRED]
The version of the model that you want to stop.
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, such as an network outage, might prevent you from getting a response from StopModel . In this case, safely retry your call to StopModel by using the same ClientToken parameter value. 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 to StopModel . An idempotency token is active for 8 hours.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Status': 'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'
}
Response Structure
(dict) --
Status (string) --
The status of the model.