asset_model_properties

Creates, updates, deletes, gets or lists an asset_model_properties resource.

Overview

Name	asset_model_properties
Type	Resource
Id	aws.iotsitewise.asset_model_properties

Fields

The following fields are returned by SELECT queries:

list_asset_model_properties

Name	Datatype	Description
id	string	The ID of the property. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
name	string	The name of the property. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
asset_model_composite_model_id	string	The ID of the composite model that contains the asset model property. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
data_type	string	The data type of the property. (STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT, VIDEO, ANNOTATION, JSON)
data_type_spec	string	The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
external_id	string	The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide. (pattern: <code>[a-zA-Z0-9_][a-zA-Z_-0-9.:]*[a-zA-Z0-9_]+</code>)
interface_summaries	array	A list of interface summaries that describe which interfaces this property belongs to, including the interface asset model ID and the corresponding property ID in the interface.
path	array	The structured path to the property from the root of the asset model.
type_	object	Contains a property type, which can be one of attribute, measurement, metric, or transform.
unit	string	The unit (such as Newtons or RPM) of the property. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_asset_model_properties	select	asset_model_id, region	nextToken, maxResults, filter, assetModelVersion	Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
asset_model_id	string	The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
region	string	AWS region (default: us-east-1)
assetModelVersion	string	The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.
filter	string	Filters the requested list of asset model properties. You can choose one of the following options: ALL – The list includes all asset model properties for a given asset model ID. BASE – The list includes only base asset model properties for a given asset model ID. Default: BASE
maxResults	integer	The maximum number of results to return for each paginated request. If not specified, the default value is 50.
nextToken	string	The token to be used for the next set of paginated results.

SELECT examples

list_asset_model_properties

Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

SELECT
id,
name,
asset_model_composite_model_id,
data_type,
data_type_spec,
external_id,
interface_summaries,
path,
type_,
unit
FROM aws.iotsitewise.asset_model_properties
WHERE asset_model_id = '{{ asset_model_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND filter = '{{ filter }}'
AND assetModelVersion = '{{ assetModelVersion }}'
;