AssetSummaries

AssetSummaries schema

Asset ManagementIndustrial IoTIoTTime Series Data
View JSON Schema on GitHub

JSON Schema

iot-sitewise-asset-summaries-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-summaries-schema.json",
  "title": "AssetSummaries",
  "description": "AssetSummaries schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "arn",
      "name",
      "assetModelId",
      "creationDate",
      "lastUpdateDate",
      "status",
      "hierarchies"
    ],
    "properties": {
      "id": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ID"
          },
          {
            "description": "The ID of the asset."
          }
        ]
      },
      "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, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}</code> </p>"
          }
        ]
      },
      "name": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Name"
          },
          {
            "description": "The name of the asset."
          }
        ]
      },
      "assetModelId": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ID"
          },
          {
            "description": "The ID of the asset model used to create this asset."
          }
        ]
      },
      "creationDate": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Timestamp"
          },
          {
            "description": "The date the asset was created, in Unix epoch time."
          }
        ]
      },
      "lastUpdateDate": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Timestamp"
          },
          {
            "description": "The date the asset was last updated, in Unix epoch time."
          }
        ]
      },
      "status": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AssetStatus"
          },
          {
            "description": "The current status of the asset."
          }
        ]
      },
      "hierarchies": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AssetHierarchies"
          },
          {
            "description": "A list of asset hierarchies that each contain a <code>hierarchyId</code>. A hierarchy specifies allowed parent/child asset relationships."
          }
        ]
      },
      "description": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Description"
          },
          {
            "description": "A description for the asset."
          }
        ]
      }
    },
    "description": "Contains a summary of an asset."
  }
}