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…
AI & machine learning#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 22
- POSTCreateDataset
/2020-11-20/projects/:projectName/datasets<p>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… - GETListModels
/2020-11-20/projects/:projectName/models?nextToken=string&maxResults=1&MaxResults=string&NextToken=string<p>Lists the versions of a model in an Amazon Lookout for Vision project.</p> <p>The <code>ListModels</code> operation is eventually consistent. Recent calls… - POSTCreateModel
/2020-11-20/projects/:projectName/models<p>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… - GETListProjects
/2020-11-20/projects?nextToken=string&maxResults=1&MaxResults=string&NextToken=string<p>Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call <code>ListProjects</code>.</p> <p>The… - POSTCreateProject
/2020-11-20/projects<p>Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling <a>CreateDataset</a>.</p> <p>This operation… - GETDescribeDataset
/2020-11-20/projects/:projectName/datasets/:datasetType<p>Describe an Amazon Lookout for Vision dataset.</p> <p>This operation requires permissions to perform the <code>lookoutvision:DescribeDataset</code>… - DELETEDeleteDataset
/2020-11-20/projects/:projectName/datasets/:datasetType<p>Deletes an existing Amazon Lookout for Vision <code>dataset</code>. </p> <p>If your the project has a single dataset, you must create a new dataset before… - GETDescribeModel
/2020-11-20/projects/:projectName/models/:modelVersion<p>Describes a version of an Amazon Lookout for Vision model.</p> <p>This operation requires permissions to perform the… - DELETEDeleteModel
/2020-11-20/projects/:projectName/models/:modelVersion<p>Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the <a>StopModel</a> operation.</p> <p>It might… - GETDescribeProject
/2020-11-20/projects/:projectName<p>Describes an Amazon Lookout for Vision project.</p> <p>This operation requires permissions to perform the <code>lookoutvision:DescribeProject</code>… - DELETEDeleteProject
/2020-11-20/projects/:projectName<p>Deletes an Amazon Lookout for Vision project.</p> <p>To delete a project, you must first delete each version of the model associated with the project. To… - GETDescribeModelPackagingJob
/2020-11-20/projects/:projectName/modelpackagingjobs/:jobName<p>Describes an Amazon Lookout for Vision model packaging job. </p> <p>This operation requires permissions to perform the… - POSTDetectAnomalies
/2020-11-20/projects/:projectName/models/:modelVersion/detect#Content-Type<p>Detects anomalies in an image that you supply. </p> <p>The response from <code>DetectAnomalies</code> includes a boolean prediction that the image contains… - GETListDatasetEntries
/2020-11-20/projects/:projectName/datasets/:datasetType/entries?labeled=true&anomalyClass=string&createdBefore=2024-01-01T00:00:00Z&createdAfter=2024-01-01T00:00:00Z&nextToken=string&maxResults=1&sourceRefContains=string&MaxResults=string&NextToken=string<p>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… - PATCHUpdateDatasetEntries
/2020-11-20/projects/:projectName/datasets/:datasetType/entries<p>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… - GETListModelPackagingJobs
/2020-11-20/projects/:projectName/modelpackagingjobs?nextToken=string&maxResults=1&MaxResults=string&NextToken=string<p> Lists the model packaging jobs created for an Amazon Lookout for Vision project. </p> <p>This operation requires permissions to perform the… - POSTStartModelPackagingJob
/2020-11-20/projects/:projectName/modelpackagingjobs<p>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… - GETListTagsForResource
/2020-11-20/tags/:resourceArn<p>Returns a list of tags attached to the specified Amazon Lookout for Vision model.</p> <p>This operation requires permissions to perform the… - POSTTagResource
/2020-11-20/tags/:resourceArn<p>Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see <i>Tagging a model</i> in the <i>Amazon Lookout for Vision… - POSTStartModel
/2020-11-20/projects/:projectName/models/:modelVersion/start<p>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… - POSTStopModel
/2020-11-20/projects/:projectName/models/:modelVersion/stop<p>Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call <a>DescribeModel</a>. </p> <p>After… - DELETEUntagResource
/2020-11-20/tags/:resourceArn#tagKeys?tagKeys=string<p>Removes one or more tags from an Amazon Lookout for Vision model. For more information, see <i>Tagging a model</i> in the <i>Amazon Lookout for Vision…
API details
- Base URL
http://lookoutvision.{region}.amazonaws.comhttps://lookoutvision.{region}.amazonaws.comhttp://lookoutvision.{region}.amazonaws.com.cnhttps://lookoutvision.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 22 operations on 14 pathsGET 9POST 8DELETE 4PATCH 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2020-11-20 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Amazon Lookout for Vision in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Lookout for Vision collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “CreateDataset” (POST /2020-11-20/projects/:projectName/datasets), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under AI & machine learning and has 22 endpoints.
Who publishes the Amazon Lookout for Vision?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Lookout for Vision?
Its description lists 4 base URLs: http://lookoutvision.{region}.amazonaws.com, https://lookoutvision.{region}.amazonaws.com, http://lookoutvision.{region}.amazonaws.com.cn, https://lookoutvision.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Amazon Lookout for Vision?
With an API key in the Authorization header.
How many endpoints does the Amazon Lookout for Vision have?
22 operations on 14 paths (9 GET, 8 POST, 4 DELETE, 1 PATCH).
Is forking the Amazon Lookout for Vision free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.