| 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.LookoutVision
Description
Derived from API version 2020-11-20 of the AWS service descriptions, licensed under Apache 2.0.
This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, data types, common parameters, and common errors.
Amazon Lookout for Vision enables you to find visual defects in industrial products, accurately and at scale. It uses computer vision to identify missing components in an industrial product, damage to vehicles or structures, irregularities in production lines, and even minuscule defects in silicon wafers — or any other physical item where quality is important such as a missing capacitor on printed circuit boards.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListProjects = ListProjects' (Maybe Text) (Maybe Natural)
- newListProjects :: ListProjects
- data ListProjectsResponse = ListProjectsResponse' (Maybe Text) (Maybe [ProjectMetadata]) Int
- newListProjectsResponse :: Int -> ListProjectsResponse
- data DeleteProject = DeleteProject' (Maybe Text) Text
- newDeleteProject :: Text -> DeleteProject
- data DeleteProjectResponse = DeleteProjectResponse' (Maybe Text) Int
- newDeleteProjectResponse :: Int -> DeleteProjectResponse
- data DescribeDataset = DescribeDataset' Text Text
- newDescribeDataset :: Text -> Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe DatasetDescription) Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- data StopModel = StopModel' (Maybe Text) Text Text
- newStopModel :: Text -> Text -> StopModel
- data StopModelResponse = StopModelResponse' (Maybe ModelHostingStatus) Int
- newStopModelResponse :: Int -> StopModelResponse
- data ListDatasetEntries = ListDatasetEntries' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe POSIX) Text Text
- newListDatasetEntries :: Text -> Text -> ListDatasetEntries
- data ListDatasetEntriesResponse = ListDatasetEntriesResponse' (Maybe [Text]) (Maybe Text) Int
- newListDatasetEntriesResponse :: Int -> ListDatasetEntriesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DescribeProject = DescribeProject' Text
- newDescribeProject :: Text -> DescribeProject
- data DescribeProjectResponse = DescribeProjectResponse' (Maybe ProjectDescription) Int
- newDescribeProjectResponse :: Int -> DescribeProjectResponse
- data CreateModel = CreateModel' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text OutputConfig
- newCreateModel :: Text -> OutputConfig -> CreateModel
- data CreateModelResponse = CreateModelResponse' (Maybe ModelMetadata) Int
- newCreateModelResponse :: Int -> CreateModelResponse
- data DeleteDataset = DeleteDataset' (Maybe Text) Text Text
- newDeleteDataset :: Text -> Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' Int
- newDeleteDatasetResponse :: Int -> DeleteDatasetResponse
- data CreateDataset = CreateDataset' (Maybe Text) (Maybe DatasetSource) Text Text
- newCreateDataset :: Text -> Text -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' (Maybe DatasetMetadata) Int
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- data DeleteModel = DeleteModel' (Maybe Text) Text Text
- newDeleteModel :: Text -> Text -> DeleteModel
- data DeleteModelResponse = DeleteModelResponse' (Maybe Text) Int
- newDeleteModelResponse :: Int -> DeleteModelResponse
- data ListModels = ListModels' (Maybe Text) (Maybe Natural) Text
- newListModels :: Text -> ListModels
- data ListModelsResponse = ListModelsResponse' (Maybe Text) (Maybe [ModelMetadata]) Int
- newListModelsResponse :: Int -> ListModelsResponse
- data StartModel = StartModel' (Maybe Text) Text Text Natural
- newStartModel :: Text -> Text -> Natural -> StartModel
- data StartModelResponse = StartModelResponse' (Maybe ModelHostingStatus) Int
- newStartModelResponse :: Int -> StartModelResponse
- data DescribeModel = DescribeModel' Text Text
- newDescribeModel :: Text -> Text -> DescribeModel
- data DescribeModelResponse = DescribeModelResponse' (Maybe ModelDescription) Int
- newDescribeModelResponse :: Int -> DescribeModelResponse
- data DetectAnomalies = DetectAnomalies' Text Text Text HashedBody
- newDetectAnomalies :: Text -> Text -> Text -> HashedBody -> DetectAnomalies
- data DetectAnomaliesResponse = DetectAnomaliesResponse' (Maybe DetectAnomalyResult) Int
- newDetectAnomaliesResponse :: Int -> DetectAnomaliesResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data CreateProject = CreateProject' (Maybe Text) Text
- newCreateProject :: Text -> CreateProject
- data CreateProjectResponse = CreateProjectResponse' (Maybe ProjectMetadata) Int
- newCreateProjectResponse :: Int -> CreateProjectResponse
- data UpdateDatasetEntries = UpdateDatasetEntries' (Maybe Text) Text Text Base64
- newUpdateDatasetEntries :: Text -> Text -> ByteString -> UpdateDatasetEntries
- data UpdateDatasetEntriesResponse = UpdateDatasetEntriesResponse' (Maybe DatasetStatus) Int
- newUpdateDatasetEntriesResponse :: Int -> UpdateDatasetEntriesResponse
- newtype DatasetStatus where
- DatasetStatus' { }
- pattern DatasetStatus_CREATE_COMPLETE :: DatasetStatus
- pattern DatasetStatus_CREATE_FAILED :: DatasetStatus
- pattern DatasetStatus_CREATE_IN_PROGRESS :: DatasetStatus
- pattern DatasetStatus_DELETE_COMPLETE :: DatasetStatus
- pattern DatasetStatus_DELETE_FAILED :: DatasetStatus
- pattern DatasetStatus_DELETE_IN_PROGRESS :: DatasetStatus
- pattern DatasetStatus_UPDATE_COMPLETE :: DatasetStatus
- pattern DatasetStatus_UPDATE_FAILED_ROLLBACK_COMPLETE :: DatasetStatus
- pattern DatasetStatus_UPDATE_FAILED_ROLLBACK_IN_PROGRESS :: DatasetStatus
- pattern DatasetStatus_UPDATE_IN_PROGRESS :: DatasetStatus
- newtype ModelHostingStatus where
- ModelHostingStatus' { }
- pattern ModelHostingStatus_HOSTED :: ModelHostingStatus
- pattern ModelHostingStatus_HOSTING_FAILED :: ModelHostingStatus
- pattern ModelHostingStatus_STARTING_HOSTING :: ModelHostingStatus
- pattern ModelHostingStatus_STOPPING_HOSTING :: ModelHostingStatus
- pattern ModelHostingStatus_SYSTEM_UPDATING :: ModelHostingStatus
- newtype ModelStatus where
- ModelStatus' { }
- pattern ModelStatus_DELETING :: ModelStatus
- pattern ModelStatus_HOSTED :: ModelStatus
- pattern ModelStatus_HOSTING_FAILED :: ModelStatus
- pattern ModelStatus_STARTING_HOSTING :: ModelStatus
- pattern ModelStatus_STOPPING_HOSTING :: ModelStatus
- pattern ModelStatus_SYSTEM_UPDATING :: ModelStatus
- pattern ModelStatus_TRAINED :: ModelStatus
- pattern ModelStatus_TRAINING :: ModelStatus
- pattern ModelStatus_TRAINING_FAILED :: ModelStatus
- data DatasetDescription = DatasetDescription' (Maybe DatasetStatus) (Maybe DatasetImageStats) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDatasetDescription :: DatasetDescription
- data DatasetGroundTruthManifest = DatasetGroundTruthManifest' (Maybe InputS3Object)
- newDatasetGroundTruthManifest :: DatasetGroundTruthManifest
- data DatasetImageStats = DatasetImageStats' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int)
- newDatasetImageStats :: DatasetImageStats
- data DatasetMetadata = DatasetMetadata' (Maybe DatasetStatus) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newDatasetMetadata :: DatasetMetadata
- data DatasetSource = DatasetSource' (Maybe DatasetGroundTruthManifest)
- newDatasetSource :: DatasetSource
- data DetectAnomalyResult = DetectAnomalyResult' (Maybe Bool) (Maybe Double) (Maybe ImageSource)
- newDetectAnomalyResult :: DetectAnomalyResult
- data ImageSource = ImageSource' (Maybe Text)
- newImageSource :: ImageSource
- data InputS3Object = InputS3Object' (Maybe Text) Text Text
- newInputS3Object :: Text -> Text -> InputS3Object
- data ModelDescription = ModelDescription' (Maybe ModelStatus) (Maybe OutputS3Object) (Maybe POSIX) (Maybe Text) (Maybe ModelPerformance) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe OutputConfig) (Maybe Text) (Maybe Text) (Maybe OutputS3Object)
- newModelDescription :: ModelDescription
- data ModelMetadata = ModelMetadata' (Maybe ModelStatus) (Maybe Text) (Maybe ModelPerformance) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newModelMetadata :: ModelMetadata
- data ModelPerformance = ModelPerformance' (Maybe Double) (Maybe Double) (Maybe Double)
- newModelPerformance :: ModelPerformance
- data OutputConfig = OutputConfig' S3Location
- newOutputConfig :: S3Location -> OutputConfig
- data OutputS3Object = OutputS3Object' Text Text
- newOutputS3Object :: Text -> Text -> OutputS3Object
- data ProjectDescription = ProjectDescription' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [DatasetMetadata])
- newProjectDescription :: ProjectDescription
- data ProjectMetadata = ProjectMetadata' (Maybe POSIX) (Maybe Text) (Maybe Text)
- newProjectMetadata :: ProjectMetadata
- data S3Location = S3Location' (Maybe Text) Text
- newS3Location :: Text -> S3Location
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2020-11-20 of the Amazon Lookout for Vision SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by LookoutVision.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You are not authorized to perform the action.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The update or deletion of a resource caused an inconsistent state.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Lookout for Vision experienced a service issue. Try your call again.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource could not be found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListProjects (Paginated)
data ListProjects Source #
See: newListProjects smart constructor.
Constructors
| ListProjects' (Maybe Text) (Maybe Natural) |
Instances
newListProjects :: ListProjects Source #
Create a value of ListProjects 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:nextToken:ListProjects', listProjects_nextToken - 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.
$sel:maxResults:ListProjects', listProjects_maxResults - 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.
data ListProjectsResponse Source #
See: newListProjectsResponse smart constructor.
Constructors
| ListProjectsResponse' (Maybe Text) (Maybe [ProjectMetadata]) Int |
Instances
newListProjectsResponse Source #
Arguments
| :: Int | |
| -> ListProjectsResponse |
Create a value of ListProjectsResponse 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:nextToken:ListProjects', listProjectsResponse_nextToken - 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.
$sel:projects:ListProjectsResponse', listProjectsResponse_projects - A list of projects in your AWS account.
$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.
DeleteProject
data DeleteProject Source #
See: newDeleteProject smart constructor.
Constructors
| DeleteProject' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteProject |
Create a value of DeleteProject 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:DeleteProject', deleteProject_clientToken - ClientToken is an idempotency token that ensures a call to
DeleteProject completes only once. You choose the value to pass. For
example, An issue, such as an network outage, 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.
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.
$sel:projectName:DeleteProject', deleteProject_projectName - The name of the project to delete.
data DeleteProjectResponse Source #
See: newDeleteProjectResponse smart constructor.
Constructors
| DeleteProjectResponse' (Maybe Text) Int |
Instances
newDeleteProjectResponse Source #
Create a value of DeleteProjectResponse 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:projectArn:DeleteProjectResponse', deleteProjectResponse_projectArn - The Amazon Resource Name (ARN) of the project that was deleted.
$sel:httpStatus:DeleteProjectResponse', deleteProjectResponse_httpStatus - The response's http status code.
DescribeDataset
data DescribeDataset Source #
See: newDescribeDataset smart constructor.
Constructors
| DescribeDataset' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeDataset |
Create a value of DescribeDataset 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:projectName:DescribeDataset', describeDataset_projectName - The name of the project that contains the dataset that you want to
describe.
$sel:datasetType:DescribeDataset', describeDataset_datasetType - 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
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse smart constructor.
Constructors
| DescribeDatasetResponse' (Maybe DatasetDescription) Int |
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse 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:datasetDescription:DescribeDatasetResponse', describeDatasetResponse_datasetDescription - The description of the requested dataset.
$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.
StopModel
See: newStopModel smart constructor.
Constructors
| StopModel' (Maybe Text) Text Text |
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, such as an network outage, 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. 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.
$sel:projectName:StopModel', stopModel_projectName - The name of the project that contains the model that you want to stop.
$sel:modelVersion:StopModel', stopModel_modelVersion - The version of the model that you want to stop.
data StopModelResponse Source #
See: newStopModelResponse smart constructor.
Constructors
| StopModelResponse' (Maybe ModelHostingStatus) Int |
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:
$sel:status:StopModelResponse', stopModelResponse_status - The status of the model.
$sel:httpStatus:StopModelResponse', stopModelResponse_httpStatus - The response's http status code.
ListDatasetEntries (Paginated)
data ListDatasetEntries Source #
See: newListDatasetEntries smart constructor.
Constructors
| ListDatasetEntries' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe POSIX) Text Text |
Instances
newListDatasetEntries Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListDatasetEntries |
Create a value of ListDatasetEntries 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:beforeCreationDate:ListDatasetEntries', listDatasetEntries_beforeCreationDate - Only includes entries before the specified date in the response. For
example, 2020-06-23T00:00:00.
$sel:sourceRefContains:ListDatasetEntries', listDatasetEntries_sourceRefContains - 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*.
$sel:nextToken:ListDatasetEntries', listDatasetEntries_nextToken - 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.
$sel:labeled:ListDatasetEntries', listDatasetEntries_labeled - Specify true to include labeled entries, otherwise specify false. If
you don't specify a value, Lookout for Vision returns all entries.
$sel:anomalyClass:ListDatasetEntries', listDatasetEntries_anomalyClass - 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.
$sel:maxResults:ListDatasetEntries', listDatasetEntries_maxResults - 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.
$sel:afterCreationDate:ListDatasetEntries', listDatasetEntries_afterCreationDate - Only includes entries after the specified date in the response. For
example, 2020-06-23T00:00:00.
$sel:projectName:ListDatasetEntries', listDatasetEntries_projectName - The name of the project that contains the dataset that you want to list.
$sel:datasetType:ListDatasetEntries', listDatasetEntries_datasetType - 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.
data ListDatasetEntriesResponse Source #
See: newListDatasetEntriesResponse smart constructor.
Instances
newListDatasetEntriesResponse Source #
Create a value of ListDatasetEntriesResponse 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:datasetEntries:ListDatasetEntriesResponse', listDatasetEntriesResponse_datasetEntries - A list of the entries (JSON Lines) within the dataset.
$sel:nextToken:ListDatasetEntries', listDatasetEntriesResponse_nextToken - 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.
$sel:httpStatus:ListDatasetEntriesResponse', listDatasetEntriesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the model for which you want to list
tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - A map of tag keys and values attached to the specified model.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
DescribeProject
data DescribeProject Source #
See: newDescribeProject smart constructor.
Constructors
| DescribeProject' Text |
Instances
Arguments
| :: Text | |
| -> DescribeProject |
Create a value of DescribeProject 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:projectName:DescribeProject', describeProject_projectName - The name of the project that you want to describe.
data DescribeProjectResponse Source #
See: newDescribeProjectResponse smart constructor.
Constructors
| DescribeProjectResponse' (Maybe ProjectDescription) Int |
Instances
newDescribeProjectResponse Source #
Create a value of DescribeProjectResponse 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:projectDescription:DescribeProjectResponse', describeProjectResponse_projectDescription - The description of the project.
$sel:httpStatus:DescribeProjectResponse', describeProjectResponse_httpStatus - The response's http status code.
CreateModel
data CreateModel Source #
See: newCreateModel smart constructor.
Instances
Arguments
| :: Text | |
| -> OutputConfig | |
| -> CreateModel |
Create a value of CreateModel 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:CreateModel', createModel_clientToken - ClientToken is an idempotency token that ensures a call to CreateModel
completes only once. You choose the value to pass. For example, An
issue, such as an network outage, 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. 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.
$sel:kmsKeyId:CreateModel', createModel_kmsKeyId - The identifier for your AWS Key Management Service (AWS KMS) customer
master key (CMK). 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.
$sel:description:CreateModel', createModel_description - A description for the version of the model.
$sel:tags:CreateModel', createModel_tags - A set of tags (key-value pairs) that you want to attach to the model.
$sel:projectName:CreateModel', createModel_projectName - The name of the project in which you want to create a model version.
$sel:outputConfig:CreateModel', createModel_outputConfig - The location where Amazon Lookout for Vision saves the training results.
data CreateModelResponse Source #
See: newCreateModelResponse smart constructor.
Constructors
| CreateModelResponse' (Maybe ModelMetadata) Int |
Instances
newCreateModelResponse Source #
Arguments
| :: Int | |
| -> CreateModelResponse |
Create a value of CreateModelResponse 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:modelMetadata:CreateModelResponse', createModelResponse_modelMetadata - The response from a call to CreateModel.
$sel:httpStatus:CreateModelResponse', createModelResponse_httpStatus - The response's http status code.
DeleteDataset
data DeleteDataset Source #
See: newDeleteDataset smart constructor.
Constructors
| DeleteDataset' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteDataset |
Create a value of DeleteDataset 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:DeleteDataset', deleteDataset_clientToken - ClientToken is an idempotency token that ensures a call to
DeleteDataset completes only once. You choose the value to pass. For
example, An issue, such as an network outage, 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.
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.
$sel:projectName:DeleteDataset', deleteDataset_projectName - The name of the project that contains the dataset that you want to
delete.
$sel:datasetType:DeleteDataset', deleteDataset_datasetType - 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.
data DeleteDatasetResponse Source #
See: newDeleteDatasetResponse smart constructor.
Constructors
| DeleteDatasetResponse' Int |
Instances
newDeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse 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:httpStatus:DeleteDatasetResponse', deleteDatasetResponse_httpStatus - The response's http status code.
CreateDataset
data CreateDataset Source #
See: newCreateDataset smart constructor.
Constructors
| CreateDataset' (Maybe Text) (Maybe DatasetSource) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateDataset |
Create a value of CreateDataset 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:CreateDataset', createDataset_clientToken - ClientToken is an idempotency token that ensures a call to
CreateDataset completes only once. You choose the value to pass. For
example, An issue, such as an network outage, 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.
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.
$sel:datasetSource:CreateDataset', createDataset_datasetSource - 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.
$sel:projectName:CreateDataset', createDataset_projectName - The name of the project in which you want to create a dataset.
$sel:datasetType:CreateDataset', createDataset_datasetType - The type of the dataset. Specify train for a training dataset. Specify
test for a test dataset.
data CreateDatasetResponse Source #
See: newCreateDatasetResponse smart constructor.
Constructors
| CreateDatasetResponse' (Maybe DatasetMetadata) Int |
Instances
newCreateDatasetResponse Source #
Create a value of CreateDatasetResponse 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:datasetMetadata:CreateDatasetResponse', createDatasetResponse_datasetMetadata - Information about the dataset.
$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.
DeleteModel
data DeleteModel Source #
See: newDeleteModel smart constructor.
Constructors
| DeleteModel' (Maybe Text) Text Text |
Instances
Create a value of DeleteModel 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:DeleteModel', deleteModel_clientToken - ClientToken is an idempotency token that ensures a call to DeleteModel
completes only once. You choose the value to pass. For example, An
issue, such as an network outage, 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. 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.
$sel:projectName:DeleteModel', deleteModel_projectName - The name of the project that contains the model that you want to delete.
$sel:modelVersion:DeleteModel', deleteModel_modelVersion - The version of the model that you want to delete.
data DeleteModelResponse Source #
See: newDeleteModelResponse smart constructor.
Constructors
| DeleteModelResponse' (Maybe Text) Int |
Instances
newDeleteModelResponse Source #
Arguments
| :: Int | |
| -> DeleteModelResponse |
Create a value of DeleteModelResponse 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:modelArn:DeleteModelResponse', deleteModelResponse_modelArn - The Amazon Resource Name (ARN) of the model that was deleted.
$sel:httpStatus:DeleteModelResponse', deleteModelResponse_httpStatus - The response's http status code.
ListModels (Paginated)
data ListModels Source #
See: newListModels smart constructor.
Instances
Arguments
| :: Text | |
| -> ListModels |
Create a value of ListModels 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:nextToken:ListModels', listModels_nextToken - 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.
$sel:maxResults:ListModels', listModels_maxResults - 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.
$sel:projectName:ListModels', listModels_projectName - The name of the project that contains the model versions that you want
to list.
data ListModelsResponse Source #
See: newListModelsResponse smart constructor.
Constructors
| ListModelsResponse' (Maybe Text) (Maybe [ModelMetadata]) Int |
Instances
newListModelsResponse Source #
Arguments
| :: Int | |
| -> ListModelsResponse |
Create a value of ListModelsResponse 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:nextToken:ListModels', listModelsResponse_nextToken - 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.
$sel:models:ListModelsResponse', listModelsResponse_models - A list of model versions in the specified project.
$sel:httpStatus:ListModelsResponse', listModelsResponse_httpStatus - The response's http status code.
StartModel
data StartModel Source #
See: newStartModel smart constructor.
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, such as an network outage, 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. 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.
$sel:projectName:StartModel', startModel_projectName - The name of the project that contains the model that you want to start.
$sel:modelVersion:StartModel', startModel_modelVersion - The version of the model that you want to start.
$sel:minInferenceUnits:StartModel', startModel_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.
data StartModelResponse Source #
See: newStartModelResponse smart constructor.
Constructors
| StartModelResponse' (Maybe ModelHostingStatus) Int |
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:
$sel:status:StartModelResponse', startModelResponse_status - The current running status of the model.
$sel:httpStatus:StartModelResponse', startModelResponse_httpStatus - The response's http status code.
DescribeModel
data DescribeModel Source #
See: newDescribeModel smart constructor.
Constructors
| DescribeModel' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeModel |
Create a value of DescribeModel 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:projectName:DescribeModel', describeModel_projectName - The project that contains the version of a model that you want to
describe.
$sel:modelVersion:DescribeModel', describeModel_modelVersion - The version of the model that you want to describe.
data DescribeModelResponse Source #
See: newDescribeModelResponse smart constructor.
Constructors
| DescribeModelResponse' (Maybe ModelDescription) Int |
Instances
newDescribeModelResponse Source #
Create a value of DescribeModelResponse 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:modelDescription:DescribeModelResponse', describeModelResponse_modelDescription - Contains the description of the model.
$sel:httpStatus:DescribeModelResponse', describeModelResponse_httpStatus - The response's http status code.
DetectAnomalies
data DetectAnomalies Source #
See: newDetectAnomalies smart constructor.
Constructors
| DetectAnomalies' Text Text Text HashedBody |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> HashedBody | |
| -> DetectAnomalies |
Create a value of DetectAnomalies 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:projectName:DetectAnomalies', detectAnomalies_projectName - The name of the project that contains the model version that you want to
use.
$sel:modelVersion:DetectAnomalies', detectAnomalies_modelVersion - The version of the model that you want to use.
$sel:contentType:DetectAnomalies', detectAnomalies_contentType - The type of the image passed in Body. Valid values are image/png
(PNG format images) and image/jpeg (JPG format images).
$sel:body:DetectAnomalies', detectAnomalies_body - The unencrypted image bytes that you want to analyze.
data DetectAnomaliesResponse Source #
See: newDetectAnomaliesResponse smart constructor.
Constructors
| DetectAnomaliesResponse' (Maybe DetectAnomalyResult) Int |
Instances
newDetectAnomaliesResponse Source #
Create a value of DetectAnomaliesResponse 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:detectAnomalyResult:DetectAnomaliesResponse', detectAnomaliesResponse_detectAnomalyResult - The results of the DetectAnomalies operation.
$sel:httpStatus:DetectAnomaliesResponse', detectAnomaliesResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the model to assign the tags.
$sel:tags:TagResource', tagResource_tags - The key-value tags to assign to the model.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the model from which you want to
remove tags.
$sel:tagKeys:UntagResource', untagResource_tagKeys - A list of the keys of the tags that you want to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
CreateProject
data CreateProject Source #
See: newCreateProject smart constructor.
Constructors
| CreateProject' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> CreateProject |
Create a value of CreateProject 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:CreateProject', createProject_clientToken - ClientToken is an idempotency token that ensures a call to
CreateProject completes only once. You choose the value to pass. For
example, An issue, such as an network outage, 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.
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.
$sel:projectName:CreateProject', createProject_projectName - The name for the project.
data CreateProjectResponse Source #
See: newCreateProjectResponse smart constructor.
Constructors
| CreateProjectResponse' (Maybe ProjectMetadata) Int |
Instances
newCreateProjectResponse Source #
Create a value of CreateProjectResponse 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:projectMetadata:CreateProjectResponse', createProjectResponse_projectMetadata - Information about the project.
$sel:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.
UpdateDatasetEntries
data UpdateDatasetEntries Source #
See: newUpdateDatasetEntries smart constructor.
Instances
newUpdateDatasetEntries Source #
Arguments
| :: Text | |
| -> Text | |
| -> ByteString | |
| -> UpdateDatasetEntries |
Create a value of UpdateDatasetEntries 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:UpdateDatasetEntries', updateDatasetEntries_clientToken - ClientToken is an idempotency token that ensures a call to
UpdateDatasetEntries completes only once. You choose the value to
pass. For example, An issue, such as an network outage, 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. 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.
$sel:projectName:UpdateDatasetEntries', updateDatasetEntries_projectName - The name of the project that contains the dataset that you want to
update.
$sel:datasetType:UpdateDatasetEntries', updateDatasetEntries_datasetType - 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.
$sel:changes:UpdateDatasetEntries', updateDatasetEntries_changes - 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.
data UpdateDatasetEntriesResponse Source #
See: newUpdateDatasetEntriesResponse smart constructor.
Constructors
| UpdateDatasetEntriesResponse' (Maybe DatasetStatus) Int |
Instances
newUpdateDatasetEntriesResponse Source #
Create a value of UpdateDatasetEntriesResponse 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:UpdateDatasetEntriesResponse', updateDatasetEntriesResponse_status - The status of the dataset update.
$sel:httpStatus:UpdateDatasetEntriesResponse', updateDatasetEntriesResponse_httpStatus - The response's http status code.
Types
DatasetStatus
newtype DatasetStatus Source #
Constructors
| DatasetStatus' | |
Fields | |
Bundled Patterns
| pattern DatasetStatus_CREATE_COMPLETE :: DatasetStatus | |
| pattern DatasetStatus_CREATE_FAILED :: DatasetStatus | |
| pattern DatasetStatus_CREATE_IN_PROGRESS :: DatasetStatus | |
| pattern DatasetStatus_DELETE_COMPLETE :: DatasetStatus | |
| pattern DatasetStatus_DELETE_FAILED :: DatasetStatus | |
| pattern DatasetStatus_DELETE_IN_PROGRESS :: DatasetStatus | |
| pattern DatasetStatus_UPDATE_COMPLETE :: DatasetStatus | |
| pattern DatasetStatus_UPDATE_FAILED_ROLLBACK_COMPLETE :: DatasetStatus | |
| pattern DatasetStatus_UPDATE_FAILED_ROLLBACK_IN_PROGRESS :: DatasetStatus | |
| pattern DatasetStatus_UPDATE_IN_PROGRESS :: DatasetStatus |
Instances
ModelHostingStatus
newtype ModelHostingStatus Source #
Constructors
| ModelHostingStatus' | |
Fields | |
Bundled Patterns
| pattern ModelHostingStatus_HOSTED :: ModelHostingStatus | |
| pattern ModelHostingStatus_HOSTING_FAILED :: ModelHostingStatus | |
| pattern ModelHostingStatus_STARTING_HOSTING :: ModelHostingStatus | |
| pattern ModelHostingStatus_STOPPING_HOSTING :: ModelHostingStatus | |
| pattern ModelHostingStatus_SYSTEM_UPDATING :: ModelHostingStatus |
Instances
ModelStatus
newtype ModelStatus Source #
Constructors
| ModelStatus' | |
Fields | |
Bundled Patterns
| pattern ModelStatus_DELETING :: ModelStatus | |
| pattern ModelStatus_HOSTED :: ModelStatus | |
| pattern ModelStatus_HOSTING_FAILED :: ModelStatus | |
| pattern ModelStatus_STARTING_HOSTING :: ModelStatus | |
| pattern ModelStatus_STOPPING_HOSTING :: ModelStatus | |
| pattern ModelStatus_SYSTEM_UPDATING :: ModelStatus | |
| pattern ModelStatus_TRAINED :: ModelStatus | |
| pattern ModelStatus_TRAINING :: ModelStatus | |
| pattern ModelStatus_TRAINING_FAILED :: ModelStatus |
Instances
DatasetDescription
data DatasetDescription Source #
The description for a dataset. For more information, see DescribeDataset.
See: newDatasetDescription smart constructor.
Constructors
| DatasetDescription' (Maybe DatasetStatus) (Maybe DatasetImageStats) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newDatasetDescription :: DatasetDescription Source #
Create a value of DatasetDescription 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:DatasetDescription', datasetDescription_status - The status of the dataset.
$sel:imageStats:DatasetDescription', datasetDescription_imageStats -
$sel:statusMessage:DatasetDescription', datasetDescription_statusMessage - The status message for the dataset.
$sel:creationTimestamp:DatasetDescription', datasetDescription_creationTimestamp - The Unix timestamp for the time and date that the dataset was created.
$sel:datasetType:DatasetDescription', datasetDescription_datasetType - The type of the dataset. The value train represents a training dataset
or single dataset project. The value test represents a test dataset.
$sel:projectName:DatasetDescription', datasetDescription_projectName - The name of the project that contains the dataset.
$sel:lastUpdatedTimestamp:DatasetDescription', datasetDescription_lastUpdatedTimestamp - The Unix timestamp for the date and time that the dataset was last
updated.
DatasetGroundTruthManifest
data DatasetGroundTruthManifest Source #
Location information about a manifest file. You can use a manifest file to create a dataset.
See: newDatasetGroundTruthManifest smart constructor.
Constructors
| DatasetGroundTruthManifest' (Maybe InputS3Object) |
Instances
newDatasetGroundTruthManifest :: DatasetGroundTruthManifest Source #
Create a value of DatasetGroundTruthManifest 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:s3Object:DatasetGroundTruthManifest', datasetGroundTruthManifest_s3Object - The S3 bucket location for the manifest file.
DatasetImageStats
data DatasetImageStats Source #
Statistics about the images in a dataset.
See: newDatasetImageStats smart constructor.
Instances
newDatasetImageStats :: DatasetImageStats Source #
Create a value of DatasetImageStats 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:normal:DatasetImageStats', datasetImageStats_normal - The total number of images labeled as normal.
$sel:anomaly:DatasetImageStats', datasetImageStats_anomaly - the total number of images labeled as an anomaly.
$sel:labeled:DatasetImageStats', datasetImageStats_labeled - The total number of labeled images.
$sel:total:DatasetImageStats', datasetImageStats_total - The total number of images in the dataset.
DatasetMetadata
data DatasetMetadata Source #
Sumary information for an Amazon Lookout for Vision dataset.
See: newDatasetMetadata smart constructor.
Constructors
| DatasetMetadata' (Maybe DatasetStatus) (Maybe Text) (Maybe POSIX) (Maybe Text) |
Instances
newDatasetMetadata :: DatasetMetadata Source #
Create a value of DatasetMetadata 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:DatasetMetadata', datasetMetadata_status - The status for the dataset.
$sel:statusMessage:DatasetMetadata', datasetMetadata_statusMessage - The status message for the dataset.
$sel:creationTimestamp:DatasetMetadata', datasetMetadata_creationTimestamp - The Unix timestamp for the date and time that the dataset was created.
$sel:datasetType:DatasetMetadata', datasetMetadata_datasetType - The type of the dataset.
DatasetSource
data DatasetSource Source #
Information about the location of a manifest file that Amazon Lookout for Vision uses to to create a dataset.
See: newDatasetSource smart constructor.
Constructors
| DatasetSource' (Maybe DatasetGroundTruthManifest) |
Instances
newDatasetSource :: DatasetSource Source #
Create a value of DatasetSource 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:groundTruthManifest:DatasetSource', datasetSource_groundTruthManifest - Location information for the manifest file.
DetectAnomalyResult
data DetectAnomalyResult Source #
The prediction results from a call to DetectAnomalies.
See: newDetectAnomalyResult smart constructor.
Constructors
| DetectAnomalyResult' (Maybe Bool) (Maybe Double) (Maybe ImageSource) |
Instances
newDetectAnomalyResult :: DetectAnomalyResult Source #
Create a value of DetectAnomalyResult 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:isAnomalous:DetectAnomalyResult', detectAnomalyResult_isAnomalous - True if the image contains an anomaly, otherwise false.
$sel:confidence:DetectAnomalyResult', detectAnomalyResult_confidence - The confidence that Amazon Lookout for Vision has in the accuracy of the
prediction.
$sel:source:DetectAnomalyResult', detectAnomalyResult_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.
ImageSource
data ImageSource Source #
The source for an image.
See: newImageSource smart constructor.
Constructors
| ImageSource' (Maybe Text) |
Instances
newImageSource :: ImageSource Source #
Create a value of ImageSource 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:type':ImageSource', imageSource_type - The type of the image.
InputS3Object
data InputS3Object Source #
Amazon S3 Location information for an input manifest file.
See: newInputS3Object smart constructor.
Constructors
| InputS3Object' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> InputS3Object |
Create a value of InputS3Object 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:versionId:InputS3Object', inputS3Object_versionId - The version ID of the bucket.
$sel:bucket:InputS3Object', inputS3Object_bucket - The Amazon S3 bucket that contains the manifest.
$sel:key:InputS3Object', inputS3Object_key - The name and location of the manifest file withiin the bucket.
ModelDescription
data ModelDescription Source #
Describes an Amazon Lookout for Vision model.
See: newModelDescription smart constructor.
Constructors
| ModelDescription' (Maybe ModelStatus) (Maybe OutputS3Object) (Maybe POSIX) (Maybe Text) (Maybe ModelPerformance) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe OutputConfig) (Maybe Text) (Maybe Text) (Maybe OutputS3Object) |
Instances
newModelDescription :: ModelDescription Source #
Create a value of ModelDescription 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:ModelDescription', modelDescription_status - The status of the model.
$sel:evaluationResult:ModelDescription', modelDescription_evaluationResult - The S3 location where Amazon Lookout for Vision saves the performance
metrics.
$sel:evaluationEndTimestamp:ModelDescription', modelDescription_evaluationEndTimestamp - The unix timestamp for the date and time that the evaluation ended.
$sel:modelArn:ModelDescription', modelDescription_modelArn - The Amazon Resource Name (ARN) of the model.
$sel:performance:ModelDescription', modelDescription_performance - Performance metrics for the model. Created during training.
$sel:kmsKeyId:ModelDescription', modelDescription_kmsKeyId - The identifer for the AWS Key Management Service (AWS KMS) key that was
used to encrypt the model during training.
$sel:statusMessage:ModelDescription', modelDescription_statusMessage - The status message for the model.
$sel:creationTimestamp:ModelDescription', modelDescription_creationTimestamp - The unix timestamp for the date and time that the model was created.
$sel:outputConfig:ModelDescription', modelDescription_outputConfig - The S3 location where Amazon Lookout for Vision saves model training
files.
$sel:modelVersion:ModelDescription', modelDescription_modelVersion - The version of the model
$sel:description:ModelDescription', modelDescription_description - The description for the model.
$sel:evaluationManifest:ModelDescription', modelDescription_evaluationManifest - 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.
ModelMetadata
data ModelMetadata Source #
Describes an Amazon Lookout for Vision model.
See: newModelMetadata smart constructor.
Constructors
| ModelMetadata' (Maybe ModelStatus) (Maybe Text) (Maybe ModelPerformance) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newModelMetadata :: ModelMetadata Source #
Create a value of ModelMetadata 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:ModelMetadata', modelMetadata_status - The status of the model.
$sel:modelArn:ModelMetadata', modelMetadata_modelArn - The Amazon Resource Name (ARN) of the model.
$sel:performance:ModelMetadata', modelMetadata_performance - Performance metrics for the model. Not available until training has
successfully completed.
$sel:statusMessage:ModelMetadata', modelMetadata_statusMessage - The status message for the model.
$sel:creationTimestamp:ModelMetadata', modelMetadata_creationTimestamp - The unix timestamp for the date and time that the model was created.
$sel:modelVersion:ModelMetadata', modelMetadata_modelVersion - The version of the model.
$sel:description:ModelMetadata', modelMetadata_description - The description for the model.
ModelPerformance
data ModelPerformance Source #
Information about the evaluation performance of a trained model.
See: newModelPerformance smart constructor.
Instances
newModelPerformance :: ModelPerformance Source #
Create a value of ModelPerformance 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:recall:ModelPerformance', modelPerformance_recall - The overall recall metric value for the trained model.
$sel:precision:ModelPerformance', modelPerformance_precision - The overall precision metric value for the trained model.
$sel:f1Score:ModelPerformance', modelPerformance_f1Score - The overall F1 score metric for the trained model.
OutputConfig
data OutputConfig Source #
The S3 location where Amazon Lookout for Vision saves model training files.
See: newOutputConfig smart constructor.
Constructors
| OutputConfig' S3Location |
Instances
Arguments
| :: S3Location | |
| -> OutputConfig |
Create a value of OutputConfig 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:s3Location:OutputConfig', outputConfig_s3Location - The S3 location for the output.
OutputS3Object
data OutputS3Object Source #
The S3 location where Amazon Lookout for Vision saves training output.
See: newOutputS3Object smart constructor.
Constructors
| OutputS3Object' Text Text |
Instances
Create a value of OutputS3Object 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:bucket:OutputS3Object', outputS3Object_bucket - The bucket that contains the training output.
$sel:key:OutputS3Object', outputS3Object_key - The location of the training output in the bucket.
ProjectDescription
data ProjectDescription Source #
Describe an Amazon Lookout for Vision project. For more information, see DescribeProject.
See: newProjectDescription smart constructor.
Constructors
| ProjectDescription' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [DatasetMetadata]) |
Instances
newProjectDescription :: ProjectDescription Source #
Create a value of ProjectDescription 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:creationTimestamp:ProjectDescription', projectDescription_creationTimestamp - The unix timestamp for the date and time that the project was created.
$sel:projectName:ProjectDescription', projectDescription_projectName - The name of the project.
$sel:projectArn:ProjectDescription', projectDescription_projectArn - The Amazon Resource Name (ARN) of the project.
$sel:datasets:ProjectDescription', projectDescription_datasets - A list of datasets in the project.
ProjectMetadata
data ProjectMetadata Source #
Metadata about an Amazon Lookout for Vision project.
See: newProjectMetadata smart constructor.
Instances
newProjectMetadata :: ProjectMetadata Source #
Create a value of ProjectMetadata 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:creationTimestamp:ProjectMetadata', projectMetadata_creationTimestamp - The unix timestamp for the date and time that the project was created.
$sel:projectName:ProjectMetadata', projectMetadata_projectName - The name of the project.
$sel:projectArn:ProjectMetadata', projectMetadata_projectArn - The Amazon Resource Name (ARN) of the project.
S3Location
data S3Location Source #
Information about the location training output.
See: newS3Location smart constructor.
Constructors
| S3Location' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> S3Location |
Create a value of S3Location 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:prefix:S3Location', s3Location_prefix - The path of the folder, within the S3 bucket, that contains the training
output.
$sel:bucket:S3Location', s3Location_bucket - The S3 bucket that contains the training output.
Tag
A key and value pair that is attached to the specified Amazon Lookout for Vision model.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.LookoutVision.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.LookoutVision.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.LookoutVision.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.LookoutVision.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.LookoutVision.Types.Tag" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - The key of the tag that is attached to the specified model.
$sel:value:Tag', tag_value - The value of the tag that is attached to the specified model.