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."
},
{
"info": {
"name": "Amazon Lookout for Vision List Models",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://lookoutvision.{region}.amazonaws.com/2020-11-20/projects/:projectName/models",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "projectName",
"value": "",
"type": "path",
"description": "The name of the project that contains the model versions that you want to list."
},
{
"name": "nextToken",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "MaxResults",
"value": "",
"type": "query",
"description": "Pagination limit"
},
{
"name": "NextToken",
"value": "",
"type": "query",
"description": "Pagination token"
}
]
},
"docs": "
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.
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 p" }, { "info": { "name": "Amazon Lookout for Vision List Projects", "type": "http" }, "http": { "method": "GET", "url": "http://lookoutvision.{region}.amazonaws.com/2020-11-20/projects", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "nextToken", "value": "", "type": "query", "description": "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." }, { "name": "maxResults", "value": "", "type": "query", "description": "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." }, { "name": "MaxResults", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "NextToken", "value": "", "type": "query", "description": "Pagination token" } ] }, "docs": "
Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects.
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.
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.
train to describe the training dataset. Specify test to describe the test dataset. If you have a single dataset project, specify train "
}
]
},
"docs": "Describe an Amazon Lookout for Vision dataset.
This operation requires permissions to perform the lookoutvision:DescribeDataset operation.
train to delete the training dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset project, specify train."
}
]
},
"docs": "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.
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.Describes a version of an Amazon Lookout for Vision model.
This operation requires permissions to perform the lookoutvision:DescribeModel operation.
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.
Describes an Amazon Lookout for Vision project.
This operation requires permissions to perform the lookoutvision:DescribeProject operation.
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:DeleteProjectDescribes 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.
" }, { "info": { "name": "Amazon Lookout for Vision Detect Anomalies", "type": "http" }, "http": { "method": "POST", "url": "http://lookoutvision.{region}.amazonaws.com/2020-11-20/projects/:projectName/models/:modelVersion/detect#Content-Type", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "projectName", "value": "", "type": "path", "description": "The name of the project that contains the model version that you want to use." }, { "name": "modelVersion", "value": "", "type": "path", "description": "The version of the model that you want to use." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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. If the model is an image segmentation model, the response also includes segmentation information for each type of anomaly found in the image.
Before calling DetectAnomalies, you must first start your model with the StartModel operation. You a"
},
{
"info": {
"name": "Amazon Lookout for Vision List Dataset Entries",
"type": "http"
},
"http": {
"method": "GET",
"url": "http://lookoutvision.{region}.amazonaws.com/2020-11-20/projects/:projectName/datasets/:datasetType/entries",
"headers": [
{
"name": "X-Amz-Content-Sha256",
"value": ""
},
{
"name": "X-Amz-Date",
"value": ""
},
{
"name": "X-Amz-Algorithm",
"value": ""
},
{
"name": "X-Amz-Credential",
"value": ""
},
{
"name": "X-Amz-Security-Token",
"value": ""
},
{
"name": "X-Amz-Signature",
"value": ""
},
{
"name": "X-Amz-SignedHeaders",
"value": ""
}
],
"params": [
{
"name": "projectName",
"value": "",
"type": "path",
"description": "The name of the project that contains the dataset that you want to list."
},
{
"name": "datasetType",
"value": "",
"type": "path",
"description": "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."
},
{
"name": "labeled",
"value": "",
"type": "query",
"description": "Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries."
},
{
"name": "anomalyClass",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "createdBefore",
"value": "",
"type": "query",
"description": "Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00."
},
{
"name": "createdAfter",
"value": "",
"type": "query",
"description": "Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00."
},
{
"name": "nextToken",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "sourceRefContains",
"value": "",
"type": "query",
"description": "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*."
},
{
"name": "MaxResults",
"value": "",
"type": "query",
"description": "Pagination limit"
},
{
"name": "NextToken",
"value": "",
"type": "query",
"description": "Pagination token"
}
]
},
"docs": "
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.
train to update the training dataset. Specify test to update the test dataset. If you have a single dataset project, specify train."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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 anomal" }, { "info": { "name": "Amazon Lookout for Vision List Model Packaging Jobs", "type": "http" }, "http": { "method": "GET", "url": "http://lookoutvision.{region}.amazonaws.com/2020-11-20/projects/:projectName/modelpackagingjobs", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" } ], "params": [ { "name": "projectName", "value": "", "type": "path", "description": " The name of the project for which you want to list the model packaging jobs. " }, { "name": "nextToken", "value": "", "type": "query", "description": "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. " }, { "name": "maxResults", "value": "", "type": "query", "description": "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. " }, { "name": "MaxResults", "value": "", "type": "query", "description": "Pagination limit" }, { "name": "NextToken", "value": "", "type": "query", "description": "Pagination token" } ] }, "docs": "
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.
" }, { "info": { "name": "Amazon Lookout for Vision Start Model Packaging Job", "type": "http" }, "http": { "method": "POST", "url": "http://lookoutvision.{region}.amazonaws.com/2020-11-20/projects/:projectName/modelpackagingjobs", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" }, { "name": "X-Amzn-Client-Token", "value": "" } ], "params": [ { "name": "projectName", "value": "", "type": "path", "description": " The name of the project which contains the version of the model that you want to package. " } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 c" }, { "info": { "name": "Amazon Lookout for Vision Start Model", "type": "http" }, "http": { "method": "POST", "url": "http://lookoutvision.{region}.amazonaws.com/2020-11-20/projects/:projectName/models/:modelVersion/start", "headers": [ { "name": "X-Amz-Content-Sha256", "value": "" }, { "name": "X-Amz-Date", "value": "" }, { "name": "X-Amz-Algorithm", "value": "" }, { "name": "X-Amz-Credential", "value": "" }, { "name": "X-Amz-Security-Token", "value": "" }, { "name": "X-Amz-Signature", "value": "" }, { "name": "X-Amz-SignedHeaders", "value": "" }, { "name": "X-Amzn-Client-Token", "value": "" } ], "params": [ { "name": "projectName", "value": "", "type": "path", "description": "The name of the project that contains the model that you want to start." }, { "name": "modelVersion", "value": "", "type": "path", "description": "The version of the model that you want to start." } ], "body": { "type": "json", "data": "{}" } }, "docs": "
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.
You are charged for the amount of time that the model is running. To stop a running model, call StopModel.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.