String projectName
The name of the project in which you want to create a dataset.
String datasetType
The type of the dataset. Specify train for a training dataset. Specify test for a test
dataset.
DatasetSource 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.
String 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 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.
DatasetMetadata datasetMetadata
Information about the dataset.
String projectName
The name of the project in which you want to create a model version.
String description
A description for the version of the model.
String 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 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.
OutputConfig outputConfig
The location where Amazon Lookout for Vision saves the training results.
String kmsKeyId
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.
List<E> tags
A set of tags (key-value pairs) that you want to attach to the model.
ModelMetadata modelMetadata
The response from a call to CreateModel.
String projectName
The name for the project.
String 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 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.
ProjectMetadata projectMetadata
Information about the project.
String projectName
The name of the project that contains the dataset.
String datasetType
The type of the dataset. The value train represents a training dataset or single dataset project.
The value test represents a test dataset.
Date creationTimestamp
The Unix timestamp for the time and date that the dataset was created.
Date lastUpdatedTimestamp
The Unix timestamp for the date and time that the dataset was last updated.
String status
The status of the dataset.
String statusMessage
The status message for the dataset.
DatasetImageStats imageStats
Statistics about the images in a dataset.
InputS3Object s3Object
The S3 bucket location for the manifest file.
DatasetGroundTruthManifest groundTruthManifest
Location information for the manifest file.
String projectName
The name of the project that contains the dataset that you want to delete.
String 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.
String 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 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.
String projectName
The name of the project that contains the model that you want to delete.
String modelVersion
The version of the model that you want to delete.
String 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 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.
String modelArn
The Amazon Resource Name (ARN) of the model that was deleted.
String projectName
The name of the project to delete.
String 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 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.
String projectArn
The Amazon Resource Name (ARN) of the project that was deleted.
String projectName
The name of the project that contains the dataset that you want to describe.
String 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
DatasetDescription datasetDescription
The description of the requested dataset.
ModelPackagingDescription modelPackagingDescription
The description of the model packaging job.
ModelDescription modelDescription
Contains the description of the model.
String projectName
The name of the project that you want to describe.
ProjectDescription projectDescription
The description of the project.
String projectName
The name of the project that contains the model version that you want to use.
String modelVersion
The version of the model that you want to use.
InputStream body
The unencrypted image bytes that you want to analyze.
String contentType
The type of the image passed in Body. Valid values are image/png (PNG format images)
and image/jpeg (JPG format images).
DetectAnomalyResult detectAnomalyResult
The results of the DetectAnomalies operation.
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.
Boolean isAnomalous
True if the image contains an anomaly, otherwise false.
Float confidence
The confidence that Amazon Lookout for Vision has in the accuracy of the prediction.
String compilerOptions
Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) are supported.
For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.
String targetDevice
The target device for the model. Currently the only supported value is jetson_xavier. If you specify
TargetDevice, you can't specify TargetPlatform.
TargetPlatform targetPlatform
The target platform for the model. If you specify TargetPlatform, you can't specify
TargetDevice.
S3Location s3OutputLocation
An S3 location in which Lookout for Vision stores the component artifacts.
String componentName
A name for the AWS IoT Greengrass component.
String componentVersion
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.
String componentDescription
A description for the AWS IoT Greengrass component.
List<E> tags
A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.
String type
The type of the image.
Integer retryAfterSeconds
The period of time, in seconds, before the operation can be retried.
String projectName
The name of the project that contains the dataset that you want to list.
String 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.
Boolean labeled
Specify true to include labeled entries, otherwise specify false. If you don't specify
a value, Lookout for Vision returns all entries.
String 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.
Date beforeCreationDate
Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.
Date afterCreationDate
Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.
String 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.
Integer 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.
String 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*.
String projectName
The name of the project for which you want to list the model packaging jobs.
String nextToken
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.
Integer 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.
List<E> modelPackagingJobs
A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.
String nextToken
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.
String projectName
The name of the project that contains the model versions that you want to list.
String 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.
Integer 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.
String 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.
Integer 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.
String resourceArn
The Amazon Resource Name (ARN) of the model for which you want to list tags.
String modelVersion
The version of the model
String modelArn
The Amazon Resource Name (ARN) of the model.
Date creationTimestamp
The unix timestamp for the date and time that the model was created.
String description
The description for the model.
String status
The status of the model.
String statusMessage
The status message for the model.
ModelPerformance performance
Performance metrics for the model. Created during training.
OutputConfig outputConfig
The S3 location where Amazon Lookout for Vision saves model training files.
OutputS3Object 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.
OutputS3Object evaluationResult
The S3 location where Amazon Lookout for Vision saves the performance metrics.
Date evaluationEndTimestamp
The unix timestamp for the date and time that the evaluation ended.
String kmsKeyId
The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
Date creationTimestamp
The unix timestamp for the date and time that the model was created.
String modelVersion
The version of the model.
String modelArn
The Amazon Resource Name (ARN) of the model.
String description
The description for the model.
String status
The status of the model.
String statusMessage
The status message for the model.
ModelPerformance performance
Performance metrics for the model. Not available until training has successfully completed.
GreengrassConfiguration greengrass
Configuration information for the AWS IoT Greengrass component in a model packaging job.
String jobName
The name of the model packaging job.
String projectName
The name of the project that's associated with a model that's in the model package.
String modelVersion
The version of the model used in the model packaging job.
ModelPackagingConfiguration modelPackagingConfiguration
The configuration information used in the model packaging job.
String modelPackagingJobDescription
The description for the model packaging job.
String modelPackagingMethod
The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.
ModelPackagingOutputDetails modelPackagingOutputDetails
Information about the output of the model packaging job. For more information, see DescribeModelPackagingJob.
String status
The status of the model packaging job.
String statusMessage
The status message for the model packaging job.
Date creationTimestamp
The Unix timestamp for the time and date that the model packaging job was created.
Date lastUpdatedTimestamp
The Unix timestamp for the time and date that the model packaging job was last updated.
String jobName
The name of the model packaging job.
String projectName
The project that contains the model that is in the model package.
String modelVersion
The version of the model that is in the model package.
String modelPackagingJobDescription
The description for the model packaging job.
String modelPackagingMethod
The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.
String status
The status of the model packaging job.
String statusMessage
The status message for the model packaging job.
Date creationTimestamp
The Unix timestamp for the time and date that the model packaging job was created.
Date lastUpdatedTimestamp
The Unix timestamp for the time and date that the model packaging job was last updated.
GreengrassOutputDetails greengrass
Information about the AWS IoT Greengrass component in a model packaging job.
S3Location s3Location
The S3 location for the output.
String projectArn
The Amazon Resource Name (ARN) of the project.
String projectName
The name of the project.
Date creationTimestamp
The unix timestamp for the date and time that the project was created.
List<E> datasets
A list of datasets in the project.
String bucket
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.
String prefix
The path of the folder, within the S3 bucket, that contains the output.
String projectName
The name of the project which contains the version of the model that you want to package.
String modelVersion
The version of the model within the project that you want to package.
String jobName
A name for the model packaging job. If you don't supply a value, the service creates a job name for you.
ModelPackagingConfiguration configuration
The configuration for the model packaging job.
String description
A description for the model packaging job.
String clientToken
ClientToken is an idempotency token that ensures a call to StartModelPackagingJob completes only
once. You choose the value to pass. For example, An issue might prevent you from getting a response from
StartModelPackagingJob. In this case, safely retry your call to StartModelPackagingJob
by using the same ClientToken parameter value.
If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
prevents retries after a network error from making multiple dataset creation requests. You'll need to provide
your own value for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value
for ClientToken is considered a new call to StartModelPackagingJob. An idempotency
token is active for 8 hours.
String jobName
The job name for the model packaging job. If you don't supply a job name in the JobName input
parameter, the service creates a job name for you.
String projectName
The name of the project that contains the model that you want to start.
String modelVersion
The version of the model that you want to start.
Integer minInferenceUnits
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.
String 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 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.
String status
The current running status of the model.
String projectName
The name of the project that contains the model that you want to stop.
String modelVersion
The version of the model that you want to stop.
String clientToken
ClientToken is an idempotency token that ensures a call to StopModel completes only once. You choose
the value to pass. For example, An issue might prevent you from getting a response from StopModel.
In this case, safely retry your call to StopModel by using the same ClientToken
parameter value.
If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This
prevents retries after a network error from making multiple stop requests. You'll need to provide your own value
for other use cases.
An error occurs if the other input parameters are not the same as in the first request. Using a different value
for ClientToken is considered a new call to StopModel. An idempotency token is active
for 8 hours.
String status
The status of the model.
String os
The target operating system for the model. Linux is the only operating system that is currently supported.
String arch
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).
String accelerator
The target accelerator for the model. NVIDIA (Nvidia graphics processing unit) is the only accelerator that is
currently supported. You must also specify the gpu-code, trt-ver, and
cuda-ver compiler options.
String projectName
The name of the project that contains the dataset that you want to update.
String 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.
ByteBuffer changes
The entries to add to the dataset.
String 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 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.
String status
The status of the dataset update.
Copyright © 2022. All rights reserved.