[ aws . frauddetector ]

update-rule-metadata

Description

Updates a rule’s metadata. The description attribute can be updated.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-rule-metadata
--rule <value>
--description <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--rule (structure)

The rule to update.

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

--description (string)

The rule description.

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

None