- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
LookoutVisionClient
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.
Installation
npm install @aws-sdk/client-lookoutvision
yarn add @aws-sdk/client-lookoutvision
pnpm add @aws-sdk/client-lookoutvision
LookoutVisionClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateDatasetCommand | Creates a new dataset in an Amazon Lookout for Vision project. If you want a single dataset project, specify To have a project with separate training and test datasets, call This operation requires permissions to perform the |
CreateModelCommand | Creates a new version of a model within an an Amazon Lookout for Vision project. To get the current status, check the 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 This operation requires permissions to perform the |
CreateProjectCommand | 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 |
DeleteDatasetCommand | Deletes an existing Amazon Lookout for Vision 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 |
DeleteModelCommand | 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 ( This operation requires permissions to perform the |
DeleteProjectCommand | 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 |
DescribeDatasetCommand | Describe an Amazon Lookout for Vision dataset. This operation requires permissions to perform the |
DescribeModelCommand | Describes a version of an Amazon Lookout for Vision model. This operation requires permissions to perform the |
DescribeModelPackagingJobCommand | Describes an Amazon Lookout for Vision model packaging job. This operation requires permissions to perform the For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide. |
DescribeProjectCommand | Describes an Amazon Lookout for Vision project. This operation requires permissions to perform the |
DetectAnomaliesCommand | Detects anomalies in an image that you supply. The response from Before calling For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer guide. This operation requires permissions to perform the |
ListDatasetEntriesCommand | 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 |
ListModelPackagingJobsCommand | Lists the model packaging jobs created for an Amazon Lookout for Vision project. This operation requires permissions to perform the For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide. |
ListModelsCommand | Lists the versions of a model in an Amazon Lookout for Vision project. The This operation requires permissions to perform the |
ListProjectsCommand | Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call The This operation requires permissions to perform the |
ListTagsForResourceCommand | Returns a list of tags attached to the specified Amazon Lookout for Vision model. This operation requires permissions to perform the |
StartModelCommand | 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 Once the model is running, you can detect custom labels in new images by calling DetectAnomalies. 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 |
StartModelPackagingJobCommand | 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 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. |
StopModelCommand | 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 This operation requires permissions to perform the |
TagResourceCommand | 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 |
UntagResourceCommand | 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 |
UpdateDatasetEntriesCommand | 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 For more information, see Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide. The images you reference in the Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and check the This operation requires permissions to perform the |
LookoutVisionClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: LookoutVisionClientConfig