Table of Contents
A low-level client representing Amazon Lookout for Vision
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.
import boto3
client = boto3.client('lookoutvision')
These are the available methods:
Check if an operation can be paginated.
Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a training or a test dataset from a valid dataset source (DatasetSource ).
If you want a single dataset project, specify train for the value of DatasetType .
To have a project with separate training and test datasets, call CreateDataset twice. On the first call, specify train for the value of DatasetType . On the second call, specify test for the value of DatasetType .
This operation requires permissions to perform the lookoutvision:CreateDataset operation.
See also: AWS API Documentation
Request Syntax
response = client.create_dataset(
ProjectName='string',
DatasetType='string',
DatasetSource={
'GroundTruthManifest': {
'S3Object': {
'Bucket': 'string',
'Key': 'string',
'VersionId': 'string'
}
}
},
ClientToken='string'
)
[REQUIRED]
The name of the project in which you want to create a dataset.
[REQUIRED]
The type of the dataset. Specify train for a training dataset. Specify test for a test dataset.
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 .
Location information for the manifest file.
The S3 bucket location for the manifest file.
The Amazon S3 bucket that contains the manifest.
The name and location of the manifest file withiin the bucket.
The version ID of the bucket.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'DatasetMetadata': {
'DatasetType': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED_ROLLBACK_IN_PROGRESS'|'UPDATE_FAILED_ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED',
'StatusMessage': 'string'
}
}
Response Structure
(dict) --
DatasetMetadata (dict) --
Information about the dataset.
DatasetType (string) --
The type of the dataset.
CreationTimestamp (datetime) --
The Unix timestamp for the date and time that the dataset was created.
Status (string) --
The status for the dataset.
StatusMessage (string) --
The status message for the dataset.
Exceptions
Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.
To get the current status, check the Status field returned in the response from DescribeModel .
If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.
After training completes, the evaluation metrics are stored at the location specified in OutputConfig .
This operation requires permissions to perform the lookoutvision:CreateModel operation. If you want to tag your model, you also require permission to the lookoutvision:TagResource operation.
See also: AWS API Documentation
Request Syntax
response = client.create_model(
ProjectName='string',
Description='string',
ClientToken='string',
OutputConfig={
'S3Location': {
'Bucket': 'string',
'Prefix': 'string'
}
},
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the project in which you want to create a model version.
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.
This field is autopopulated if not provided.
[REQUIRED]
The location where Amazon Lookout for Vision saves the training results.
The S3 location for the output.
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.
The path of the folder, within the S3 bucket, that contains the output.
A set of tags (key-value pairs) that you want to attach to the model.
A key and value pair that is attached to the specified Amazon Lookout for Vision model.
The key of the tag that is attached to the specified model.
The value of the tag that is attached to the specified model.
dict
Response Syntax
{
'ModelMetadata': {
'CreationTimestamp': datetime(2015, 1, 1),
'ModelVersion': 'string',
'ModelArn': 'string',
'Description': 'string',
'Status': 'TRAINING'|'TRAINED'|'TRAINING_FAILED'|'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'|'DELETING',
'StatusMessage': 'string',
'Performance': {
'F1Score': ...,
'Recall': ...,
'Precision': ...
}
}
}
Response Structure
(dict) --
ModelMetadata (dict) --
The response from a call to CreateModel .
CreationTimestamp (datetime) --
The unix timestamp for the date and time that the model was created.
ModelVersion (string) --
The version of the model.
ModelArn (string) --
The Amazon Resource Name (ARN) of the model.
Description (string) --
The description for the model.
Status (string) --
The status of the model.
StatusMessage (string) --
The status message for the model.
Performance (dict) --
Performance metrics for the model. Not available until training has successfully completed.
F1Score (float) --
The overall F1 score metric for the trained model.
Recall (float) --
The overall recall metric value for the trained model.
Precision (float) --
The overall precision metric value for the trained model.
Exceptions
Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset .
This operation requires permissions to perform the lookoutvision:CreateProject operation.
See also: AWS API Documentation
Request Syntax
response = client.create_project(
ProjectName='string',
ClientToken='string'
)
[REQUIRED]
The name for the project.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProjectMetadata': {
'ProjectArn': 'string',
'ProjectName': 'string',
'CreationTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProjectMetadata (dict) --
Information about the project.
ProjectArn (string) --
The Amazon Resource Name (ARN) of the project.
ProjectName (string) --
The name of the project.
CreationTimestamp (datetime) --
The unix timestamp for the date and time that the project was created.
Exceptions
Deletes an existing Amazon Lookout for Vision dataset .
If your the project has a single dataset, you must create a new dataset before you can create a model.
If you project has a training dataset and a test dataset consider the following.
This operation requires permissions to perform the lookoutvision:DeleteDataset operation.
See also: AWS API Documentation
Request Syntax
response = client.delete_dataset(
ProjectName='string',
DatasetType='string',
ClientToken='string'
)
[REQUIRED]
The name of the project that contains the dataset that you want to delete.
[REQUIRED]
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 .
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.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation.
It might take a few seconds to delete a model. To determine if a model has been deleted, call ListModels and check if the version of the model (ModelVersion ) is in the Models array.
This operation requires permissions to perform the lookoutvision:DeleteModel operation.
See also: AWS API Documentation
Request Syntax
response = client.delete_model(
ProjectName='string',
ModelVersion='string',
ClientToken='string'
)
[REQUIRED]
The name of the project that contains the model that you want to delete.
[REQUIRED]
The version of the model that you want to delete.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ModelArn': 'string'
}
Response Structure
(dict) --
ModelArn (string) --
The Amazon Resource Name (ARN) of the model that was deleted.
Exceptions
Deletes an Amazon Lookout for Vision project.
To delete a project, you must first delete each version of the model associated with the project. To delete a model use the DeleteModel operation.
You also have to delete the dataset(s) associated with the model. For more information, see DeleteDataset . The images referenced by the training and test datasets aren't deleted.
This operation requires permissions to perform the lookoutvision:DeleteProject operation.
See also: AWS API Documentation
Request Syntax
response = client.delete_project(
ProjectName='string',
ClientToken='string'
)
[REQUIRED]
The name of the project to delete.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProjectArn': 'string'
}
Response Structure
(dict) --
ProjectArn (string) --
The Amazon Resource Name (ARN) of the project that was deleted.
Exceptions
Describe an Amazon Lookout for Vision dataset.
This operation requires permissions to perform the lookoutvision:DescribeDataset operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_dataset(
ProjectName='string',
DatasetType='string'
)
[REQUIRED]
The name of the project that contains the dataset that you want to describe.
[REQUIRED]
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
dict
Response Syntax
{
'DatasetDescription': {
'ProjectName': 'string',
'DatasetType': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1),
'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED_ROLLBACK_IN_PROGRESS'|'UPDATE_FAILED_ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED',
'StatusMessage': 'string',
'ImageStats': {
'Total': 123,
'Labeled': 123,
'Normal': 123,
'Anomaly': 123
}
}
}
Response Structure
(dict) --
DatasetDescription (dict) --
The description of the requested dataset.
ProjectName (string) --
The name of the project that contains the dataset.
DatasetType (string) --
The type of the dataset. The value train represents a training dataset or single dataset project. The value test represents a test dataset.
CreationTimestamp (datetime) --
The Unix timestamp for the time and date that the dataset was created.
LastUpdatedTimestamp (datetime) --
The Unix timestamp for the date and time that the dataset was last updated.
Status (string) --
The status of the dataset.
StatusMessage (string) --
The status message for the dataset.
ImageStats (dict) --
Statistics about the images in a dataset.
Total (integer) --
The total number of images in the dataset.
Labeled (integer) --
The total number of labeled images.
Normal (integer) --
The total number of images labeled as normal.
Anomaly (integer) --
the total number of images labeled as an anomaly.
Exceptions
Describes a version of an Amazon Lookout for Vision model.
This operation requires permissions to perform the lookoutvision:DescribeModel operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_model(
ProjectName='string',
ModelVersion='string'
)
[REQUIRED]
The project that contains the version of a model that you want to describe.
[REQUIRED]
The version of the model that you want to describe.
dict
Response Syntax
{
'ModelDescription': {
'ModelVersion': 'string',
'ModelArn': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'Description': 'string',
'Status': 'TRAINING'|'TRAINED'|'TRAINING_FAILED'|'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'|'DELETING',
'StatusMessage': 'string',
'Performance': {
'F1Score': ...,
'Recall': ...,
'Precision': ...
},
'OutputConfig': {
'S3Location': {
'Bucket': 'string',
'Prefix': 'string'
}
},
'EvaluationManifest': {
'Bucket': 'string',
'Key': 'string'
},
'EvaluationResult': {
'Bucket': 'string',
'Key': 'string'
},
'EvaluationEndTimestamp': datetime(2015, 1, 1),
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
ModelDescription (dict) --
Contains the description of the model.
ModelVersion (string) --
The version of the model
ModelArn (string) --
The Amazon Resource Name (ARN) of the model.
CreationTimestamp (datetime) --
The unix timestamp for the date and time that the model was created.
Description (string) --
The description for the model.
Status (string) --
The status of the model.
StatusMessage (string) --
The status message for the model.
Performance (dict) --
Performance metrics for the model. Created during training.
F1Score (float) --
The overall F1 score metric for the trained model.
Recall (float) --
The overall recall metric value for the trained model.
Precision (float) --
The overall precision metric value for the trained model.
OutputConfig (dict) --
The S3 location where Amazon Lookout for Vision saves model training files.
S3Location (dict) --
The S3 location for the output.
Bucket (string) --
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.
Prefix (string) --
The path of the folder, within the S3 bucket, that contains the output.
EvaluationManifest (dict) --
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.
Bucket (string) --
The bucket that contains the training output.
Key (string) --
The location of the training output in the bucket.
EvaluationResult (dict) --
The S3 location where Amazon Lookout for Vision saves the performance metrics.
Bucket (string) --
The bucket that contains the training output.
Key (string) --
The location of the training output in the bucket.
EvaluationEndTimestamp (datetime) --
The unix timestamp for the date and time that the evaluation ended.
KmsKeyId (string) --
The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model during training.
Exceptions
Describes an Amazon Lookout for Vision model packaging job.
This operation requires permissions to perform the lookoutvision:DescribeModelPackagingJob operation.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.describe_model_packaging_job(
ProjectName='string',
JobName='string'
)
[REQUIRED]
The name of the project that contains the model packaging job that you want to describe.
[REQUIRED]
The job name for the model packaging job.
dict
Response Syntax
{
'ModelPackagingDescription': {
'JobName': 'string',
'ProjectName': 'string',
'ModelVersion': 'string',
'ModelPackagingConfiguration': {
'Greengrass': {
'CompilerOptions': 'string',
'TargetDevice': 'jetson_xavier',
'TargetPlatform': {
'Os': 'LINUX',
'Arch': 'ARM64'|'X86_64',
'Accelerator': 'NVIDIA'
},
'S3OutputLocation': {
'Bucket': 'string',
'Prefix': 'string'
},
'ComponentName': 'string',
'ComponentVersion': 'string',
'ComponentDescription': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
},
'ModelPackagingJobDescription': 'string',
'ModelPackagingMethod': 'string',
'ModelPackagingOutputDetails': {
'Greengrass': {
'ComponentVersionArn': 'string',
'ComponentName': 'string',
'ComponentVersion': 'string'
}
},
'Status': 'CREATED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ModelPackagingDescription (dict) --
The description of the model packaging job.
JobName (string) --
The name of the model packaging job.
ProjectName (string) --
The name of the project that's associated with a model that's in the model package.
ModelVersion (string) --
The version of the model used in the model packaging job.
ModelPackagingConfiguration (dict) --
The configuration information used in the model packaging job.
Greengrass (dict) --
Configuration information for the AWS IoT Greengrass component in a model packaging job.
CompilerOptions (string) --
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.
TargetDevice (string) --
The target device for the model. Currently the only supported value is jetson_xavier . If you specify TargetDevice , you can't specify TargetPlatform .
TargetPlatform (dict) --
The target platform for the model. If you specify TargetPlatform , you can't specify TargetDevice .
Os (string) --
The target operating system for the model. Linux is the only operating system that is currently supported.
Arch (string) --
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).
Accelerator (string) --
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.
S3OutputLocation (dict) --
An S3 location in which Lookout for Vision stores the component artifacts.
Bucket (string) --
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.
Prefix (string) --
The path of the folder, within the S3 bucket, that contains the output.
ComponentName (string) --
A name for the AWS IoT Greengrass component.
ComponentVersion (string) --
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.
ComponentDescription (string) --
A description for the AWS IoT Greengrass component.
Tags (list) --
A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.
(dict) --
A key and value pair that is attached to the specified Amazon Lookout for Vision model.
Key (string) --
The key of the tag that is attached to the specified model.
Value (string) --
The value of the tag that is attached to the specified model.
ModelPackagingJobDescription (string) --
The description for the model packaging job.
ModelPackagingMethod (string) --
The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.
ModelPackagingOutputDetails (dict) --
Information about the output of the model packaging job. For more information, see DescribeModelPackagingJob .
Greengrass (dict) --
Information about the AWS IoT Greengrass component in a model packaging job.
ComponentVersionArn (string) --
The Amazon Resource Name (ARN) of the component.
ComponentName (string) --
The name of the component.
ComponentVersion (string) --
The version of the component.
Status (string) --
The status of the model packaging job.
StatusMessage (string) --
The status message for the model packaging job.
CreationTimestamp (datetime) --
The Unix timestamp for the time and date that the model packaging job was created.
LastUpdatedTimestamp (datetime) --
The Unix timestamp for the time and date that the model packaging job was last updated.
Exceptions
Describes an Amazon Lookout for Vision project.
This operation requires permissions to perform the lookoutvision:DescribeProject operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_project(
ProjectName='string'
)
[REQUIRED]
The name of the project that you want to describe.
{
'ProjectDescription': {
'ProjectArn': 'string',
'ProjectName': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'Datasets': [
{
'DatasetType': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED_ROLLBACK_IN_PROGRESS'|'UPDATE_FAILED_ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED',
'StatusMessage': 'string'
},
]
}
}
Response Structure
The description of the project.
The Amazon Resource Name (ARN) of the project.
The name of the project.
The unix timestamp for the date and time that the project was created.
A list of datasets in the project.
Summary information for an Amazon Lookout for Vision dataset. For more information, see DescribeDataset and ProjectDescription .
The type of the dataset.
The Unix timestamp for the date and time that the dataset was created.
The status for the dataset.
The status message for the dataset.
Exceptions
Detects anomalies in an image that you supply.
The response from DetectAnomalies includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction.
Note
Before calling DetectAnomalies , you must first start your model with the StartModel operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your model uses. If you are not using a model, use the StopModel operation to stop your model.
This operation requires permissions to perform the lookoutvision:DetectAnomalies operation.
See also: AWS API Documentation
Request Syntax
response = client.detect_anomalies(
ProjectName='string',
ModelVersion='string',
Body=b'bytes'|file,
ContentType='string'
)
[REQUIRED]
The name of the project that contains the model version that you want to use.
[REQUIRED]
The version of the model that you want to use.
[REQUIRED]
The unencrypted image bytes that you want to analyze.
[REQUIRED]
The type of the image passed in Body . Valid values are image/png (PNG format images) and image/jpeg (JPG format images).
dict
Response Syntax
{
'DetectAnomalyResult': {
'Source': {
'Type': 'string'
},
'IsAnomalous': True|False,
'Confidence': ...
}
}
Response Structure
(dict) --
DetectAnomalyResult (dict) --
The results of the DetectAnomalies operation.
Source (dict) --
The source of the image that was analyzed. direct means that the images was supplied from the local computer. No other values are supported.
Type (string) --
The type of the image.
IsAnomalous (boolean) --
True if the image contains an anomaly, otherwise false.
Confidence (float) --
The confidence that Amazon Lookout for Vision has in the accuracy of the prediction.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.
This operation requires permissions to perform the lookoutvision:ListDatasetEntries operation.
See also: AWS API Documentation
Request Syntax
response = client.list_dataset_entries(
ProjectName='string',
DatasetType='string',
Labeled=True|False,
AnomalyClass='string',
BeforeCreationDate=datetime(2015, 1, 1),
AfterCreationDate=datetime(2015, 1, 1),
NextToken='string',
MaxResults=123,
SourceRefContains='string'
)
[REQUIRED]
The name of the project that contains the dataset that you want to list.
[REQUIRED]
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 .
dict
Response Syntax
{
'DatasetEntries': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
DatasetEntries (list) --
A list of the entries (JSON Lines) within the dataset.
NextToken (string) --
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.
Exceptions
Lists the model packaging jobs created for an Amazon Lookout for Vision project.
This operation requires permissions to perform the lookoutvision:ListModelPackagingJobs operation.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.list_model_packaging_jobs(
ProjectName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the project for which you want to list the model packaging jobs.
dict
Response Syntax
{
'ModelPackagingJobs': [
{
'JobName': 'string',
'ProjectName': 'string',
'ModelVersion': 'string',
'ModelPackagingJobDescription': 'string',
'ModelPackagingMethod': 'string',
'Status': 'CREATED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ModelPackagingJobs (list) --
A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.
(dict) --
Metadata for a model packaging job. For more information, see ListModelPackagingJobs .
JobName (string) --
The name of the model packaging job.
ProjectName (string) --
The project that contains the model that is in the model package.
ModelVersion (string) --
The version of the model that is in the model package.
ModelPackagingJobDescription (string) --
The description for the model packaging job.
ModelPackagingMethod (string) --
The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.
Status (string) --
The status of the model packaging job.
StatusMessage (string) --
The status message for the model packaging job.
CreationTimestamp (datetime) --
The Unix timestamp for the time and date that the model packaging job was created.
LastUpdatedTimestamp (datetime) --
The Unix timestamp for the time and date that the model packaging job was last updated.
NextToken (string) --
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.
Exceptions
Lists the versions of a model in an Amazon Lookout for Vision project.
The ListModels operation is eventually consistent. Recent calls to CreateModel might take a while to appear in the response from ListProjects .
This operation requires permissions to perform the lookoutvision:ListModels operation.
See also: AWS API Documentation
Request Syntax
response = client.list_models(
ProjectName='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the project that contains the model versions that you want to list.
dict
Response Syntax
{
'Models': [
{
'CreationTimestamp': datetime(2015, 1, 1),
'ModelVersion': 'string',
'ModelArn': 'string',
'Description': 'string',
'Status': 'TRAINING'|'TRAINED'|'TRAINING_FAILED'|'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'|'DELETING',
'StatusMessage': 'string',
'Performance': {
'F1Score': ...,
'Recall': ...,
'Precision': ...
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Models (list) --
A list of model versions in the specified project.
(dict) --
Describes an Amazon Lookout for Vision model.
CreationTimestamp (datetime) --
The unix timestamp for the date and time that the model was created.
ModelVersion (string) --
The version of the model.
ModelArn (string) --
The Amazon Resource Name (ARN) of the model.
Description (string) --
The description for the model.
Status (string) --
The status of the model.
StatusMessage (string) --
The status message for the model.
Performance (dict) --
Performance metrics for the model. Not available until training has successfully completed.
F1Score (float) --
The overall F1 score metric for the trained model.
Recall (float) --
The overall recall metric value for the trained model.
Precision (float) --
The overall precision metric value for the trained model.
NextToken (string) --
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.
Exceptions
Lists the Amazon Lookout for Vision projects in your AWS account.
The ListProjects operation is eventually consistent. Recent calls to CreateProject and DeleteProject might take a while to appear in the response from ListProjects .
This operation requires permissions to perform the lookoutvision:ListProjects operation.
See also: AWS API Documentation
Request Syntax
response = client.list_projects(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Projects': [
{
'ProjectArn': 'string',
'ProjectName': 'string',
'CreationTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Projects (list) --
A list of projects in your AWS account.
(dict) --
Metadata about an Amazon Lookout for Vision project.
ProjectArn (string) --
The Amazon Resource Name (ARN) of the project.
ProjectName (string) --
The name of the project.
CreationTimestamp (datetime) --
The unix timestamp for the date and time that the project was created.
NextToken (string) --
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.
Exceptions
Returns a list of tags attached to the specified Amazon Lookout for Vision model.
This operation requires permissions to perform the lookoutvision:ListTagsForResource operation.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the model for which you want to list tags.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A map of tag keys and values attached to the specified model.
A key and value pair that is attached to the specified Amazon Lookout for Vision model.
The key of the tag that is attached to the specified model.
The value of the tag that is attached to the specified model.
Exceptions
Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use DescribeModel .
A model is ready to use when its status is HOSTED .
Once the model is running, you can detect custom labels in new images by calling DetectAnomalies .
Note
You are charged for the amount of time that the model is running. To stop a running model, call StopModel .
This operation requires permissions to perform the lookoutvision:StartModel operation.
See also: AWS API Documentation
Request Syntax
response = client.start_model(
ProjectName='string',
ModelVersion='string',
MinInferenceUnits=123,
ClientToken='string'
)
[REQUIRED]
The name of the project that contains the model that you want to start.
[REQUIRED]
The version of the model that you want to start.
[REQUIRED]
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.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Status': 'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'
}
Response Structure
(dict) --
Status (string) --
The current running status of the model.
Exceptions
Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.
Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job is complete if the value of Status is SUCCEEDED .
To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API.
This operation requires the following permissions:
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.start_model_packaging_job(
ProjectName='string',
ModelVersion='string',
JobName='string',
Configuration={
'Greengrass': {
'CompilerOptions': 'string',
'TargetDevice': 'jetson_xavier',
'TargetPlatform': {
'Os': 'LINUX',
'Arch': 'ARM64'|'X86_64',
'Accelerator': 'NVIDIA'
},
'S3OutputLocation': {
'Bucket': 'string',
'Prefix': 'string'
},
'ComponentName': 'string',
'ComponentVersion': 'string',
'ComponentDescription': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
},
Description='string',
ClientToken='string'
)
[REQUIRED]
The name of the project which contains the version of the model that you want to package.
[REQUIRED]
The version of the model within the project that you want to package.
[REQUIRED]
The configuration for the model packaging job.
Configuration information for the AWS IoT Greengrass component in a model packaging job.
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.
The target device for the model. Currently the only supported value is jetson_xavier . If you specify TargetDevice , you can't specify TargetPlatform .
The target platform for the model. If you specify TargetPlatform , you can't specify TargetDevice .
The target operating system for the model. Linux is the only operating system that is currently supported.
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).
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.
An S3 location in which Lookout for Vision stores the component artifacts.
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.
The path of the folder, within the S3 bucket, that contains the output.
A name for the AWS IoT Greengrass component.
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.
A description for the AWS IoT Greengrass component.
A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.
A key and value pair that is attached to the specified Amazon Lookout for Vision model.
The key of the tag that is attached to the specified model.
The value of the tag that is attached to the specified model.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'JobName': 'string'
}
Response Structure
(dict) --
JobName (string) --
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.
Exceptions
Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel .
After the model hosting stops, the Status of the model is TRAINED .
This operation requires permissions to perform the lookoutvision:StopModel operation.
See also: AWS API Documentation
Request Syntax
response = client.stop_model(
ProjectName='string',
ModelVersion='string',
ClientToken='string'
)
[REQUIRED]
The name of the project that contains the model that you want to stop.
[REQUIRED]
The version of the model that you want to stop.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Status': 'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'
}
Response Structure
(dict) --
Status (string) --
The status of the model.
Exceptions
Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide .
This operation requires permissions to perform the lookoutvision:TagResource operation.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the model to assign the tags.
[REQUIRED]
The key-value tags to assign to the model.
A key and value pair that is attached to the specified Amazon Lookout for Vision model.
The key of the tag that is attached to the specified model.
The value of the tag that is attached to the specified model.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes one or more tags from an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide .
This operation requires permissions to perform the lookoutvision:UntagResource operation.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the model from which you want to remove tags.
[REQUIRED]
A list of the keys of the tags that you want to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model.
To update an existing JSON Line, use the source-ref field to identify the JSON Line. The JSON line that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are removed from the dataset.
For more information, see Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide.
Note
The images you reference in the source-ref field of a JSON line, must be in the same S3 bucket as the existing images in the dataset.
Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and check the Status field in the response.
This operation requires permissions to perform the lookoutvision:UpdateDatasetEntries operation.
See also: AWS API Documentation
Request Syntax
response = client.update_dataset_entries(
ProjectName='string',
DatasetType='string',
Changes=b'bytes',
ClientToken='string'
)
[REQUIRED]
The name of the project that contains the dataset that you want to update.
[REQUIRED]
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 .
[REQUIRED]
The entries to add to the dataset.
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED_ROLLBACK_IN_PROGRESS'|'UPDATE_FAILED_ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'
}
Response Structure
(dict) --
Status (string) --
The status of the dataset update.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_dataset_entries')
Creates an iterator that will paginate through responses from LookoutforVision.Client.list_dataset_entries().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ProjectName='string',
DatasetType='string',
Labeled=True|False,
AnomalyClass='string',
BeforeCreationDate=datetime(2015, 1, 1),
AfterCreationDate=datetime(2015, 1, 1),
SourceRefContains='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the project that contains the dataset that you want to list.
[REQUIRED]
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 .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DatasetEntries': [
'string',
],
}
Response Structure
(dict) --
DatasetEntries (list) --
A list of the entries (JSON Lines) within the dataset.
paginator = client.get_paginator('list_model_packaging_jobs')
Creates an iterator that will paginate through responses from LookoutforVision.Client.list_model_packaging_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ProjectName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the project for which you want to list the model packaging jobs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ModelPackagingJobs': [
{
'JobName': 'string',
'ProjectName': 'string',
'ModelVersion': 'string',
'ModelPackagingJobDescription': 'string',
'ModelPackagingMethod': 'string',
'Status': 'CREATED'|'RUNNING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'CreationTimestamp': datetime(2015, 1, 1),
'LastUpdatedTimestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
ModelPackagingJobs (list) --
A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.
(dict) --
Metadata for a model packaging job. For more information, see ListModelPackagingJobs .
JobName (string) --
The name of the model packaging job.
ProjectName (string) --
The project that contains the model that is in the model package.
ModelVersion (string) --
The version of the model that is in the model package.
ModelPackagingJobDescription (string) --
The description for the model packaging job.
ModelPackagingMethod (string) --
The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.
Status (string) --
The status of the model packaging job.
StatusMessage (string) --
The status message for the model packaging job.
CreationTimestamp (datetime) --
The Unix timestamp for the time and date that the model packaging job was created.
LastUpdatedTimestamp (datetime) --
The Unix timestamp for the time and date that the model packaging job was last updated.
paginator = client.get_paginator('list_models')
Creates an iterator that will paginate through responses from LookoutforVision.Client.list_models().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ProjectName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the project that contains the model versions that you want to list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Models': [
{
'CreationTimestamp': datetime(2015, 1, 1),
'ModelVersion': 'string',
'ModelArn': 'string',
'Description': 'string',
'Status': 'TRAINING'|'TRAINED'|'TRAINING_FAILED'|'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'|'DELETING',
'StatusMessage': 'string',
'Performance': {
'F1Score': ...,
'Recall': ...,
'Precision': ...
}
},
],
}
Response Structure
(dict) --
Models (list) --
A list of model versions in the specified project.
(dict) --
Describes an Amazon Lookout for Vision model.
CreationTimestamp (datetime) --
The unix timestamp for the date and time that the model was created.
ModelVersion (string) --
The version of the model.
ModelArn (string) --
The Amazon Resource Name (ARN) of the model.
Description (string) --
The description for the model.
Status (string) --
The status of the model.
StatusMessage (string) --
The status message for the model.
Performance (dict) --
Performance metrics for the model. Not available until training has successfully completed.
F1Score (float) --
The overall F1 score metric for the trained model.
Recall (float) --
The overall recall metric value for the trained model.
Precision (float) --
The overall precision metric value for the trained model.
paginator = client.get_paginator('list_projects')
Creates an iterator that will paginate through responses from LookoutforVision.Client.list_projects().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Projects': [
{
'ProjectArn': 'string',
'ProjectName': 'string',
'CreationTimestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
A list of projects in your AWS account.
Metadata about an Amazon Lookout for Vision project.
The Amazon Resource Name (ARN) of the project.
The name of the project.
The unix timestamp for the date and time that the project was created.