Amazon GuardDuty · JSON Structure

Guardduty Get Ip Set Response Structure

GetIPSetResponse schema from Amazon GuardDuty API

Type: object Properties: 5 Required: 4
Anomaly DetectionComplianceMachine LearningMonitoringSecurityThreat Detection

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

Properties

Name Format Location Status Tags

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-get-ip-set-response-structure.json",
  "name": "GetIPSetResponse",
  "description": "GetIPSetResponse schema from Amazon GuardDuty API",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "The user-friendly name for the IPSet."
        }
      ]
    },
    "Format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpSetFormat"
        },
        {
          "xml": {
            "name": "format"
          },
          "description": "The format of the file that contains the IPSet."
        }
      ]
    },
    "Location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Location"
        },
        {
          "xml": {
            "name": "location"
          },
          "description": "The URI of the file that contains the IPSet."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpSetStatus"
        },
        {
          "xml": {
            "name": "status"
          },
          "description": "The status of IPSet file that was uploaded."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "xml": {
            "name": "tags"
          },
          "description": "The tags of the IPSet resource."
        }
      ]
    }
  },
  "required": [
    "Name",
    "Format",
    "Location",
    "Status"
  ]
}