Class: Aws::GuardDuty::Types::CreateFilterRequest

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

Overview

Note:

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

{
  action: "NOOP", # accepts NOOP, ARCHIVE
  client_token: "__stringMin0Max64",
  description: "FilterDescription",
  detector_id: "__string", # required
  finding_criteria: { # required
    criterion: {
      "__string" => {
        eq: ["__string"],
        gt: 1,
        gte: 1,
        lt: 1,
        lte: 1,
        neq: ["__string"],
      },
    },
  },
  name: "FilterName", # required
  rank: 1,
}

CreateFilter request object.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

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

Returns:

  • (String) 


396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-guardduty/types.rb', line 396

class CreateFilterRequest < Struct.new(
  :action,
  :client_token,
  :description,
  :detector_id,
  :finding_criteria,
  :name,
  :rank)
  include Aws::Structure
end

#client_token ⇒ String

The idempotency token for the create request.**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-guardduty/types.rb', line 396

class CreateFilterRequest < Struct.new(
  :action,
  :client_token,
  :description,
  :detector_id,
  :finding_criteria,
  :name,
  :rank)
  include Aws::Structure
end

#description ⇒ String

The description of the filter.

Returns:

  • (String) 


396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-guardduty/types.rb', line 396

class CreateFilterRequest < Struct.new(
  :action,
  :client_token,
  :description,
  :detector_id,
  :finding_criteria,
  :name,
  :rank)
  include Aws::Structure
end

#detector_id ⇒ String

Returns:

  • (String) 


396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-guardduty/types.rb', line 396

class CreateFilterRequest < Struct.new(
  :action,
  :client_token,
  :description,
  :detector_id,
  :finding_criteria,
  :name,
  :rank)
  include Aws::Structure
end

#finding_criteria ⇒ Types::FindingCriteria

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

Returns:



396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-guardduty/types.rb', line 396

class CreateFilterRequest < Struct.new(
  :action,
  :client_token,
  :description,
  :detector_id,
  :finding_criteria,
  :name,
  :rank)
  include Aws::Structure
end

#name ⇒ String

The name of the filter.

Returns:

  • (String) 


396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-guardduty/types.rb', line 396

class CreateFilterRequest < Struct.new(
  :action,
  :client_token,
  :description,
  :detector_id,
  :finding_criteria,
  :name,
  :rank)
  include Aws::Structure
end

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

Returns:

  • (Integer) 


396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-guardduty/types.rb', line 396

class CreateFilterRequest < Struct.new(
  :action,
  :client_token,
  :description,
  :detector_id,
  :finding_criteria,
  :name,
  :rank)
  include Aws::Structure
end