| 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.StopModel
Description
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.
Synopsis
- data StopModel = StopModel' {
- clientToken :: Maybe Text
- projectName :: Text
- modelVersion :: Text
- newStopModel :: Text -> Text -> StopModel
- stopModel_clientToken :: Lens' StopModel (Maybe Text)
- stopModel_projectName :: Lens' StopModel Text
- stopModel_modelVersion :: Lens' StopModel Text
- data StopModelResponse = StopModelResponse' {}
- newStopModelResponse :: Int -> StopModelResponse
- stopModelResponse_status :: Lens' StopModelResponse (Maybe ModelHostingStatus)
- stopModelResponse_httpStatus :: Lens' StopModelResponse Int
Creating a Request
See: newStopModel smart constructor.
Constructors
| StopModel' | |
Fields
| |
Instances
Create a value of StopModel 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:StopModel', stopModel_clientToken - 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 from StopModel. In this
case, safely retry your call to StopModel 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 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 to StopModel. An idempotency token is active for 8 hours.
StopModel, stopModel_projectName - The name of the project that contains the model that you want to stop.
StopModel, stopModel_modelVersion - The version of the model that you want to stop.
Request Lenses
stopModel_clientToken :: Lens' StopModel (Maybe Text) Source #
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 from StopModel. In this
case, safely retry your call to StopModel 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 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 to StopModel. An idempotency token is active for 8 hours.
stopModel_projectName :: Lens' StopModel Text Source #
The name of the project that contains the model that you want to stop.
stopModel_modelVersion :: Lens' StopModel Text Source #
The version of the model that you want to stop.
Destructuring the Response
data StopModelResponse Source #
See: newStopModelResponse smart constructor.
Constructors
| StopModelResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> StopModelResponse |
Create a value of StopModelResponse 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:
StopModelResponse, stopModelResponse_status - The status of the model.
$sel:httpStatus:StopModelResponse', stopModelResponse_httpStatus - The response's http status code.
Response Lenses
stopModelResponse_status :: Lens' StopModelResponse (Maybe ModelHostingStatus) Source #
The status of the model.
stopModelResponse_httpStatus :: Lens' StopModelResponse Int Source #
The response's http status code.