You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::FraudDetector::Types::CreateDetectorVersionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDetectorVersionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  detector_id: "identifier", # required
  description: "description",
  external_model_endpoints: ["string"],
  rules: [ # required
    {
      detector_id: "identifier", # required
      rule_id: "identifier", # required
      rule_version: "wholeNumberVersionString", # required
    },
  ],
  model_versions: [
    {
      model_id: "modelIdentifier", # required
      model_type: "ONLINE_FRAUD_INSIGHTS", # required, accepts ONLINE_FRAUD_INSIGHTS
      model_version_number: "nonEmptyString", # required
      arn: "fraudDetectorArn",
    },
  ],
  rule_execution_mode: "ALL_MATCHED", # accepts ALL_MATCHED, FIRST_MATCHED
  tags: [
    {
      key: "tagKey", # required
      value: "tagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description of the detector version.

Returns:

  • (String) —

    The description of the detector version.

#detector_id ⇒ String

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

Returns:

  • (String) —

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

#external_model_endpoints ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#model_versions ⇒ Array<Types::ModelVersion>

The model versions to include in the detector version.

Returns:

#rule_execution_mode ⇒ String

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.

Possible values:

  • ALL_MATCHED
  • FIRST_MATCHED

Returns:

  • (String) —

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

#rules ⇒ Array<Types::Rule>

The rules to include in the detector version.

Returns:

  • (Array<Types::Rule>) —

    The rules to include in the detector version.

#tags ⇒ Array<Types::Tag>

A collection of key and value pairs.

Returns:

  • (Array<Types::Tag>) —

    A collection of key and value pairs.