IoTSiteWise / Paginator / GetAssetPropertyValueHistory

GetAssetPropertyValueHistory

class IoTSiteWise.Paginator.GetAssetPropertyValueHistory

paginator = client.get_paginator('get_asset_property_value_history')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.get_asset_property_value_history().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    startDate=datetime(2015, 1, 1),
    endDate=datetime(2015, 1, 1),
    qualities=[
        'GOOD'|'BAD'|'UNCERTAIN',
    ],
    timeOrdering='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.