:doc:`IoTSiteWise <../../iotsitewise>` / Client / get_asset_property_value

************************
get_asset_property_value
************************



.. py:method:: IoTSiteWise.Client.get_asset_property_value(**kwargs)

  

  Gets an asset property's current value. For more information, see `Querying current values <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#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 <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html>`__.
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyValue>`_  


  **Request Syntax**
  ::

    response = client.get_asset_property_value(
        assetId='string',
        propertyId='string',
        propertyAlias='string'
    )
    
  :type assetId: string
  :param assetId: 

    The ID of the asset, in UUID format.

    

  
  :type propertyId: string
  :param propertyId: 

    The ID of the asset property, in UUID format.

    

  
  :type propertyAlias: string
  :param propertyAlias: 

    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 <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html>`__ in the *IoT SiteWise User Guide*.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'propertyValue': {
              'value': {
                  'stringValue': 'string',
                  'integerValue': 123,
                  'doubleValue': 123.0,
                  'booleanValue': True|False,
                  'nullValue': {
                      'valueType': 'D'|'B'|'S'|'I'|'U'
                  }
              },
              '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). The allowed pattern: "^$|[^\u0000-\u001F\u007F]+". The max length is 1024.

            
          

          - **integerValue** *(integer) --* 

            Asset property data of type integer (whole number).

            
          

          - **doubleValue** *(float) --* 

            Asset property data of type double (floating point number). The min value is -10^10. The max value is 10^10. Double.NaN is allowed.

            
          

          - **booleanValue** *(boolean) --* 

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

            
          

          - **nullValue** *(dict) --* 

            The type of null asset property data with BAD and UNCERTAIN qualities.

            
            

            - **valueType** *(string) --* 

              The type of null asset property data.

              
        
      
        

        - **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**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ServiceUnavailableException`

  