AssetModelPropertySummary
Contains a summary of a property associated with a model.
Contents
- dataType
-
The data type of the property.
Type: String
Valid Values:
STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT
Required: Yes
- name
-
The name of the property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+
Required: Yes
- type
-
Contains a property type, which can be one of
attribute
,measurement
,metric
, ortransform
.Type: PropertyType object
Required: Yes
- assetModelCompositeModelId
-
The ID of the composite model that contains the asset model 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
- dataTypeSpec
-
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+
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
- 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: No
- path
-
The structured path to the property from the root of the asset model.
Type: Array of AssetModelPropertyPathSegment objects
Required: No
- unit
-
The unit (such as
Newtons
orRPM
) of the 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: