| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Rekognition.StartProjectVersion
Description
Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.
Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.
You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.
This operation requires permissions to perform the
rekognition:StartProjectVersion action.
Synopsis
- data StartProjectVersion = StartProjectVersion' {}
- newStartProjectVersion :: Text -> Natural -> StartProjectVersion
- startProjectVersion_projectVersionArn :: Lens' StartProjectVersion Text
- startProjectVersion_minInferenceUnits :: Lens' StartProjectVersion Natural
- data StartProjectVersionResponse = StartProjectVersionResponse' {}
- newStartProjectVersionResponse :: Int -> StartProjectVersionResponse
- startProjectVersionResponse_status :: Lens' StartProjectVersionResponse (Maybe ProjectVersionStatus)
- startProjectVersionResponse_httpStatus :: Lens' StartProjectVersionResponse Int
Creating a Request
data StartProjectVersion Source #
See: newStartProjectVersion smart constructor.
Constructors
| StartProjectVersion' | |
Fields
| |
Instances
newStartProjectVersion Source #
Arguments
| :: Text | |
| -> Natural | |
| -> StartProjectVersion |
Create a value of StartProjectVersion 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:projectVersionArn:StartProjectVersion', startProjectVersion_projectVersionArn - The Amazon Resource Name(ARN) of the model version that you want to
start.
$sel:minInferenceUnits:StartProjectVersion', startProjectVersion_minInferenceUnits - 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.
Request Lenses
startProjectVersion_projectVersionArn :: Lens' StartProjectVersion Text Source #
The Amazon Resource Name(ARN) of the model version that you want to start.
startProjectVersion_minInferenceUnits :: Lens' StartProjectVersion Natural Source #
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.
Destructuring the Response
data StartProjectVersionResponse Source #
See: newStartProjectVersionResponse smart constructor.
Constructors
| StartProjectVersionResponse' | |
Fields
| |
Instances
newStartProjectVersionResponse Source #
Create a value of StartProjectVersionResponse 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:status:StartProjectVersionResponse', startProjectVersionResponse_status - The current running status of the model.
$sel:httpStatus:StartProjectVersionResponse', startProjectVersionResponse_httpStatus - The response's http status code.
Response Lenses
startProjectVersionResponse_status :: Lens' StartProjectVersionResponse (Maybe ProjectVersionStatus) Source #
The current running status of the model.
startProjectVersionResponse_httpStatus :: Lens' StartProjectVersionResponse Int Source #
The response's http status code.