Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
Contents
- name
-
The name of the composite model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+Required: Yes
- properties
-
The asset properties that this composite model defines.
Type: Array of AssetProperty objects
Required: Yes
- type
-
The type of the composite model. For alarm composite models, this type is
AWS/ALARM.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+Required: Yes
- description
-
The description of the composite model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[^\u0000-\u001F\u007F]+Required: No
- externalId
-
The external ID of the asset composite model. 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 asset composite model.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
