[ aws . frauddetector ]

create-detector-version

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-detector-version
--detector-id <value>
[--description <value>]
[--external-model-endpoints <value>]
--rules <value>
[--model-versions <value>]
[--rule-execution-mode <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--detector-id (string)

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

--description (string)

The description of the detector version.

--external-model-endpoints (list)

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

(string)

Syntax:

"string" "string" ...

--rules (list)

The rules to include in the detector version.

(structure)

A rule.

detectorId -> (string)

The detector for which the rule is associated.

ruleId -> (string)

The rule ID.

ruleVersion -> (string)

The rule version.

Shorthand Syntax:

detectorId=string,ruleId=string,ruleVersion=string ...

JSON Syntax:

[
  {
    "detectorId": "string",
    "ruleId": "string",
    "ruleVersion": "string"
  }
  ...
]

--model-versions (list)

The model versions to include in the detector version.

(structure)

The model version.

modelId -> (string)

The model ID.

modelType -> (string)

The model type.

modelVersionNumber -> (string)

The model version number.

arn -> (string)

The model version ARN.

Shorthand Syntax:

modelId=string,modelType=string,modelVersionNumber=string,arn=string ...

JSON Syntax:

[
  {
    "modelId": "string",
    "modelType": "ONLINE_FRAUD_INSIGHTS",
    "modelVersionNumber": "string",
    "arn": "string"
  }
  ...
]

--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

--tags (list)

A collection of key and value pairs.

(structure)

A key and value pair.

key -> (string)

A tag key.

value -> (string)

A value assigned to a tag key.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

detectorId -> (string)

The ID for the created version’s parent detector.

detectorVersionId -> (string)

The ID for the created detector.

status -> (string)

The status of the detector version.