Amazon GuardDuty · JSON Structure

Guardduty Create Ip Set Request Structure

CreateIPSetRequest schema from Amazon GuardDuty API

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

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

Properties

Name Format Location Activate ClientToken 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-create-ip-set-request-structure.json",
  "name": "CreateIPSetRequest",
  "description": "CreateIPSetRequest schema from Amazon GuardDuty API",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "<p>The user-friendly name to identify the IPSet.</p> <p> Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).</p>"
        }
      ]
    },
    "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. "
        }
      ]
    },
    "Activate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "xml": {
            "name": "activate"
          },
          "description": "A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet."
        }
      ]
    },
    "ClientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "xml": {
            "name": "clientToken"
          },
          "description": "The idempotency token for the create request."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "xml": {
            "name": "tags"
          },
          "description": "The tags to be added to a new IP set resource."
        }
      ]
    }
  },
  "required": [
    "Name",
    "Format",
    "Location",
    "Activate"
  ]
}