AssociatedAssetsSummary

Contains a summary of an associated asset.

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

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

JSON Schema

iot-sitewise-associated-assets-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-associated-assets-summary-schema.json",
  "title": "AssociatedAssetsSummary",
  "description": "Contains a summary of an associated asset.",
  "type": "object",
  "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 the 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."
        }
      ]
    }
  },
  "required": [
    "id",
    "arn",
    "name",
    "assetModelId",
    "creationDate",
    "lastUpdateDate",
    "status",
    "hierarchies"
  ]
}