VariableValue - AWS IoT SiteWise

VariableValue

Identifies a property value used in an expression.

Contents

hierarchyId

The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide.

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Type: String

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

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

Required: No

propertyId

The ID of the property to use as the variable. You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide.

Type: String

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

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

Required: No

propertyPath

The path of the property.

Type: Array of AssetModelPropertyPathSegment objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: