AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
update-filter
--detector-id <value>
--filter-name <value>
[--description <value>]
[--action <value>]
[--rank <value>]
[--finding-criteria <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--detector-id
(string)
The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.
--filter-name
(string)
The name of the filter.
--description
(string)
The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ({ }
,[ ]
, and( )
), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.
--action
(string)
Specifies the action that is to be applied to the findings that match the filter.
Possible values:
NOOP
ARCHIVE
--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.
--finding-criteria
(structure)
Represents the criteria to be used in the filter for querying findings.
Criterion -> (map)
Represents a map of finding properties that match specified conditions and values when querying findings.
key -> (string)
value -> (structure)
Contains information about the condition.
Eq -> (list)
Represents the equal condition to be applied to a single field when querying for findings.
(string)
Neq -> (list)
Represents the not equal condition to be applied to a single field when querying for findings.
(string)
Gt -> (integer)
Represents a greater than condition to be applied to a single field when querying for findings.Gte -> (integer)
Represents a greater than or equal condition to be applied to a single field when querying for findings.Lt -> (integer)
Represents a less than condition to be applied to a single field when querying for findings.Lte -> (integer)
Represents a less than or equal condition to be applied to a single field when querying for findings.Equals -> (list)
Represents an equal condition to be applied to a single field when querying for findings.
(string)
NotEquals -> (list)
Represents a not equal condition to be applied to a single field when querying for findings.
(string)
GreaterThan -> (long)
Represents a greater than condition to be applied to a single field when querying for findings.GreaterThanOrEqual -> (long)
Represents a greater than or equal condition to be applied to a single field when querying for findings.LessThan -> (long)
Represents a less than condition to be applied to a single field when querying for findings.LessThanOrEqual -> (long)
Represents a less than or equal condition to be applied to a single field when querying for findings.
Shorthand Syntax:
Criterion={KeyName1={Eq=[string,string],Neq=[string,string],Gt=integer,Gte=integer,Lt=integer,Lte=integer,Equals=[string,string],NotEquals=[string,string],GreaterThan=long,GreaterThanOrEqual=long,LessThan=long,LessThanOrEqual=long},KeyName2={Eq=[string,string],Neq=[string,string],Gt=integer,Gte=integer,Lt=integer,Lte=integer,Equals=[string,string],NotEquals=[string,string],GreaterThan=long,GreaterThanOrEqual=long,LessThan=long,LessThanOrEqual=long}}
JSON Syntax:
{
"Criterion": {"string": {
"Eq": ["string", ...],
"Neq": ["string", ...],
"Gt": integer,
"Gte": integer,
"Lt": integer,
"Lte": integer,
"Equals": ["string", ...],
"NotEquals": ["string", ...],
"GreaterThan": long,
"GreaterThanOrEqual": long,
"LessThan": long,
"LessThanOrEqual": long
}
...}
}
--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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.