AssetModelPropertyDefinition - AWS IoT SiteWise

AssetModelPropertyDefinition

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

Contents

dataType

The data type of the property definition.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

Type: String

Valid Values: STRING | INTEGER | DOUBLE | BOOLEAN | STRUCT

Required: Yes

dataTypeSpec

The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: No

name

The name of the property definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

type

The property definition type (see PropertyType). You can only specify one type in a property definition.

Type: PropertyType object

Required: Yes

unit

The unit of the property definition, such as Newtons or RPM.

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: