| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.LookoutVision.StartModel
Description
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.
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.
Synopsis
- data StartModel = StartModel' {}
- newStartModel :: Text -> Text -> Natural -> StartModel
- startModel_clientToken :: Lens' StartModel (Maybe Text)
- startModel_maxInferenceUnits :: Lens' StartModel (Maybe Natural)
- startModel_projectName :: Lens' StartModel Text
- startModel_modelVersion :: Lens' StartModel Text
- startModel_minInferenceUnits :: Lens' StartModel Natural
- data StartModelResponse = StartModelResponse' {}
- newStartModelResponse :: Int -> StartModelResponse
- startModelResponse_status :: Lens' StartModelResponse (Maybe ModelHostingStatus)
- startModelResponse_httpStatus :: Lens' StartModelResponse Int
Creating a Request
data StartModel Source #
See: newStartModel smart constructor.
Constructors
| StartModel' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Natural | |
| -> StartModel |
Create a value of StartModel with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:StartModel', startModel_clientToken - ClientToken is an idempotency token that ensures a call to StartModel
completes only once. You choose the value to pass. For example, An issue
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.
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 start 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 to StartModel. An idempotency token is active for 8 hours.
StartModel, startModel_maxInferenceUnits - The maximum number of inference units to use for auto-scaling the model.
If you don't specify a value, Amazon Lookout for Vision doesn't
auto-scale the model.
StartModel, startModel_projectName - The name of the project that contains the model that you want to start.
StartModel, startModel_modelVersion - The version of the model that you want to start.
StartModel, startModel_minInferenceUnits - The minimum number of inference units to use. A single inference unit
represents 1 hour of processing. Use a higher number to increase the TPS
throughput of your model. You are charged for the number of inference
units that you use.
Request Lenses
startModel_clientToken :: Lens' StartModel (Maybe Text) Source #
ClientToken is an idempotency token that ensures a call to StartModel
completes only once. You choose the value to pass. For example, An issue
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.
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 start 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 to StartModel. An idempotency token is active for 8 hours.
startModel_maxInferenceUnits :: Lens' StartModel (Maybe Natural) Source #
The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the model.
startModel_projectName :: Lens' StartModel Text Source #
The name of the project that contains the model that you want to start.
startModel_modelVersion :: Lens' StartModel Text Source #
The version of the model that you want to start.
startModel_minInferenceUnits :: Lens' StartModel Natural Source #
The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.
Destructuring the Response
data StartModelResponse Source #
See: newStartModelResponse smart constructor.
Constructors
| StartModelResponse' | |
Fields
| |
Instances
newStartModelResponse Source #
Arguments
| :: Int | |
| -> StartModelResponse |
Create a value of StartModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartModelResponse, startModelResponse_status - The current running status of the model.
$sel:httpStatus:StartModelResponse', startModelResponse_httpStatus - The response's http status code.
Response Lenses
startModelResponse_status :: Lens' StartModelResponse (Maybe ModelHostingStatus) Source #
The current running status of the model.
startModelResponse_httpStatus :: Lens' StartModelResponse Int Source #
The response's http status code.