AssetProperty - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AssetProperty

Contains asset property information.

Contents

alias

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the Amazon IoT SiteWise User Guide.

Type: String

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

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

Required: No

dataType

The data type of the asset property.

Type: String

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

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

id

The ID of the asset 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: 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

notification

The asset property's notification topic and state. For more information, see UpdateAssetProperty.

Type: PropertyNotification object

Required: No

unit

The unit (such as Newtons or RPM) of the asset 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 Amazon SDKs, see the following: