Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . guardduty ]

create-filter

Description

Creates a filter using the specified finding criteria.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-filter
[--action <value>]
[--client-token <value>]
[--description <value>]
--detector-id <value>
[--finding-criteria <value>]
[--name <value>]
[--rank <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--action (string) Specifies the action that is to be applied to the findings that match the filter.

Possible values:

  • NOOP
  • ARCHIVE

--client-token (string) The idempotency token for the create request.

--description (string) The description of the filter.

--detector-id (string) The unique ID of the detector that you want to update.

--finding-criteria (structure) Represents the criteria to be used in the filter for querying findings.

Shorthand Syntax:

Criterion={KeyName1={Eq=[string,string],Gt=integer,Gte=integer,Lt=integer,Lte=integer,Neq=[string,string]},KeyName2={Eq=[string,string],Gt=integer,Gte=integer,Lt=integer,Lte=integer,Neq=[string,string]}}

JSON Syntax:

{
  "Criterion": {"string": {
        "Eq": ["string", ...],
        "Gt": integer,
        "Gte": integer,
        "Lt": integer,
        "Lte": integer,
        "Neq": ["string", ...]
      }
    ...}
}

--name (string) The name of the filter.

--rank (integer) Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

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

See 'aws help' for descriptions of global parameters.

Output

Name -> (string)

The name of the successfully created filter.