[ aws . frauddetector ]

create-rule

Description

Creates a rule for use with the specified detector.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-rule
--rule-id <value>
--detector-id <value>
[--description <value>]
--expression <value>
--language <value>
--outcomes <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--rule-id (string)

The rule ID.

--detector-id (string)

The detector ID for the rule’s parent detector.

--description (string)

The rule description.

--expression (string)

The rule expression.

--language (string)

The language of the rule.

Possible values:

• DETECTORPL

--outcomes (list)

The outcome or outcomes returned when the rule expression matches.

(string)

Syntax:

"string" "string" ...

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

rule -> (structure)

The created rule.

detectorId -> (string)

The detector for which the rule is associated.

ruleId -> (string)

The rule ID.

ruleVersion -> (string)

The rule version.