amazonka-lookoutvision-2.0: Amazon Lookout for Vision SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LookoutVision.Lens

Description

 
Synopsis

Operations

CreateDataset

createDataset_clientToken :: Lens' CreateDataset (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to CreateDataset completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateDataset. In this case, safely retry your call to CreateDataset 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 CreateDataset. An idempotency token is active for 8 hours.

createDataset_datasetSource :: Lens' CreateDataset (Maybe DatasetSource) Source #

The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.

If you don't specify DatasetSource, an empty dataset is created and the operation synchronously returns. Later, you can add JSON Lines by calling UpdateDatasetEntries.

If you specify a value for DataSource, the manifest at the S3 location is validated and used to create the dataset. The call to CreateDataset is asynchronous and might take a while to complete. To find out the current status, Check the value of Status returned in a call to DescribeDataset.

createDataset_projectName :: Lens' CreateDataset Text Source #

The name of the project in which you want to create a dataset.

createDataset_datasetType :: Lens' CreateDataset Text Source #

The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.

CreateModel

createModel_clientToken :: Lens' CreateModel (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateModel. In this case, safely retry your call to CreateModel 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 starting multiple training jobs. 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 CreateModel. An idempotency token is active for 8 hours.

createModel_description :: Lens' CreateModel (Maybe Text) Source #

A description for the version of the model.

createModel_kmsKeyId :: Lens' CreateModel (Maybe Text) Source #

The identifier for your AWS KMS key. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

createModel_tags :: Lens' CreateModel (Maybe [Tag]) Source #

A set of tags (key-value pairs) that you want to attach to the model.

createModel_projectName :: Lens' CreateModel Text Source #

The name of the project in which you want to create a model version.

createModel_outputConfig :: Lens' CreateModel OutputConfig Source #

The location where Amazon Lookout for Vision saves the training results.

CreateProject

createProject_clientToken :: Lens' CreateProject (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to CreateProject completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateProject. In this case, safely retry your call to CreateProject 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 project 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 CreateProject. An idempotency token is active for 8 hours.

DeleteDataset

deleteDataset_clientToken :: Lens' DeleteDataset (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to DeleteDataset completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteDataset. In this case, safely retry your call to DeleteDataset 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 deletetion 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 DeleteDataset. An idempotency token is active for 8 hours.

deleteDataset_projectName :: Lens' DeleteDataset Text Source #

The name of the project that contains the dataset that you want to delete.

deleteDataset_datasetType :: Lens' DeleteDataset Text Source #

The type of the dataset to delete. Specify train to delete the training dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset project, specify train.

DeleteModel

deleteModel_clientToken :: Lens' DeleteModel (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to DeleteModel completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from DeleteModel. In this case, safely retry your call to DeleteModel 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 model deletion 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 DeleteModel. An idempotency token is active for 8 hours.

deleteModel_projectName :: Lens' DeleteModel Text Source #

The name of the project that contains the model that you want to delete.

deleteModel_modelVersion :: Lens' DeleteModel Text Source #

The version of the model that you want to delete.

deleteModelResponse_modelArn :: Lens' DeleteModelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model that was deleted.

DeleteProject

deleteProject_clientToken :: Lens' DeleteProject (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to DeleteProject completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteProject. In this case, safely retry your call to DeleteProject 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 project deletion 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 DeleteProject. An idempotency token is active for 8 hours.

deleteProject_projectName :: Lens' DeleteProject Text Source #

The name of the project to delete.

deleteProjectResponse_projectArn :: Lens' DeleteProjectResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project that was deleted.

DescribeDataset

describeDataset_projectName :: Lens' DescribeDataset Text Source #

The name of the project that contains the dataset that you want to describe.

describeDataset_datasetType :: Lens' DescribeDataset Text Source #

The type of the dataset to describe. Specify train to describe the training dataset. Specify test to describe the test dataset. If you have a single dataset project, specify train

DescribeModel

describeModel_projectName :: Lens' DescribeModel Text Source #

The project that contains the version of a model that you want to describe.

describeModel_modelVersion :: Lens' DescribeModel Text Source #

The version of the model that you want to describe.

DescribeModelPackagingJob

describeModelPackagingJob_projectName :: Lens' DescribeModelPackagingJob Text Source #

The name of the project that contains the model packaging job that you want to describe.

DescribeProject

describeProject_projectName :: Lens' DescribeProject Text Source #

The name of the project that you want to describe.

DetectAnomalies

detectAnomalies_projectName :: Lens' DetectAnomalies Text Source #

The name of the project that contains the model version that you want to use.

detectAnomalies_modelVersion :: Lens' DetectAnomalies Text Source #

The version of the model that you want to use.

detectAnomalies_contentType :: Lens' DetectAnomalies Text Source #

The type of the image passed in Body. Valid values are image/png (PNG format images) and image/jpeg (JPG format images).

detectAnomalies_body :: Lens' DetectAnomalies HashedBody Source #

The unencrypted image bytes that you want to analyze.

ListDatasetEntries

listDatasetEntries_afterCreationDate :: Lens' ListDatasetEntries (Maybe UTCTime) Source #

Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

listDatasetEntries_anomalyClass :: Lens' ListDatasetEntries (Maybe Text) Source #

Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.

listDatasetEntries_beforeCreationDate :: Lens' ListDatasetEntries (Maybe UTCTime) Source #

Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

listDatasetEntries_labeled :: Lens' ListDatasetEntries (Maybe Bool) Source #

Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries.

listDatasetEntries_maxResults :: Lens' ListDatasetEntries (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

listDatasetEntries_nextToken :: Lens' ListDatasetEntries (Maybe Text) Source #

If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.

listDatasetEntries_sourceRefContains :: Lens' ListDatasetEntries (Maybe Text) Source #

Perform a "contains" search on the values of the source-ref key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the source-ref key value matches *IMG_17*.

listDatasetEntries_projectName :: Lens' ListDatasetEntries Text Source #

The name of the project that contains the dataset that you want to list.

listDatasetEntries_datasetType :: Lens' ListDatasetEntries Text Source #

The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train.

listDatasetEntriesResponse_datasetEntries :: Lens' ListDatasetEntriesResponse (Maybe [Text]) Source #

A list of the entries (JSON Lines) within the dataset.

listDatasetEntriesResponse_nextToken :: Lens' ListDatasetEntriesResponse (Maybe Text) Source #

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.

ListModelPackagingJobs

listModelPackagingJobs_maxResults :: Lens' ListModelPackagingJobs (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

listModelPackagingJobs_nextToken :: Lens' ListModelPackagingJobs (Maybe Text) Source #

If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

listModelPackagingJobs_projectName :: Lens' ListModelPackagingJobs Text Source #

The name of the project for which you want to list the model packaging jobs.

listModelPackagingJobsResponse_modelPackagingJobs :: Lens' ListModelPackagingJobsResponse (Maybe [ModelPackagingJobMetadata]) Source #

A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.

listModelPackagingJobsResponse_nextToken :: Lens' ListModelPackagingJobsResponse (Maybe Text) Source #

If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

ListModels

listModels_maxResults :: Lens' ListModels (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

listModels_nextToken :: Lens' ListModels (Maybe Text) Source #

If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of models.

listModels_projectName :: Lens' ListModels Text Source #

The name of the project that contains the model versions that you want to list.

listModelsResponse_models :: Lens' ListModelsResponse (Maybe [ModelMetadata]) Source #

A list of model versions in the specified project.

listModelsResponse_nextToken :: Lens' ListModelsResponse (Maybe Text) Source #

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of models.

ListProjects

listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #

If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the model for which you want to list tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

A map of tag keys and values attached to the specified model.

StartModel

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.

StartModelPackagingJob

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.

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.

StopModel

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.

stopModelResponse_httpStatus :: Lens' StopModelResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the model to assign the tags.

tagResource_tags :: Lens' TagResource [Tag] Source #

The key-value tags to assign to the model.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the model from which you want to remove tags.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of the keys of the tags that you want to remove.

UpdateDatasetEntries

updateDatasetEntries_clientToken :: Lens' UpdateDatasetEntries (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries 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 updates with the same dataset entries. 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 UpdateDatasetEntries. An idempotency token is active for 8 hours.

updateDatasetEntries_projectName :: Lens' UpdateDatasetEntries Text Source #

The name of the project that contains the dataset that you want to update.

updateDatasetEntries_datasetType :: Lens' UpdateDatasetEntries Text Source #

The type of the dataset that you want to update. Specify train to update the training dataset. Specify test to update the test dataset. If you have a single dataset project, specify train.

updateDatasetEntries_changes :: Lens' UpdateDatasetEntries ByteString Source #

The entries to add to the dataset.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Types

Anomaly

anomaly_name :: Lens' Anomaly (Maybe Text) Source #

The name of an anomaly type found in an image. Name maps to an anomaly type in the training dataset, apart from the anomaly type background. The service automatically inserts the background anomaly type into the response from DetectAnomalies.

anomaly_pixelAnomaly :: Lens' Anomaly (Maybe PixelAnomaly) Source #

Information about the pixel mask that covers an anomaly type.

DatasetDescription

datasetDescription_creationTimestamp :: Lens' DatasetDescription (Maybe UTCTime) Source #

The Unix timestamp for the time and date that the dataset was created.

datasetDescription_datasetType :: Lens' DatasetDescription (Maybe Text) Source #

The type of the dataset. The value train represents a training dataset or single dataset project. The value test represents a test dataset.

datasetDescription_lastUpdatedTimestamp :: Lens' DatasetDescription (Maybe UTCTime) Source #

The Unix timestamp for the date and time that the dataset was last updated.

datasetDescription_projectName :: Lens' DatasetDescription (Maybe Text) Source #

The name of the project that contains the dataset.

DatasetGroundTruthManifest

DatasetImageStats

datasetImageStats_anomaly :: Lens' DatasetImageStats (Maybe Int) Source #

the total number of images labeled as an anomaly.

datasetImageStats_labeled :: Lens' DatasetImageStats (Maybe Int) Source #

The total number of labeled images.

datasetImageStats_normal :: Lens' DatasetImageStats (Maybe Int) Source #

The total number of images labeled as normal.

datasetImageStats_total :: Lens' DatasetImageStats (Maybe Int) Source #

The total number of images in the dataset.

DatasetMetadata

datasetMetadata_creationTimestamp :: Lens' DatasetMetadata (Maybe UTCTime) Source #

The Unix timestamp for the date and time that the dataset was created.

datasetMetadata_statusMessage :: Lens' DatasetMetadata (Maybe Text) Source #

The status message for the dataset.

DatasetSource

DetectAnomalyResult

detectAnomalyResult_anomalies :: Lens' DetectAnomalyResult (Maybe [Anomaly]) Source #

If the model is an image segmentation model, Anomalies contains a list of anomaly types found in the image. There is one entry for each type of anomaly found (even if multiple instances of an anomaly type exist on the image). The first element in the list is always an anomaly type representing the image background ('background') and shouldn't be considered an anomaly. Amazon Lookout for Vision automatically add the background anomaly type to the response, and you don't need to declare a background anomaly type in your dataset.

If the list has one entry ('background'), no anomalies were found on the image.

An image classification model doesn't return an Anomalies list.

detectAnomalyResult_anomalyMask :: Lens' DetectAnomalyResult (Maybe ByteString) Source #

If the model is an image segmentation model, AnomalyMask contains pixel masks that covers all anomaly types found on the image. Each anomaly type has a different mask color. To map a color to an anomaly type, see the color field of the PixelAnomaly object.

An image classification model doesn't return an Anomalies list.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

detectAnomalyResult_confidence :: Lens' DetectAnomalyResult (Maybe Double) Source #

The confidence that Lookout for Vision has in the accuracy of the classification in IsAnomalous.

detectAnomalyResult_isAnomalous :: Lens' DetectAnomalyResult (Maybe Bool) Source #

True if Amazon Lookout for Vision classifies the image as containing an anomaly, otherwise false.

detectAnomalyResult_source :: Lens' DetectAnomalyResult (Maybe ImageSource) Source #

The source of the image that was analyzed. direct means that the images was supplied from the local computer. No other values are supported.

GreengrassConfiguration

greengrassConfiguration_compilerOptions :: Lens' GreengrassConfiguration (Maybe Text) Source #

Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If you specify TargetDevice, don't specify CompilerOptions.

For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.

greengrassConfiguration_componentDescription :: Lens' GreengrassConfiguration (Maybe Text) Source #

A description for the AWS IoT Greengrass component.

greengrassConfiguration_componentVersion :: Lens' GreengrassConfiguration (Maybe Text) Source #

A Version for the AWS IoT Greengrass component. If you don't provide a value, a default value of Model Version.0.0 is used.

greengrassConfiguration_tags :: Lens' GreengrassConfiguration (Maybe [Tag]) Source #

A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.

greengrassConfiguration_targetDevice :: Lens' GreengrassConfiguration (Maybe TargetDevice) Source #

The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can't specify TargetPlatform.

greengrassConfiguration_targetPlatform :: Lens' GreengrassConfiguration (Maybe TargetPlatform) Source #

The target platform for the model. If you specify TargetPlatform, you can't specify TargetDevice.

greengrassConfiguration_s3OutputLocation :: Lens' GreengrassConfiguration S3Location Source #

An S3 location in which Lookout for Vision stores the component artifacts.

greengrassConfiguration_componentName :: Lens' GreengrassConfiguration Text Source #

A name for the AWS IoT Greengrass component.

GreengrassOutputDetails

greengrassOutputDetails_componentVersionArn :: Lens' GreengrassOutputDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component.

ImageSource

imageSource_type :: Lens' ImageSource (Maybe Text) Source #

The type of the image.

InputS3Object

inputS3Object_versionId :: Lens' InputS3Object (Maybe Text) Source #

The version ID of the bucket.

inputS3Object_bucket :: Lens' InputS3Object Text Source #

The Amazon S3 bucket that contains the manifest.

inputS3Object_key :: Lens' InputS3Object Text Source #

The name and location of the manifest file withiin the bucket.

ModelDescription

modelDescription_creationTimestamp :: Lens' ModelDescription (Maybe UTCTime) Source #

The unix timestamp for the date and time that the model was created.

modelDescription_evaluationEndTimestamp :: Lens' ModelDescription (Maybe UTCTime) Source #

The unix timestamp for the date and time that the evaluation ended.

modelDescription_evaluationManifest :: Lens' ModelDescription (Maybe OutputS3Object) Source #

The S3 location where Amazon Lookout for Vision saves the manifest file that was used to test the trained model and generate the performance scores.

modelDescription_evaluationResult :: Lens' ModelDescription (Maybe OutputS3Object) Source #

The S3 location where Amazon Lookout for Vision saves the performance metrics.

modelDescription_kmsKeyId :: Lens' ModelDescription (Maybe Text) Source #

The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.

modelDescription_maxInferenceUnits :: Lens' ModelDescription (Maybe Natural) Source #

The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model. For more information, see StartModel.

modelDescription_minInferenceUnits :: Lens' ModelDescription (Maybe Natural) Source #

The minimum number of inference units used by the model. For more information, see StartModel

modelDescription_modelArn :: Lens' ModelDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model.

modelDescription_outputConfig :: Lens' ModelDescription (Maybe OutputConfig) Source #

The S3 location where Amazon Lookout for Vision saves model training files.

modelDescription_performance :: Lens' ModelDescription (Maybe ModelPerformance) Source #

Performance metrics for the model. Created during training.

ModelMetadata

modelMetadata_creationTimestamp :: Lens' ModelMetadata (Maybe UTCTime) Source #

The unix timestamp for the date and time that the model was created.

modelMetadata_description :: Lens' ModelMetadata (Maybe Text) Source #

The description for the model.

modelMetadata_modelArn :: Lens' ModelMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model.

modelMetadata_performance :: Lens' ModelMetadata (Maybe ModelPerformance) Source #

Performance metrics for the model. Not available until training has successfully completed.

modelMetadata_statusMessage :: Lens' ModelMetadata (Maybe Text) Source #

The status message for the model.

ModelPackagingConfiguration

modelPackagingConfiguration_greengrass :: Lens' ModelPackagingConfiguration GreengrassConfiguration Source #

Configuration information for the AWS IoT Greengrass component in a model packaging job.

ModelPackagingDescription

modelPackagingDescription_creationTimestamp :: Lens' ModelPackagingDescription (Maybe UTCTime) Source #

The Unix timestamp for the time and date that the model packaging job was created.

modelPackagingDescription_lastUpdatedTimestamp :: Lens' ModelPackagingDescription (Maybe UTCTime) Source #

The Unix timestamp for the time and date that the model packaging job was last updated.

modelPackagingDescription_modelPackagingMethod :: Lens' ModelPackagingDescription (Maybe Text) Source #

The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.

modelPackagingDescription_modelPackagingOutputDetails :: Lens' ModelPackagingDescription (Maybe ModelPackagingOutputDetails) Source #

Information about the output of the model packaging job. For more information, see DescribeModelPackagingJob.

modelPackagingDescription_modelVersion :: Lens' ModelPackagingDescription (Maybe Text) Source #

The version of the model used in the model packaging job.

modelPackagingDescription_projectName :: Lens' ModelPackagingDescription (Maybe Text) Source #

The name of the project that's associated with a model that's in the model package.

modelPackagingDescription_statusMessage :: Lens' ModelPackagingDescription (Maybe Text) Source #

The status message for the model packaging job.

ModelPackagingJobMetadata

modelPackagingJobMetadata_creationTimestamp :: Lens' ModelPackagingJobMetadata (Maybe UTCTime) Source #

The Unix timestamp for the time and date that the model packaging job was created.

modelPackagingJobMetadata_lastUpdatedTimestamp :: Lens' ModelPackagingJobMetadata (Maybe UTCTime) Source #

The Unix timestamp for the time and date that the model packaging job was last updated.

modelPackagingJobMetadata_modelPackagingMethod :: Lens' ModelPackagingJobMetadata (Maybe Text) Source #

The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.

modelPackagingJobMetadata_modelVersion :: Lens' ModelPackagingJobMetadata (Maybe Text) Source #

The version of the model that is in the model package.

modelPackagingJobMetadata_projectName :: Lens' ModelPackagingJobMetadata (Maybe Text) Source #

The project that contains the model that is in the model package.

modelPackagingJobMetadata_statusMessage :: Lens' ModelPackagingJobMetadata (Maybe Text) Source #

The status message for the model packaging job.

ModelPackagingOutputDetails

modelPackagingOutputDetails_greengrass :: Lens' ModelPackagingOutputDetails (Maybe GreengrassOutputDetails) Source #

Information about the AWS IoT Greengrass component in a model packaging job.

ModelPerformance

modelPerformance_f1Score :: Lens' ModelPerformance (Maybe Double) Source #

The overall F1 score metric for the trained model.

modelPerformance_precision :: Lens' ModelPerformance (Maybe Double) Source #

The overall precision metric value for the trained model.

modelPerformance_recall :: Lens' ModelPerformance (Maybe Double) Source #

The overall recall metric value for the trained model.

OutputConfig

outputConfig_s3Location :: Lens' OutputConfig S3Location Source #

The S3 location for the output.

OutputS3Object

outputS3Object_bucket :: Lens' OutputS3Object Text Source #

The bucket that contains the training output.

outputS3Object_key :: Lens' OutputS3Object Text Source #

The location of the training output in the bucket.

PixelAnomaly

pixelAnomaly_color :: Lens' PixelAnomaly (Maybe Text) Source #

A hex color value for the mask that covers an anomaly type. Each anomaly type has a different mask color. The color maps to the color of the anomaly type used in the training dataset.

pixelAnomaly_totalPercentageArea :: Lens' PixelAnomaly (Maybe Double) Source #

The percentage area of the image that the anomaly type covers.

ProjectDescription

projectDescription_creationTimestamp :: Lens' ProjectDescription (Maybe UTCTime) Source #

The unix timestamp for the date and time that the project was created.

projectDescription_projectArn :: Lens' ProjectDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project.

ProjectMetadata

projectMetadata_creationTimestamp :: Lens' ProjectMetadata (Maybe UTCTime) Source #

The unix timestamp for the date and time that the project was created.

projectMetadata_projectArn :: Lens' ProjectMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project.

S3Location

s3Location_prefix :: Lens' S3Location (Maybe Text) Source #

The path of the folder, within the S3 bucket, that contains the output.

s3Location_bucket :: Lens' S3Location Text Source #

The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.

Tag

tag_key :: Lens' Tag Text Source #

The key of the tag that is attached to the specified model.

tag_value :: Lens' Tag Text Source #

The value of the tag that is attached to the specified model.

TargetPlatform

targetPlatform_accelerator :: Lens' TargetPlatform (Maybe TargetPlatformAccelerator) Source #

The target accelerator for the model. Currently, Amazon Lookout for Vision only supports NVIDIA (Nvidia graphics processing unit) and CPU accelerators. If you specify NVIDIA as an accelerator, you must also specify the gpu-code, trt-ver, and cuda-ver compiler options. If you don't specify an accelerator, Lookout for Vision uses the CPU for compilation and we highly recommend that you use the GreengrassConfiguration$CompilerOptions field. For example, you can use the following compiler options for CPU:

  • mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
  • mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}

targetPlatform_os :: Lens' TargetPlatform TargetPlatformOs Source #

The target operating system for the model. Linux is the only operating system that is currently supported.

targetPlatform_arch :: Lens' TargetPlatform TargetPlatformArch Source #

The target architecture for the model. The currently supported architectures are X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).