get_asset_property_value

get_asset_property_value(**kwargs)

Gets an asset property's current value. For more information, see Querying current 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.

See also: AWS API Documentation

Request Syntax

response = client.get_asset_property_value(
    assetId='string',
    propertyId='string',
    propertyAlias='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 .

Return type

dict

Returns

Response Syntax

{
    'propertyValue': {
        'value': {
            'stringValue': 'string',
            'integerValue': 123,
            'doubleValue': 123.0,
            'booleanValue': True|False
        },
        'timestamp': {
            'timeInSeconds': 123,
            'offsetInNanos': 123
        },
        'quality': 'GOOD'|'BAD'|'UNCERTAIN'
    }
}

Response Structure

• (dict) --

  • propertyValue (dict) --

    The current asset property value.

    • 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.

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException
• IoTSiteWise.Client.exceptions.ResourceNotFoundException
• IoTSiteWise.Client.exceptions.InternalFailureException
• IoTSiteWise.Client.exceptions.ThrottlingException
• IoTSiteWise.Client.exceptions.ServiceUnavailableException