Amazon IoT SiteWise · JSON Structure

Iot Sitewise Describe Asset Response Structure

DescribeAssetResponse schema

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

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

Properties

assetId assetArn assetName assetModelId assetProperties assetHierarchies assetCompositeModels assetCreationDate assetLastUpdateDate assetStatus assetDescription

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-describe-asset-response-structure.json",
  "name": "DescribeAssetResponse",
  "description": "DescribeAssetResponse schema",
  "type": "object",
  "properties": {
    "assetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset."
        }
      ]
    },
    "assetArn": {
      "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>"
        }
      ]
    },
    "assetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the asset."
        }
      ]
    },
    "assetModelId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset model that was used to create the asset."
        }
      ]
    },
    "assetProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetProperties"
        },
        {
          "description": "<p>The list of asset properties for the asset.</p> <p>This object doesn't include properties that you define in composite models. You can find composite model properties in the <code>assetCompositeModels</code> object.</p>"
        }
      ]
    },
    "assetHierarchies": {
      "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."
        }
      ]
    },
    "assetCompositeModels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetCompositeModels"
        },
        {
          "description": "The composite models for the asset."
        }
      ]
    },
    "assetCreationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the asset was created, in Unix epoch time."
        }
      ]
    },
    "assetLastUpdateDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date the asset was last updated, in Unix epoch time."
        }
      ]
    },
    "assetStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetStatus"
        },
        {
          "description": "The current status of the asset, which contains a state and any error message."
        }
      ]
    },
    "assetDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "A description for the asset."
        }
      ]
    }
  },
  "required": [
    "assetId",
    "assetArn",
    "assetName",
    "assetModelId",
    "assetProperties",
    "assetHierarchies",
    "assetCreationDate",
    "assetLastUpdateDate",
    "assetStatus"
  ]
}