asset_property_value_histories

Creates, updates, deletes, gets or lists an asset_property_value_histories resource.

Overview

Name	asset_property_value_histories
Type	Resource
Id	aws.iotsitewise.asset_property_value_histories

Fields

The following fields are returned by SELECT queries:

batch_get_asset_property_value_history

Name	Datatype	Description
error_entries	array	A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
next_token	string	The token for the next set of results, or null if there are no additional results. (pattern: <code>[A-Za-z0-9+/=]+</code>)
skipped_entries	array	A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
success_entries	array	A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

get_asset_property_value_history

Name	Datatype	Description
quality	string	The quality of the asset property value. (GOOD, BAD, UNCERTAIN)
timestamp	object	The timestamp of the asset property value.
value	object	The value of the asset property (see Variant).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_asset_property_value_history	select	region		Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
get_asset_property_value_history	select	region	assetId, propertyId, propertyAlias, startDate, endDate, qualities, timeOrdering, nextToken, maxResults	Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
assetId	string	The ID of the asset, in UUID format.
endDate	string (date-time)	The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
maxResults	integer	The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first. The size of the result set is equal to 4 MB. The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
nextToken	string	The token to be used for the next set of paginated results.
propertyAlias	string	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 IoT SiteWise User Guide.
propertyId	string	The ID of the asset property, in UUID format.
qualities	array	The quality by which to filter asset data.
startDate	string (date-time)	The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
timeOrdering	string	The chronological sorting order of the requested information. Default: ASCENDING

SELECT examples

batch_get_asset_property_value_history

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

SELECT
error_entries,
next_token,
skipped_entries,
success_entries
FROM aws.iotsitewise.asset_property_value_histories
WHERE region = '{{ region }}' -- required
;

get_asset_property_value_history

Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

SELECT
quality,
timestamp,
value
FROM aws.iotsitewise.asset_property_value_histories
WHERE region = '{{ region }}' -- required
AND assetId = '{{ assetId }}'
AND propertyId = '{{ propertyId }}'
AND propertyAlias = '{{ propertyAlias }}'
AND startDate = '{{ startDate }}'
AND endDate = '{{ endDate }}'
AND qualities = '{{ qualities }}'
AND timeOrdering = '{{ timeOrdering }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;