Skip to content

Get Filter

guardduty_get_filter R Documentation

Returns the details of the filter specified by the filter name

Description

Returns the details of the filter specified by the filter name.

Usage

guardduty_get_filter(DetectorId, FilterName)

Arguments

DetectorId

[required] The unique ID of the detector that is associated with this filter.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the list_detectors API.

FilterName

[required] The name of the filter you want to get.

Value

A list with the following syntax:

list(
  Name = "string",
  Description = "string",
  Action = "NOOP"|"ARCHIVE",
  Rank = 123,
  FindingCriteria = list(
    Criterion = list(
      list(
        Eq = list(
          "string"
        ),
        Neq = list(
          "string"
        ),
        Gt = 123,
        Gte = 123,
        Lt = 123,
        Lte = 123,
        Equals = list(
          "string"
        ),
        NotEquals = list(
          "string"
        ),
        GreaterThan = 123,
        GreaterThanOrEqual = 123,
        LessThan = 123,
        LessThanOrEqual = 123
      )
    )
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$get_filter(
  DetectorId = "string",
  FilterName = "string"
)