Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotsitewise ]



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

See 'aws help' for descriptions of global parameters.


[--asset-id <value>]
[--property-id <value>]
[--property-alias <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--asset-id (string)

The ID of the asset.

--property-id (string)

The ID of the asset property.

--property-alias (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 .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To retrieve an asset property's current value

The following get-asset-property-value example retrieves a wind turbine asset's current total power.

aws iotsitewise get-asset-property-value \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE


    "propertyValue": {
        "value": {
            "doubleValue": 6890.8677520453875
        "timestamp": {
            "timeInSeconds": 1580853000,
            "offsetInNanos": 0
        "quality": "GOOD"

For more information, see Querying current asset property values in the AWS IoT SiteWise User Guide.


propertyValue -> (structure)

The current asset property value.

value -> (structure)

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 -> (double)

Asset property data of type double (floating point number).

booleanValue -> (boolean)

Asset property data of type Boolean (true or false).

timestamp -> (structure)

The timestamp of the asset property value.

timeInSeconds -> (long)

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.