AssetModelSummary

Contains a summary of an asset model.

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

Name Type Description
id object
arn object
name object
description object
creationDate object
lastUpdateDate object
status object
View JSON Schema on GitHub

JSON Schema

iot-sitewise-asset-model-summary-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-asset-model-summary-schema.json",
  "title": "AssetModelSummary",
  "description": "Contains a summary of an asset model.",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset model (used with IoT SiteWise APIs)."
        }
      ]
    },
    "arn": {
      "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 asset model, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}</code> </p>"
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the asset model."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "The asset model description."
        }
      ]
    },
    "creationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the asset model was created, in Unix epoch time."
        }
      ]
    },
    "lastUpdateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the asset model was last updated, in Unix epoch time."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetModelStatus"
        },
        {
          "description": "The current status of the asset model."
        }
      ]
    }
  },
  "required": [
    "id",
    "arn",
    "name",
    "description",
    "creationDate",
    "lastUpdateDate",
    "status"
  ]
}