IoTSiteWise / Client / get_asset_property_value_history
get_asset_property_value_history#
- IoTSiteWise.Client.get_asset_property_value_history(**kwargs)#
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
andpropertyId
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.
See also: AWS API Documentation
Request Syntax
response = client.get_asset_property_value_history( assetId='string', propertyId='string', propertyAlias='string', startDate=datetime(2015, 1, 1), endDate=datetime(2015, 1, 1), qualities=[ 'GOOD'|'BAD'|'UNCERTAIN', ], timeOrdering='ASCENDING'|'DESCENDING', nextToken='string', maxResults=123 )
- Parameters:
assetId (string) – The ID of the asset.
propertyId (string) – The ID of the asset property.
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 .startDate (datetime) – The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
endDate (datetime) – The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
qualities (list) –
The quality by which to filter asset data.
(string) –
timeOrdering (string) –
The chronological sorting order of the requested information.
Default:
ASCENDING
nextToken (string) – The token to be used for the next set of paginated results.
maxResults (integer) –
The maximum number of results to return for each paginated request.
Default: 100
- Return type:
dict
- Returns:
Response Syntax
{ 'assetPropertyValueHistory': [ { 'value': { 'stringValue': 'string', 'integerValue': 123, 'doubleValue': 123.0, 'booleanValue': True|False }, 'timestamp': { 'timeInSeconds': 123, 'offsetInNanos': 123 }, 'quality': 'GOOD'|'BAD'|'UNCERTAIN' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
assetPropertyValueHistory (list) –
The asset property’s value history.
(dict) –
Contains asset property value information.
value (dict) –
The value of the asset property (see
Variant
).stringValue (string) –
Asset property data of type string (sequence of characters).
integerValue (integer) –
Asset property data of type integer (whole number).
doubleValue (float) –
Asset property data of type double (floating point number).
booleanValue (boolean) –
Asset property data of type Boolean (true or false).
timestamp (dict) –
The timestamp of the asset property value.
timeInSeconds (integer) –
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by
offsetInNanos
.offsetInNanos (integer) –
The nanosecond offset from
timeInSeconds
.
quality (string) –
The quality of the asset property value.
nextToken (string) –
The token for the next set of results, or null if there are no additional results.
Exceptions
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.ThrottlingException
IoTSiteWise.Client.exceptions.ServiceUnavailableException