DescribeAssetPropertyResponse

DescribeAssetPropertyResponse schema

Asset ManagementIndustrial IoTIoTTime Series Data

Properties

Name Type Description
assetId object
assetName object
assetModelId object
assetProperty object
compositeModel object
View JSON Schema on GitHub

JSON Schema

iot-sitewise-describe-asset-property-response-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-describe-asset-property-response-schema.json",
  "title": "DescribeAssetPropertyResponse",
  "description": "DescribeAssetPropertyResponse schema",
  "type": "object",
  "properties": {
    "assetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset."
        }
      ]
    },
    "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."
        }
      ]
    },
    "assetProperty": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Property"
        },
        {
          "description": "<p>The asset property's definition, alias, and notification state.</p> <p>This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in <code>compositeModel</code>.</p>"
        }
      ]
    },
    "compositeModel": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CompositeModelProperty"
        },
        {
          "description": "The composite asset model that declares this asset property, if this asset property exists in a composite model."
        }
      ]
    }
  },
  "required": [
    "assetId",
    "assetName",
    "assetModelId"
  ]
}