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

*****************************
get_asset_property_aggregates
*****************************



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

  

  Gets aggregated values for an asset property. For more information, see `Querying aggregates <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates>`__ 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/GetAssetPropertyAggregates>`_  


  **Request Syntax**
  ::

    response = client.get_asset_property_aggregates(
        assetId='string',
        propertyId='string',
        propertyAlias='string',
        aggregateTypes=[
            'AVERAGE'|'COUNT'|'MAXIMUM'|'MINIMUM'|'SUM'|'STANDARD_DEVIATION',
        ],
        resolution='string',
        qualities=[
            'GOOD'|'BAD'|'UNCERTAIN',
        ],
        startDate=datetime(2015, 1, 1),
        endDate=datetime(2015, 1, 1),
        timeOrdering='ASCENDING'|'DESCENDING',
        nextToken='string',
        maxResults=123
    )
    
  :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*.

    

  
  :type aggregateTypes: list
  :param aggregateTypes: **[REQUIRED]** 

    The data aggregating function.

    

  
    - *(string) --* 

    

  :type resolution: string
  :param resolution: **[REQUIRED]** 

    The time interval over which to aggregate data.

    

  
  :type qualities: list
  :param qualities: 

    The quality by which to filter asset data.

    

  
    - *(string) --* 

    

  :type startDate: datetime
  :param startDate: **[REQUIRED]** 

    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

    

  
  :type endDate: datetime
  :param endDate: **[REQUIRED]** 

    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

    

  
  :type timeOrdering: string
  :param timeOrdering: 

    The chronological sorting order of the requested information.

     

    Default: ``ASCENDING``

    

  
  :type nextToken: string
  :param nextToken: 

    The token to be used for the next set of paginated results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

     

    
    * The size of the result set is equal to 1 MB.
     
    * The number of data points in the result set is equal to the value of ``maxResults``. The maximum value of ``maxResults`` is 2500.
    

    

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

    
    ::

      {
          'aggregatedValues': [
              {
                  'timestamp': datetime(2015, 1, 1),
                  'quality': 'GOOD'|'BAD'|'UNCERTAIN',
                  'value': {
                      'average': 123.0,
                      'count': 123.0,
                      'maximum': 123.0,
                      'minimum': 123.0,
                      'sum': 123.0,
                      'standardDeviation': 123.0
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **aggregatedValues** *(list) --* 

        The requested aggregated values.

        
        

        - *(dict) --* 

          Contains aggregated asset property values (for example, average, minimum, and maximum).

          
          

          - **timestamp** *(datetime) --* 

            The date the aggregating computations occurred, in Unix epoch time.

            
          

          - **quality** *(string) --* 

            The quality of the aggregated data.

            
          

          - **value** *(dict) --* 

            The value of the aggregates.

            
            

            - **average** *(float) --* 

              The average (mean) value of the time series over a time interval window.

              
            

            - **count** *(float) --* 

              The count of data points in the time series over a time interval window.

              
            

            - **maximum** *(float) --* 

              The maximum value of the time series over a time interval window.

              
            

            - **minimum** *(float) --* 

              The minimum value of the time series over a time interval window.

              
            

            - **sum** *(float) --* 

              The sum of the time series over a time interval window.

              
            

            - **standardDeviation** *(float) --* 

              The standard deviation of the time series over a time interval window.

              
        
      
    
      

      - **nextToken** *(string) --* 

        The token for the next set of results, or null if there are no additional results.

        
  
  **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`

  