{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-iot-sitewise/json-schema/amazon-iot-sitewise-create-gateway-request-schema.json",
  "title": "CreateGatewayRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-iot-sitewise-gateways-api-openapi.yml#/components/schemas/CreateGatewayRequest",
  "type": "object",
  "properties": {
    "gatewayName": {
      "type": "string",
      "description": "A unique name for the gateway."
    },
    "gatewayPlatform": {
      "$ref": "#/$defs/GatewayPlatform"
    },
    "gatewayVersion": {
      "type": "string",
      "description": "The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway). When creating a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem parameter. We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways."
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide."
    }
  },
  "required": [
    "gatewayName",
    "gatewayPlatform"
  ],
  "$defs": {
    "GatewayPlatform": {
      "type": "object",
      "properties": {
        "greengrass": {
          "$ref": "#/$defs/Greengrass"
        },
        "greengrassV2": {
          "$ref": "#/$defs/GreengrassV2"
        },
        "siemensIE": {
          "$ref": "#/$defs/SiemensIE"
        }
      }
    },
    "Greengrass": {
      "type": "object",
      "properties": {
        "groupArn": {
          "type": "string",
          "description": "The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass V1 API Reference."
        }
      },
      "required": [
        "groupArn"
      ]
    },
    "GreengrassV2": {
      "type": "object",
      "properties": {
        "coreDeviceThingName": {
          "type": "string",
          "description": "The name of the IoT thing for your IoT Greengrass V2 core device."
        },
        "coreDeviceOperatingSystem": {
          "type": "string",
          "enum": [
            "LINUX_AARCH64",
            "LINUX_AMD64",
            "WINDOWS_AMD64"
          ],
          "description": "The operating system of the core device in IoT Greengrass V2. Specifying the operating system is required for MQTT-enabled, V3 gateways (gatewayVersion 3) and not applicable for Classic stream, V2 gateways (gatewayVersion 2)."
        }
      },
      "required": [
        "coreDeviceThingName"
      ]
    },
    "SiemensIE": {
      "type": "object",
      "properties": {
        "iotCoreThingName": {
          "type": "string",
          "description": "The name of the IoT Thing for your SiteWise Edge gateway."
        }
      },
      "required": [
        "iotCoreThingName"
      ]
    }
  }
}