IoT SiteWise Asset Model

AWS IoT SiteWise Asset Model defines the blueprint for industrial assets, describing their properties, measurements, metrics, and hierarchies. It allows you to standardize how equipment and processes are represented, making it easier to collect, organize, and analyze data consistently across multiple assets.

aws.iotsitewise_asset_model

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
asset_model_arncorestringThe ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
asset_model_composite_model_summariescorejsonThe list of the immediate child custom composite model summaries for the asset model.
asset_model_composite_modelscorejsonThe list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.
asset_model_creation_datecoretimestampThe date the asset model was created, in Unix epoch time.
asset_model_descriptioncorestringThe asset model's description.
asset_model_external_idcorestringThe external ID of the asset model, if any.
asset_model_hierarchiescorejsonA list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.
asset_model_idcorestringThe ID of the asset model, in UUID format.
asset_model_last_update_datecoretimestampThe date the asset model was last updated, in Unix epoch time.
asset_model_namecorestringThe name of the asset model.
asset_model_propertiescorejsonThe list of asset properties for the asset model. This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.
asset_model_statuscorejsonThe current status of the asset model, which contains a state and any error message.
asset_model_typecorestringThe type of asset model. ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model. COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
asset_model_versioncorestringThe version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
e_tagcorestringThe entity tag (ETag) is a hash of the retrieved version of the asset model. It's used to make concurrent updates safely to the resource. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html">Optimistic locking for asset model writes</a> in the <i>IoT SiteWise User Guide</i>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html"> Optimistic locking for asset model writes</a> in the <i>IoT SiteWise User Guide</i>.
tagscorehstore