AssetModelCompositeModelDefinition
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset 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
- 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
-
An external ID to assign to the composite model. The external ID must be unique among composite models within this asset 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 to assign to the composite model, if desired. AWS IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
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
- properties
-
The asset property definitions for this composite model.
Type: Array of AssetModelPropertyDefinition objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
