Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LookoutVision.DetectAnomalies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 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 in the Amazon Lookout for Vision developer guide.

This operation requires permissions to perform the lookoutvision:DetectAnomalies operation.

Creating a Request

data DetectAnomalies Source #

See: newDetectAnomalies smart constructor.

Constructors

DetectAnomalies'
Fields projectName :: Text The name of the project that contains the model version that you want to use. modelVersion :: Text The version of the model that you want to use. contentType :: Text The type of the image passed in `Body`. Valid values are `image/png` (PNG format images) and `image/jpeg` (JPG format images). body :: HashedBody The unencrypted image bytes that you want to analyze.

Instances

Instances details

ToBody DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods toBody :: DetectAnomalies -> RequestBody #
ToHeaders DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods toHeaders :: DetectAnomalies -> [Header] #
ToPath DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods toPath :: DetectAnomalies -> ByteString #
ToQuery DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods toQuery :: DetectAnomalies -> QueryString #
AWSRequest DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Associated Types type AWSResponse DetectAnomalies # Methods request :: (Service -> Service) -> DetectAnomalies -> Request DetectAnomalies # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DetectAnomalies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DetectAnomalies))) #
Generic DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Associated Types type Rep DetectAnomalies :: Type -> Type # Methods from :: DetectAnomalies -> Rep DetectAnomalies x # to :: Rep DetectAnomalies x -> DetectAnomalies #
Show DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods showsPrec :: Int -> DetectAnomalies -> ShowS # show :: DetectAnomalies -> String # showList :: [DetectAnomalies] -> ShowS #
type AWSResponse DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies type AWSResponse DetectAnomalies = DetectAnomaliesResponse
type Rep DetectAnomalies Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies type Rep DetectAnomalies = D1 ('MetaData "DetectAnomalies" "Amazonka.LookoutVision.DetectAnomalies" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "DetectAnomalies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "modelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HashedBody))))

newDetectAnomalies Source #

Arguments

:: Text	`DetectAnomalies`
-> Text	`DetectAnomalies`
-> Text	`$sel:contentType:DetectAnomalies'`
-> HashedBody	`$sel:body:DetectAnomalies'`
-> DetectAnomalies

Create a value of DetectAnomalies with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DetectAnomalies, detectAnomalies_projectName - The name of the project that contains the model version that you want to use.

DetectAnomalies, detectAnomalies_modelVersion - The version of the model that you want to use.

$sel:contentType:DetectAnomalies', detectAnomalies_contentType - The type of the image passed in Body. Valid values are image/png (PNG format images) and image/jpeg (JPG format images).

$sel:body:DetectAnomalies', detectAnomalies_body - The unencrypted image bytes that you want to analyze.

Request Lenses

detectAnomalies_projectName :: Lens' DetectAnomalies Text Source #

The name of the project that contains the model version that you want to use.

detectAnomalies_modelVersion :: Lens' DetectAnomalies Text Source #

The version of the model that you want to use.

detectAnomalies_contentType :: Lens' DetectAnomalies Text Source #

The type of the image passed in Body. Valid values are image/png (PNG format images) and image/jpeg (JPG format images).

detectAnomalies_body :: Lens' DetectAnomalies HashedBody Source #

The unencrypted image bytes that you want to analyze.

Destructuring the Response

data DetectAnomaliesResponse Source #

See: newDetectAnomaliesResponse smart constructor.

Constructors

DetectAnomaliesResponse'
Fields detectAnomalyResult :: Maybe DetectAnomalyResult The results of the `DetectAnomalies` operation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DetectAnomaliesResponse Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Associated Types type Rep DetectAnomaliesResponse :: Type -> Type # Methods from :: DetectAnomaliesResponse -> Rep DetectAnomaliesResponse x # to :: Rep DetectAnomaliesResponse x -> DetectAnomaliesResponse #
Read DetectAnomaliesResponse Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods readsPrec :: Int -> ReadS DetectAnomaliesResponse # readList :: ReadS [DetectAnomaliesResponse] # readPrec :: ReadPrec DetectAnomaliesResponse # readListPrec :: ReadPrec [DetectAnomaliesResponse] #
Show DetectAnomaliesResponse Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods showsPrec :: Int -> DetectAnomaliesResponse -> ShowS # show :: DetectAnomaliesResponse -> String # showList :: [DetectAnomaliesResponse] -> ShowS #
NFData DetectAnomaliesResponse Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods rnf :: DetectAnomaliesResponse -> () #
Eq DetectAnomaliesResponse Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies Methods (==) :: DetectAnomaliesResponse -> DetectAnomaliesResponse -> Bool # (/=) :: DetectAnomaliesResponse -> DetectAnomaliesResponse -> Bool #
type Rep DetectAnomaliesResponse Source #
Instance details Defined in Amazonka.LookoutVision.DetectAnomalies type Rep DetectAnomaliesResponse = D1 ('MetaData "DetectAnomaliesResponse" "Amazonka.LookoutVision.DetectAnomalies" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "DetectAnomaliesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "detectAnomalyResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetectAnomalyResult)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetectAnomaliesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DetectAnomaliesResponse'`
-> DetectAnomaliesResponse

Create a value of DetectAnomaliesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:detectAnomalyResult:DetectAnomaliesResponse', detectAnomaliesResponse_detectAnomalyResult - The results of the DetectAnomalies operation.

$sel:httpStatus:DetectAnomaliesResponse', detectAnomaliesResponse_httpStatus - The response's http status code.

Response Lenses

detectAnomaliesResponse_detectAnomalyResult :: Lens' DetectAnomaliesResponse (Maybe DetectAnomalyResult) Source #

The results of the DetectAnomalies operation.

detectAnomaliesResponse_httpStatus :: Lens' DetectAnomaliesResponse Int Source #

The response's http status code.