amazonka-frauddetector-2.0: Amazon Fraud Detector SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FraudDetector.CreateDetectorVersion

Description

Creates a detector version. The detector version starts in a DRAFT status.

Synopsis

Creating a Request

data CreateDetectorVersion Source #

See: newCreateDetectorVersion smart constructor.

Constructors

CreateDetectorVersion' 

Fields

  • description :: Maybe Text

    The description of the detector version.

  • externalModelEndpoints :: Maybe [Text]

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

  • modelVersions :: Maybe [ModelVersion]

    The model versions to include in the detector version.

  • ruleExecutionMode :: Maybe RuleExecutionMode

    The rule execution mode for the rules included in the detector version.

    You can define and edit the rule mode at the detector version level, when it is in draft status.

    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.

    The default behavior is FIRST_MATCHED.

  • tags :: Maybe [Tag]

    A collection of key and value pairs.

  • detectorId :: Text

    The ID of the detector under which you want to create a new version.

  • rules :: [Rule]

    The rules to include in the detector version.

Instances

Instances details
ToJSON CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

ToHeaders CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

ToPath CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

ToQuery CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

AWSRequest CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Associated Types

type AWSResponse CreateDetectorVersion #

Generic CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Associated Types

type Rep CreateDetectorVersion :: Type -> Type #

Read CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Show CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

NFData CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Methods

rnf :: CreateDetectorVersion -> () #

Eq CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Hashable CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

type AWSResponse CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

type Rep CreateDetectorVersion Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

type Rep CreateDetectorVersion = D1 ('MetaData "CreateDetectorVersion" "Amazonka.FraudDetector.CreateDetectorVersion" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "CreateDetectorVersion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "externalModelEndpoints") '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Rule])))))

newCreateDetectorVersion Source #

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

CreateDetectorVersion, createDetectorVersion_description - The description of the detector version.

$sel:externalModelEndpoints:CreateDetectorVersion', createDetectorVersion_externalModelEndpoints - The Amazon Sagemaker model endpoints to include in the detector version.

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

$sel:ruleExecutionMode:CreateDetectorVersion', createDetectorVersion_ruleExecutionMode - The rule execution mode for the rules included in the detector version.

You can define and edit the rule mode at the detector version level, when it is in draft status.

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.

The default behavior is FIRST_MATCHED.

$sel:tags:CreateDetectorVersion', createDetectorVersion_tags - A collection of key and value pairs.

CreateDetectorVersion, createDetectorVersion_detectorId - The ID of the detector under which you want to create a new version.

$sel:rules:CreateDetectorVersion', createDetectorVersion_rules - The rules to include in the detector version.

Request Lenses

createDetectorVersion_description :: Lens' CreateDetectorVersion (Maybe Text) Source #

The description of the detector version.

createDetectorVersion_externalModelEndpoints :: Lens' CreateDetectorVersion (Maybe [Text]) Source #

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

createDetectorVersion_modelVersions :: Lens' CreateDetectorVersion (Maybe [ModelVersion]) Source #

The model versions to include in the detector version.

createDetectorVersion_ruleExecutionMode :: Lens' CreateDetectorVersion (Maybe RuleExecutionMode) Source #

The rule execution mode for the rules included in the detector version.

You can define and edit the rule mode at the detector version level, when it is in draft status.

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.

The default behavior is FIRST_MATCHED.

createDetectorVersion_tags :: Lens' CreateDetectorVersion (Maybe [Tag]) Source #

A collection of key and value pairs.

createDetectorVersion_detectorId :: Lens' CreateDetectorVersion Text Source #

The ID of the detector under which you want to create a new version.

createDetectorVersion_rules :: Lens' CreateDetectorVersion [Rule] Source #

The rules to include in the detector version.

Destructuring the Response

data CreateDetectorVersionResponse Source #

See: newCreateDetectorVersionResponse smart constructor.

Constructors

CreateDetectorVersionResponse' 

Fields

Instances

Instances details
Generic CreateDetectorVersionResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Associated Types

type Rep CreateDetectorVersionResponse :: Type -> Type #

Read CreateDetectorVersionResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Show CreateDetectorVersionResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

NFData CreateDetectorVersionResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

Eq CreateDetectorVersionResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

type Rep CreateDetectorVersionResponse Source # 
Instance details

Defined in Amazonka.FraudDetector.CreateDetectorVersion

type Rep CreateDetectorVersionResponse = D1 ('MetaData "CreateDetectorVersionResponse" "Amazonka.FraudDetector.CreateDetectorVersion" "amazonka-frauddetector-2.0-CdXFXtLV8DgKo4Kta7Jw61" 'False) (C1 ('MetaCons "CreateDetectorVersionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "detectorVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetectorVersionStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDetectorVersionResponse Source #

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

CreateDetectorVersion, createDetectorVersionResponse_detectorId - The ID for the created version's parent detector.

CreateDetectorVersionResponse, createDetectorVersionResponse_detectorVersionId - The ID for the created detector.

CreateDetectorVersionResponse, createDetectorVersionResponse_status - The status of the detector version.

$sel:httpStatus:CreateDetectorVersionResponse', createDetectorVersionResponse_httpStatus - The response's http status code.

Response Lenses

createDetectorVersionResponse_detectorId :: Lens' CreateDetectorVersionResponse (Maybe Text) Source #

The ID for the created version's parent detector.