{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-iot-sitewise/json-schema/amazon-iot-sitewise-describe-gateway-response-schema.json",
  "title": "DescribeGatewayResponse",
  "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/DescribeGatewayResponse",
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "description": "The ID of the gateway device."
    },
    "gatewayName": {
      "type": "string",
      "description": "The name of the gateway."
    },
    "gatewayArn": {
      "type": "string",
      "description": "The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}"
    },
    "gatewayPlatform": {
      "$ref": "#/$defs/GatewayPlatform"
    },
    "gatewayVersion": {
      "type": "string",
      "description": "The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway."
    },
    "gatewayCapabilitySummaries": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/GatewayCapabilitySummary"
      },
      "description": "A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration."
    },
    "creationDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date the gateway was created, in Unix epoch time."
    },
    "lastUpdateDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date the gateway was last updated, in Unix epoch time."
    }
  },
  "required": [
    "gatewayId",
    "gatewayName",
    "gatewayArn",
    "gatewayCapabilitySummaries",
    "creationDate",
    "lastUpdateDate"
  ],
  "$defs": {
    "GatewayCapabilitySummary": {
      "type": "object",
      "properties": {
        "capabilityNamespace": {
          "type": "string",
          "description": "The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3."
        },
        "capabilitySyncStatus": {
          "type": "string",
          "enum": [
            "IN_SYNC",
            "OUT_OF_SYNC",
            "SYNC_FAILED",
            "UNKNOWN",
            "NOT_APPLICABLE"
          ],
          "description": "The synchronization status of the gateway capability configuration. The sync status can be one of the following: IN_SYNC - The gateway is running with the latest configuration. OUT_OF_SYNC - The gateway hasn't received the latest configuration. SYNC_FAILED - The gateway rejected the latest configuration. UNKNOWN - The gateway hasn't reported its sync status. NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner."
        }
      },
      "required": [
        "capabilityNamespace",
        "capabilitySyncStatus"
      ]
    },
    "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"
      ]
    }
  }
}