Amazon IoT SiteWise · JSON Structure

Iot Sitewise Create Gateway Response Structure

CreateGatewayResponse schema

Type: object Properties: 2 Required: 2
Asset ManagementIndustrial IoTIoTTime Series Data

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

Properties

gatewayId gatewayArn

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-create-gateway-response-structure.json",
  "name": "CreateGatewayResponse",
  "description": "CreateGatewayResponse schema",
  "type": "object",
  "properties": {
    "gatewayId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs."
        }
      ]
    },
    "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>"
        }
      ]
    }
  },
  "required": [
    "gatewayId",
    "gatewayArn"
  ]
}