You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GuardDuty::Types::UpdateFilterRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

Note:

When making an API call, you may pass UpdateFilterRequest data as a hash:

{
  detector_id: "DetectorId", # required
  filter_name: "String", # required
  description: "FilterDescription",
  action: "NOOP", # accepts NOOP, ARCHIVE
  rank: 1,
  finding_criteria: {
    criterion: {
      "String" => {
        eq: ["String"],
        neq: ["String"],
        gt: 1,
        gte: 1,
        lt: 1,
        lte: 1,
        equals: ["String"],
        not_equals: ["String"],
        greater_than: 1,
        greater_than_or_equal: 1,
        less_than: 1,
        less_than_or_equal: 1,
      },
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

Specifies the action that is to be applied to the findings that match the filter.

Returns:

  • (String)


3365
3366
3367
3368
3369
3370
3371
3372
3373
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 3365

class UpdateFilterRequest < Struct.new(
  :detector_id,
  :filter_name,
  :description,
  :action,
  :rank,
  :finding_criteria)
  include Aws::Structure
end

#descriptionString

The description of the filter.

Returns:

  • (String)


3365
3366
3367
3368
3369
3370
3371
3372
3373
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 3365

class UpdateFilterRequest < Struct.new(
  :detector_id,
  :filter_name,
  :description,
  :action,
  :rank,
  :finding_criteria)
  include Aws::Structure
end

#detector_idString

The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.

Returns:

  • (String)


3365
3366
3367
3368
3369
3370
3371
3372
3373
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 3365

class UpdateFilterRequest < Struct.new(
  :detector_id,
  :filter_name,
  :description,
  :action,
  :rank,
  :finding_criteria)
  include Aws::Structure
end

#filter_nameString

The name of the filter.

Returns:

  • (String)


3365
3366
3367
3368
3369
3370
3371
3372
3373
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 3365

class UpdateFilterRequest < Struct.new(
  :detector_id,
  :filter_name,
  :description,
  :action,
  :rank,
  :finding_criteria)
  include Aws::Structure
end

#finding_criteriaTypes::FindingCriteria

Represents the criteria to be used in the filter for querying findings.



3365
3366
3367
3368
3369
3370
3371
3372
3373
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 3365

class UpdateFilterRequest < Struct.new(
  :detector_id,
  :filter_name,
  :description,
  :action,
  :rank,
  :finding_criteria)
  include Aws::Structure
end

#rankInteger

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.

Returns:

  • (Integer)


3365
3366
3367
3368
3369
3370
3371
3372
3373
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 3365

class UpdateFilterRequest < Struct.new(
  :detector_id,
  :filter_name,
  :description,
  :action,
  :rank,
  :finding_criteria)
  include Aws::Structure
end