(constructor)

[configuration]

Constructs a new instance of the <code>LookoutVisionClient</code> class

config

The resolved configuration of LookoutVisionClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-lookoutvision!LookoutVisionClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

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.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

CreateDatasetCommand

Creates a new dataset in an Amazon Lookout for Vision project. <code>CreateDataset</code> can create a training or a test dataset from a valid dataset source (<code>DatasetSource</code>). If you want a single dataset project, specify <code>train</code> for the value of <code>DatasetType</code>. To have a project with separate training and test datasets, call <code>CreateDataset</code> twice. On the first call, specify <code>train</code> for the value of <code>DatasetType</code>. On the second call, specify <code>test</code> for the value of <code>DatasetType</code>. This operation requires permissions to perform the <code>lookoutvision:CreateDataset</code> operation.

CreateModelCommand

Creates a new version of a model within an an Amazon Lookout for Vision project. <code>CreateModel</code> 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 <code>Status</code> 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 <code>OutputConfig</code>. This operation requires permissions to perform the <code>lookoutvision:CreateModel</code> operation. If you want to tag your model, you also require permission to the <code>lookoutvision:TagResource</code> operation.

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 <code>lookoutvision:CreateProject</code> operation.

DeleteDatasetCommand

Deletes an existing Amazon Lookout for Vision <code>dataset</code>. 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. <ul> <li> If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset. </li> <li> If you delete the training dataset, you must create a training dataset before you can create a model. </li> </ul> This operation requires permissions to perform the <code>lookoutvision:DeleteDataset</code> operation.

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 (<code>ModelVersion</code>) is in the <code>Models</code> array. This operation requires permissions to perform the <code>lookoutvision:DeleteModel</code> operation.

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 <code>lookoutvision:DeleteProject</code> operation.

DescribeDatasetCommand

Describe an Amazon Lookout for Vision dataset. This operation requires permissions to perform the <code>lookoutvision:DescribeDataset</code> operation.

DescribeModelCommand

Describes a version of an Amazon Lookout for Vision model. This operation requires permissions to perform the <code>lookoutvision:DescribeModel</code> operation.

DescribeModelPackagingJobCommand

Describes an Amazon Lookout for Vision model packaging job. This operation requires permissions to perform the <code>lookoutvision:DescribeModelPackagingJob</code> operation. 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 <code>lookoutvision:DescribeProject</code> operation.

DetectAnomaliesCommand

Detects anomalies in an image that you supply. The response from <code>DetectAnomalies</code> includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction. If the model is an image segmentation model, the response also includes segmentation information for each type of anomaly found in the image. <note> Before calling <code>DetectAnomalies</code>, 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. </note> For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer guide. This operation requires permissions to perform the <code>lookoutvision:DetectAnomalies</code> operation.

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 <code>lookoutvision:ListDatasetEntries</code> operation.

ListModelPackagingJobsCommand

Lists the model packaging jobs created for an Amazon Lookout for Vision project. This operation requires permissions to perform the <code>lookoutvision:ListModelPackagingJobs</code> operation. 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 <code>ListModels</code> operation is eventually consistent. Recent calls to <code>CreateModel</code> might take a while to appear in the response from <code>ListProjects</code>. This operation requires permissions to perform the <code>lookoutvision:ListModels</code> operation.

ListProjectsCommand

Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call <code>ListProjects</code>. The <code>ListProjects</code> operation is eventually consistent. Recent calls to <code>CreateProject</code> and <code>DeleteProject</code> might take a while to appear in the response from <code>ListProjects</code>. This operation requires permissions to perform the <code>lookoutvision:ListProjects</code> operation.

ListTagsForResourceCommand

Returns a list of tags attached to the specified Amazon Lookout for Vision model. This operation requires permissions to perform the <code>lookoutvision:ListTagsForResource</code> operation.

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 <code>HOSTED</code>. 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. </note> This operation requires permissions to perform the <code>lookoutvision:StartModel</code> operation.

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 <code>Status</code> is <code>SUCCEEDED</code>. To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_CreateDeployment.html">CreateDeployment</a> API. This operation requires the following permissions: <ul> <li> <code>lookoutvision:StartModelPackagingJob</code> </li> <li> <code>s3:PutObject</code> </li> <li> <code>s3:GetBucketLocation</code> </li> <li> <code>kms:GenerateDataKey</code> </li> <li> <code>greengrass:CreateComponentVersion</code> </li> <li> <code>greengrass:DescribeComponent</code> </li> <li> (Optional) <code>greengrass:TagResource</code>. Only required if you want to tag the component. </li> </ul> 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 <code>Status</code> of the model is <code>TRAINED</code>. This operation requires permissions to perform the <code>lookoutvision:StopModel</code> operation.

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 <code>lookoutvision:TagResource</code> operation.

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 <code>lookoutvision:UntagResource</code> operation.

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 <code>source-ref</code> 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 <code>source-ref</code> field of a JSON line, must be in the same S3 bucket as the existing images in the dataset. </note> Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and check the <code>Status</code> field in the response. This operation requires permissions to perform the <code>lookoutvision:UpdateDatasetEntries</code> operation.