| 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.StartModelPackagingJob
Description
Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.
Use the DescribeModelPackagingJob API to determine the current status of
the job. The model packaging job is complete if the value of Status is
SUCCEEDED.
To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API.
This operation requires the following permissions:
lookoutvision:StartModelPackagingJob
s3:PutObject
s3:GetBucketLocation
kms:GenerateDataKey
greengrass:CreateComponentVersion
greengrass:DescribeComponent
- (Optional)
greengrass:TagResource. Only required if you want to tag the component.
For more information, see /Using your Amazon Lookout for Vision model on an edge device/ in the Amazon Lookout for Vision Developer Guide.
Synopsis
- data StartModelPackagingJob = StartModelPackagingJob' {}
- newStartModelPackagingJob :: Text -> Text -> ModelPackagingConfiguration -> StartModelPackagingJob
- startModelPackagingJob_clientToken :: Lens' StartModelPackagingJob (Maybe Text)
- startModelPackagingJob_description :: Lens' StartModelPackagingJob (Maybe Text)
- startModelPackagingJob_jobName :: Lens' StartModelPackagingJob (Maybe Text)
- startModelPackagingJob_projectName :: Lens' StartModelPackagingJob Text
- startModelPackagingJob_modelVersion :: Lens' StartModelPackagingJob Text
- startModelPackagingJob_configuration :: Lens' StartModelPackagingJob ModelPackagingConfiguration
- data StartModelPackagingJobResponse = StartModelPackagingJobResponse' {
- jobName :: Maybe Text
- httpStatus :: Int
- newStartModelPackagingJobResponse :: Int -> StartModelPackagingJobResponse
- startModelPackagingJobResponse_jobName :: Lens' StartModelPackagingJobResponse (Maybe Text)
- startModelPackagingJobResponse_httpStatus :: Lens' StartModelPackagingJobResponse Int
Creating a Request
data StartModelPackagingJob Source #
See: newStartModelPackagingJob smart constructor.
Constructors
| StartModelPackagingJob' | |
Fields
| |
Instances
newStartModelPackagingJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> ModelPackagingConfiguration | |
| -> StartModelPackagingJob |
Create a value of StartModelPackagingJob 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:StartModelPackagingJob', startModelPackagingJob_clientToken - ClientToken is an idempotency token that ensures a call to
StartModelPackagingJob completes only once. You choose the value to
pass. For example, An issue might prevent you from getting a response
from StartModelPackagingJob. In this case, safely retry your call to
StartModelPackagingJob 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 dataset creation 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 StartModelPackagingJob. An idempotency token is active for
8 hours.
StartModelPackagingJob, startModelPackagingJob_description - A description for the model packaging job.
StartModelPackagingJob, startModelPackagingJob_jobName - A name for the model packaging job. If you don't supply a value, the
service creates a job name for you.
StartModelPackagingJob, startModelPackagingJob_projectName - The name of the project which contains the version of the model that you
want to package.
StartModelPackagingJob, startModelPackagingJob_modelVersion - The version of the model within the project that you want to package.
$sel:configuration:StartModelPackagingJob', startModelPackagingJob_configuration - The configuration for the model packaging job.
Request Lenses
startModelPackagingJob_clientToken :: Lens' StartModelPackagingJob (Maybe Text) Source #
ClientToken is an idempotency token that ensures a call to
StartModelPackagingJob completes only once. You choose the value to
pass. For example, An issue might prevent you from getting a response
from StartModelPackagingJob. In this case, safely retry your call to
StartModelPackagingJob 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 dataset creation 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 StartModelPackagingJob. An idempotency token is active for
8 hours.
startModelPackagingJob_description :: Lens' StartModelPackagingJob (Maybe Text) Source #
A description for the model packaging job.
startModelPackagingJob_jobName :: Lens' StartModelPackagingJob (Maybe Text) Source #
A name for the model packaging job. If you don't supply a value, the service creates a job name for you.
startModelPackagingJob_projectName :: Lens' StartModelPackagingJob Text Source #
The name of the project which contains the version of the model that you want to package.
startModelPackagingJob_modelVersion :: Lens' StartModelPackagingJob Text Source #
The version of the model within the project that you want to package.
startModelPackagingJob_configuration :: Lens' StartModelPackagingJob ModelPackagingConfiguration Source #
The configuration for the model packaging job.
Destructuring the Response
data StartModelPackagingJobResponse Source #
See: newStartModelPackagingJobResponse smart constructor.
Constructors
| StartModelPackagingJobResponse' | |
Fields
| |
Instances
newStartModelPackagingJobResponse Source #
Create a value of StartModelPackagingJobResponse 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:
StartModelPackagingJob, startModelPackagingJobResponse_jobName - The job name for the model packaging job. If you don't supply a job
name in the JobName input parameter, the service creates a job name
for you.
$sel:httpStatus:StartModelPackagingJobResponse', startModelPackagingJobResponse_httpStatus - The response's http status code.
Response Lenses
startModelPackagingJobResponse_jobName :: Lens' StartModelPackagingJobResponse (Maybe Text) Source #
The job name for the model packaging job. If you don't supply a job
name in the JobName input parameter, the service creates a job name
for you.
startModelPackagingJobResponse_httpStatus :: Lens' StartModelPackagingJobResponse Int Source #
The response's http status code.