:doc:`IoTSiteWise <../../iotsitewise>` / Paginator / GetAssetPropertyAggregates

**************************
GetAssetPropertyAggregates
**************************



.. py:class:: IoTSiteWise.Paginator.GetAssetPropertyAggregates

  ::

    
    paginator = client.get_paginator('get_asset_property_aggregates')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoTSiteWise.Client.get_asset_property_aggregates`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          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',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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*.

      

    
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    