AssetPropertySummary
Contains a summary of a property associated with an asset.
Contents
- id
-
The ID of the property.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Required: Yes
- alias
-
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.Type: String
Length Constraints: Minimum length of 1.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
- assetCompositeModelId
-
The ID of the composite model that contains the asset property.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Required: No
- externalId
-
The external ID of the property. For more information, see Using external IDs in the AWS IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 128.
Pattern:
[a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+Required: No
- notification
-
Contains asset property value notification information. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.
Type: PropertyNotification object
Required: No
- path
-
The structured path to the property from the root of the asset.
Type: Array of AssetPropertyPathSegment objects
Required: No
- unit
-
The unit of measure (such as Newtons or RPM) of the asset property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
