Amazon IoT SiteWise · JSON Structure

Iot Sitewise Associated Assets Summary Structure

Contains a summary of an associated asset.

Type: object Properties: 9 Required: 8
Asset ManagementIndustrial IoTIoTTime Series Data

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

Properties

id arn name assetModelId creationDate lastUpdateDate status hierarchies description

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-associated-assets-summary-structure.json",
  "name": "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"
  ]
}