Amazon IoT SiteWise · JSON Structure

Iot Sitewise Describe Gateway Response Structure

DescribeGatewayResponse schema

Type: object Properties: 7 Required: 6
Asset ManagementIndustrial IoTIoTTime Series Data

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

Properties

gatewayId gatewayName gatewayArn gatewayPlatform gatewayCapabilitySummaries creationDate lastUpdateDate

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-iot-sitewise/refs/heads/main/json-structure/iot-sitewise-describe-gateway-response-structure.json",
  "name": "DescribeGatewayResponse",
  "description": "DescribeGatewayResponse schema",
  "type": "object",
  "properties": {
    "gatewayId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the gateway device."
        }
      ]
    },
    "gatewayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the gateway."
        }
      ]
    },
    "gatewayArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ARN"
        },
        {
          "description": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the gateway, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}</code> </p>"
        }
      ]
    },
    "gatewayPlatform": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GatewayPlatform"
        },
        {
          "description": "The gateway's platform."
        }
      ]
    },
    "gatewayCapabilitySummaries": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GatewayCapabilitySummaries"
        },
        {
          "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 <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html\">DescribeGatewayCapabilityConfiguration</a>."
        }
      ]
    },
    "creationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the gateway was created, in Unix epoch time."
        }
      ]
    },
    "lastUpdateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the gateway was last updated, in Unix epoch time."
        }
      ]
    }
  },
  "required": [
    "gatewayId",
    "gatewayName",
    "gatewayArn",
    "gatewayCapabilitySummaries",
    "creationDate",
    "lastUpdateDate"
  ]
}