AssetModelProperty
Contains information about an asset model property.
Contents
- dataType
-
The data type of the asset model property.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this property.Type: String
Valid Values:
STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT
Required: Yes
- name
-
The name of the asset model property.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^\u0000-\u001F\u007F]+
Required: Yes
- type
-
The property type (see
PropertyType
).Type: PropertyType object
Required: Yes
- 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 (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the Amazon 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 model property.
-
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. Amazon 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.
-
If you are calling UpdateAssetModel to modify an existing property: 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 Amazon IoT SiteWise User Guide.
Type: String
Length Constraints: Minimum length of 13. Maximum length of 139.
Pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+
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 of the asset model property, such as
Newtons
orRPM
.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 Amazon SDKs, see the following: