[ aws . accessanalyzer ]

create-archive-rule

Description

Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-archive-rule
--analyzer-name <value>
[--client-token <value>]
--filter <value>
--rule-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--analyzer-name (string)

The name of the created analyzer.

--client-token (string)

A client token.

--filter (map)

The criteria for the rule.

key -> (string)

value -> (structure)

The criteria to use in the filter that defines the archive rule.

contains -> (list)

A “contains” operator to match for the filter used to create the rule.

(string)

eq -> (list)

An “equals” operator to match for the filter used to create the rule.

(string)

exists -> (boolean)

An “exists” operator to match for the filter used to create the rule.

neq -> (list)

A “not equals” operator to match for the filter used to create the rule.

(string)

Shorthand Syntax:

KeyName1=contains=string,string,eq=string,string,exists=boolean,neq=string,string,KeyName2=contains=string,string,eq=string,string,exists=boolean,neq=string,string

JSON Syntax:

{"string": {
      "contains": ["string", ...],
      "eq": ["string", ...],
      "exists": true|false,
      "neq": ["string", ...]
    }
  ...}

--rule-name (string)

The name of the rule to create.

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

See ‘aws help’ for descriptions of global parameters.

Output

None