DescribeGatewayResponse

DescribeGatewayResponse schema

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

Name Type Description
gatewayId object
gatewayName object
gatewayArn object
gatewayPlatform object
gatewayCapabilitySummaries object
creationDate object
lastUpdateDate object
View JSON Schema on GitHub

JSON Schema

iot-sitewise-describe-gateway-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-schema/iot-sitewise-describe-gateway-response-schema.json",
  "title": "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"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/iot-sitewise-describe-gateway-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.