Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . frauddetector ]

create-detector-version

Description

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

See also: AWS API Documentation

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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"|"TRANSACTION_FRAUD_INSIGHTS"|"ACCOUNT_TAKEOVER_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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.