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

****************************
GetAssetPropertyValueHistory
****************************



.. py:class:: IoTSiteWise.Paginator.GetAssetPropertyValueHistory

  ::

    
    paginator = client.get_paginator('get_asset_property_value_history')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assetId='string',
          propertyId='string',
          propertyAlias='string',
          startDate=datetime(2015, 1, 1),
          endDate=datetime(2015, 1, 1),
          qualities=[
              'GOOD'|'BAD'|'UNCERTAIN',
          ],
          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 startDate: datetime
    :param startDate: 

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

      

    
    :type endDate: datetime
    :param endDate: 

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

      

    
    :type qualities: list
    :param qualities: 

      The quality by which to filter asset data.

      

    
      - *(string) --* 

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

      
      ::

        {
            'assetPropertyValueHistory': [
                {
                    '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'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **assetPropertyValueHistory** *(list) --* 

          The asset property's value history.

          
          

          - *(dict) --* 

            Contains asset property value information.

            
            

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

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    