[ aws . macie2 ]

create-findings-filter

Description

Creates and defines the criteria and other settings for a findings filter.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-findings-filter
--action <value>
[--client-token <value>]
[--description <value>]
--finding-criteria <value>
--name <value>
[--position <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--action (string)

The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don’t perform any action on the findings.

Possible values:

• ARCHIVE

• NOOP

--client-token (string)

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

--description (string)

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter’s description, depending on the actions that they’re allowed to perform in Amazon Macie.

--finding-criteria (structure)

The criteria to use to filter findings.

criterion -> (map)

A condition that specifies the property, operator, and value to use to filter the results.

key -> (string)

value -> (structure)

Specifies the operator to use in a property-based condition that filters the results of a query for findings.

eq -> (list)

An equal to condition to apply to a specified property value for findings.

(string)

gt -> (long)

A greater than condition to apply to a specified property value for findings.

gte -> (long)

A greater than or equal to condition to apply to a specified property value for findings.

lt -> (long)

A less than condition to apply to a specified property value for findings.

lte -> (long)

A less than or equal to condition to apply to a specified property value for findings.

neq -> (list)

A not equal to condition to apply to a specified property value for findings.

(string)

Shorthand Syntax:

criterion={KeyName1={eq=[string,string],gt=long,gte=long,lt=long,lte=long,neq=[string,string]},KeyName2={eq=[string,string],gt=long,gte=long,lt=long,lte=long,neq=[string,string]}}

JSON Syntax:

{
  "criterion": {"string": {
        "eq": ["string", ...],
        "gt": long,
        "gte": long,
        "lt": long,
        "lte": long,
        "neq": ["string", ...]
      }
    ...}
}

--name (string)

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter’s name, depending on the actions that they’re allowed to perform in Amazon Macie.

--position (integer)

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

--tags (map)

A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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

arn -> (string)

The Amazon Resource Name (ARN) of the filter that was created.

id -> (string)

The unique identifier for the filter that was created.