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.FraudDetector.UpdateDetectorVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.

Synopsis

Creating a Request

data UpdateDetectorVersion Source #

See: newUpdateDetectorVersion smart constructor.

Constructors

UpdateDetectorVersion'

Fields

description :: Maybe Text
The detector version description.
modelVersions :: Maybe [ModelVersion]
The model versions to include in the detector version.
ruleExecutionMode :: Maybe RuleExecutionMode
The rule execution mode to add to the detector.
If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.
If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.
The default behavior is FIRST_MATCHED.
detectorId :: Text
The parent detector ID for the detector version you want to update.
detectorVersionId :: Text
The detector version ID.
externalModelEndpoints :: [Text]
The Amazon SageMaker model endpoints to include in the detector version.
rules :: [Rule]
The rules to include in the detector version.

Instances

Instances details

ToJSON UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods toJSON :: UpdateDetectorVersion -> Value # toEncoding :: UpdateDetectorVersion -> Encoding # toJSONList :: [UpdateDetectorVersion] -> Value # toEncodingList :: [UpdateDetectorVersion] -> Encoding #
ToHeaders UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods toHeaders :: UpdateDetectorVersion -> [Header] #
ToPath UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods toPath :: UpdateDetectorVersion -> ByteString #
ToQuery UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods toQuery :: UpdateDetectorVersion -> QueryString #
AWSRequest UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Associated Types type AWSResponse UpdateDetectorVersion # Methods request :: (Service -> Service) -> UpdateDetectorVersion -> Request UpdateDetectorVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDetectorVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDetectorVersion))) #
Generic UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Associated Types type Rep UpdateDetectorVersion :: Type -> Type # Methods from :: UpdateDetectorVersion -> Rep UpdateDetectorVersion x # to :: Rep UpdateDetectorVersion x -> UpdateDetectorVersion #
Read UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods readsPrec :: Int -> ReadS UpdateDetectorVersion # readList :: ReadS [UpdateDetectorVersion] # readPrec :: ReadPrec UpdateDetectorVersion # readListPrec :: ReadPrec [UpdateDetectorVersion] #
Show UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods showsPrec :: Int -> UpdateDetectorVersion -> ShowS # show :: UpdateDetectorVersion -> String # showList :: [UpdateDetectorVersion] -> ShowS #
NFData UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods rnf :: UpdateDetectorVersion -> () #
Eq UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods (==) :: UpdateDetectorVersion -> UpdateDetectorVersion -> Bool # (/=) :: UpdateDetectorVersion -> UpdateDetectorVersion -> Bool #
Hashable UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion Methods hashWithSalt :: Int -> UpdateDetectorVersion -> Int # hash :: UpdateDetectorVersion -> Int #
type AWSResponse UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion type AWSResponse UpdateDetectorVersion = UpdateDetectorVersionResponse
type Rep UpdateDetectorVersion Source #
Instance details Defined in Amazonka.FraudDetector.UpdateDetectorVersion type Rep UpdateDetectorVersion = D1 ('MetaData "UpdateDetectorVersion" "Amazonka.FraudDetector.UpdateDetectorVersion" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "UpdateDetectorVersion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "modelVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ModelVersion])) :: S1 ('MetaSel ('Just "ruleExecutionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleExecutionMode)))) :: ((S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "detectorVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "externalModelEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Rule])))))

newUpdateDetectorVersion Source #

Arguments

:: Text	`UpdateDetectorVersion`
-> Text	`UpdateDetectorVersion`
-> UpdateDetectorVersion

Create a value of UpdateDetectorVersion 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:

UpdateDetectorVersion, updateDetectorVersion_description - The detector version description.

$sel:modelVersions:UpdateDetectorVersion', updateDetectorVersion_modelVersions - The model versions to include in the detector version.

$sel:ruleExecutionMode:UpdateDetectorVersion', updateDetectorVersion_ruleExecutionMode - The rule execution mode to add to the detector.

If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

The default behavior is FIRST_MATCHED.

UpdateDetectorVersion, updateDetectorVersion_detectorId - The parent detector ID for the detector version you want to update.

UpdateDetectorVersion, updateDetectorVersion_detectorVersionId - The detector version ID.

$sel:externalModelEndpoints:UpdateDetectorVersion', updateDetectorVersion_externalModelEndpoints - The Amazon SageMaker model endpoints to include in the detector version.

$sel:rules:UpdateDetectorVersion', updateDetectorVersion_rules - The rules to include in the detector version.

Request Lenses

updateDetectorVersion_description :: Lens' UpdateDetectorVersion (Maybe Text) Source #

The detector version description.

updateDetectorVersion_modelVersions :: Lens' UpdateDetectorVersion (Maybe [ModelVersion]) Source #

The model versions to include in the detector version.

updateDetectorVersion_ruleExecutionMode :: Lens' UpdateDetectorVersion (Maybe RuleExecutionMode) Source #

The rule execution mode to add to the detector.

If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

The default behavior is FIRST_MATCHED.

updateDetectorVersion_detectorId :: Lens' UpdateDetectorVersion Text Source #

The parent detector ID for the detector version you want to update.

updateDetectorVersion_detectorVersionId :: Lens' UpdateDetectorVersion Text Source #

The detector version ID.

updateDetectorVersion_externalModelEndpoints :: Lens' UpdateDetectorVersion [Text] Source #

The Amazon SageMaker model endpoints to include in the detector version.

updateDetectorVersion_rules :: Lens' UpdateDetectorVersion [Rule] Source #

The rules to include in the detector version.

Destructuring the Response

data UpdateDetectorVersionResponse Source #

See: newUpdateDetectorVersionResponse smart constructor.

Constructors

UpdateDetectorVersionResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateDetectorVersionResponse Source #

Arguments

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

Create a value of UpdateDetectorVersionResponse 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:httpStatus:UpdateDetectorVersionResponse', updateDetectorVersionResponse_httpStatus - The response's http status code.

Response Lenses

updateDetectorVersionResponse_httpStatus :: Lens' UpdateDetectorVersionResponse Int Source #

The response's http status code.