libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LookoutVision.DetectAnomalies

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.

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.

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

Synopsis

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
Show DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Generic DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Associated Types

type Rep DetectAnomalies :: Type -> Type #

AWSRequest DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Associated Types

type AWSResponse DetectAnomalies #

ToBody DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

ToHeaders DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

ToPath DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

ToQuery DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

type Rep DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

type Rep DetectAnomalies = D1 ('MetaData "DetectAnomalies" "Amazonka.LookoutVision.DetectAnomalies" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" '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))))
type AWSResponse DetectAnomalies Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

newDetectAnomalies Source #

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:

$sel:projectName:DetectAnomalies', detectAnomalies_projectName - The name of the project that contains the model version that you want to use.

$sel:modelVersion: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

Instances

Instances details
Eq DetectAnomaliesResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Read DetectAnomaliesResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Show DetectAnomaliesResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Generic DetectAnomaliesResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Associated Types

type Rep DetectAnomaliesResponse :: Type -> Type #

NFData DetectAnomaliesResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

Methods

rnf :: DetectAnomaliesResponse -> () #

type Rep DetectAnomaliesResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.DetectAnomalies

type Rep DetectAnomaliesResponse = D1 ('MetaData "DetectAnomaliesResponse" "Amazonka.LookoutVision.DetectAnomalies" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" '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 #

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