Scope: Issue querying data by propertyAlias when the property is associated with an asset

[diehbria]

What happened:
Cannot construct query based on propertyAlias for a property which has a propertyAlias but is also associated with a SiteWise asset.

What you expected to happen:
Able to construct queries based on propertyAlias for any properties which contain a propertyAlias (which both modeled and unmodeled data supports)

[iwysiu]

Hi @diehbria !

Thanks for reporting this issue! I think I've reproduced it, but I would appreciate if you could reply with an example of a query with this issue and what error you get returned to be sure.

[iwysiu]

Ah, while investigating the code, it seems like when the plugin was written the design decision was made not to support propertyAlias targets for property value queries:

iot-sitewise-datasource/pkg/models/property.go

Line 11 in fa1bd02

// NOTES: We have decided to not support propertyAlias targets, as there is no good way to go from propertyAlias -> assetId/propertyId.

However it also has been 2 years since then, so I'll put this in the backlog for us to look into adding.

[sarahzinger]

This is marked as a bug for now, but might be more of a feature request. Let's take a look this sprint and see what it would involve to support this, might require creating this into it's own epic with design doc?

[diehbria]

@iwysiu @sarahzinger

Regarding this comment:

// NOTES: We have decided to not support propertyAlias targets, as there is no good way to go from propertyAlias -> assetId/propertyId.

You can determine the assetId and propertyId associated with a property given an propertyAlias with the DescribeTimeSeries API.

You can learn more ahttps://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeTimeSeries.html

You will make a request /timeseries/describe/?alias=$PROPERTY_ALIAS and this will return a response that contains a assetId and propertyId field