DetectAnomalies
Important
End of support notice: On October 31, 2025, AWS
will discontinue support for Amazon Lookout for Vision. After October 31, 2025, you will
no longer be able to access the Lookout for Vision console or Lookout for Vision resources.
For more information, visit this
blog post
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.
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.
For more information, see Detecting anomalies in an image.
This operation requires permissions to perform the
lookoutvision:DetectAnomalies operation.
Request Syntax
POST /2020-11-20/projects/projectName/models/modelVersion/detect HTTP/1.1
Content-Type: ContentType
BodyURI Request Parameters
The request uses the following URI parameters.
- ContentType
-
The type of the image passed in
Body. Valid values areimage/png(PNG format images) andimage/jpeg(JPG format images).Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
.*Required: Yes
- modelVersion
-
The version of the model that you want to use.
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern:
([1-9][0-9]*|latest)Required: Yes
- projectName
-
The name of the project that contains the model version that you want to use.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_\-]*Required: Yes
Request Body
The request accepts the following binary data.
- Body
-
The unencrypted image bytes that you want to analyze.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DetectAnomalyResult": {
"Anomalies": [
{
"Name": "string",
"PixelAnomaly": {
"Color": "string",
"TotalPercentageArea": number
}
}
],
"AnomalyMask": blob,
"Confidence": number,
"IsAnomalous": boolean,
"Source": {
"Type": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DetectAnomalyResult
-
The results of the
DetectAnomaliesoperation.Type: DetectAnomalyResult object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 403
- ConflictException
-
The update or deletion of a resource caused an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Amazon Lookout for Vision experienced a service issue. Try your call again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.
HTTP Status Code: 429
- ValidationException
-
An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
