CreateGatewayResponse

CreateGatewayResponse schema

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

Name Type Description
gatewayId object
gatewayArn object
View JSON Schema on GitHub

JSON Schema

iot-sitewise-create-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-create-gateway-response-schema.json",
  "title": "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"
  ]
}