Amazon GuardDuty · JSON Structure

Guardduty Update Filter Request Structure

UpdateFilterRequest schema from Amazon GuardDuty API

Type: object Properties: 4
Anomaly DetectionComplianceMachine LearningMonitoringSecurityThreat Detection

UpdateFilterRequest is a JSON Structure definition published by Amazon GuardDuty, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Description Action Rank FindingCriteria

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-guardduty/refs/heads/main/json-structure/guardduty-update-filter-request-structure.json",
  "name": "UpdateFilterRequest",
  "description": "UpdateFilterRequest schema from Amazon GuardDuty API",
  "type": "object",
  "properties": {
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterDescription"
        },
        {
          "xml": {
            "name": "description"
          },
          "description": "The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses (<code>{ }</code>, <code>[ ]</code>, and <code>( )</code>), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace."
        }
      ]
    },
    "Action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterAction"
        },
        {
          "xml": {
            "name": "action"
          },
          "description": "Specifies the action that is to be applied to the findings that match the filter."
        }
      ]
    },
    "Rank": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterRank"
        },
        {
          "xml": {
            "name": "rank"
          },
          "description": "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."
        }
      ]
    },
    "FindingCriteria": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FindingCriteria"
        },
        {
          "xml": {
            "name": "findingCriteria"
          },
          "description": "Represents the criteria to be used in the filter for querying findings."
        }
      ]
    }
  }
}