LookoutEquipment / Client / list_sensor_statistics

list_sensor_statistics#

LookoutEquipment.Client.list_sensor_statistics(**kwargs)#

Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.

Request Syntax

response = client.list_sensor_statistics(
    DatasetName='string',
    IngestionJobId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

DatasetName (string) –
[REQUIRED]

The name of the dataset associated with the list of Sensor Statistics.
IngestionJobId (string) – The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.
MaxResults (integer) – Specifies the maximum number of sensors for which to retrieve statistics.
NextToken (string) – An opaque pagination token indicating where to continue the listing of sensor statistics.

Return type:

dict

Returns:

Response Syntax

{
    'SensorStatisticsSummaries': [
        {
            'ComponentName': 'string',
            'SensorName': 'string',
            'DataExists': True|False,
            'MissingValues': {
                'Count': 123,
                'Percentage': ...
            },
            'InvalidValues': {
                'Count': 123,
                'Percentage': ...
            },
            'InvalidDateEntries': {
                'Count': 123,
                'Percentage': ...
            },
            'DuplicateTimestamps': {
                'Count': 123,
                'Percentage': ...
            },
            'CategoricalValues': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED',
                'NumberOfCategory': 123
            },
            'MultipleOperatingModes': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED'
            },
            'LargeTimestampGaps': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED',
                'NumberOfLargeTimestampGaps': 123,
                'MaxTimestampGapInDays': 123
            },
            'MonotonicValues': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED',
                'Monotonicity': 'DECREASING'|'INCREASING'|'STATIC'
            },
            'DataStartTime': datetime(2015, 1, 1),
            'DataEndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- SensorStatisticsSummaries (list) –
  
  Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.
  - (dict) –
    
    Summary of ingestion statistics like whether data exists, number of missing values, number of invalid values and so on related to the particular sensor.
    - ComponentName (string) –
      
      Name of the component to which the particular sensor belongs for which the statistics belong to.
    - SensorName (string) –
      
      Name of the sensor that the statistics belong to.
    - DataExists (boolean) –
      
      Parameter that indicates whether data exists for the sensor that the statistics belong to.
    - MissingValues (dict) –
      
      Parameter that describes the total number of, and percentage of, values that are missing for the sensor that the statistics belong to.
      - Count (integer) –
        
        Indicates the count of occurences of the given statistic.
      - Percentage (float) –
        
        Indicates the percentage of occurances of the given statistic.
    - InvalidValues (dict) –
      
      Parameter that describes the total number of, and percentage of, values that are invalid for the sensor that the statistics belong to.
      - Count (integer) –
        
        Indicates the count of occurences of the given statistic.
      - Percentage (float) –
        
        Indicates the percentage of occurances of the given statistic.
    - InvalidDateEntries (dict) –
      
      Parameter that describes the total number of invalid date entries associated with the sensor that the statistics belong to.
      - Count (integer) –
        
        Indicates the count of occurences of the given statistic.
      - Percentage (float) –
        
        Indicates the percentage of occurances of the given statistic.
    - DuplicateTimestamps (dict) –
      
      Parameter that describes the total number of duplicate timestamp records associated with the sensor that the statistics belong to.
      - Count (integer) –
        
        Indicates the count of occurences of the given statistic.
      - Percentage (float) –
        
        Indicates the percentage of occurances of the given statistic.
    - CategoricalValues (dict) –
      
      Parameter that describes potential risk about whether data associated with the sensor is categorical.
      - Status (string) –
        
        Indicates whether there is a potential data issue related to categorical values.
      - NumberOfCategory (integer) –
        
        Indicates the number of categories in the data.
    - MultipleOperatingModes (dict) –
      
      Parameter that describes potential risk about whether data associated with the sensor has more than one operating mode.
      - Status (string) –
        
        Indicates whether there is a potential data issue related to having multiple operating modes.
    - LargeTimestampGaps (dict) –
      
      Parameter that describes potential risk about whether data associated with the sensor contains one or more large gaps between consecutive timestamps.
      - Status (string) –
        
        Indicates whether there is a potential data issue related to large gaps in timestamps.
      - NumberOfLargeTimestampGaps (integer) –
        
        Indicates the number of large timestamp gaps, if there are any.
      - MaxTimestampGapInDays (integer) –
        
        Indicates the size of the largest timestamp gap, in days.
    - MonotonicValues (dict) –
      
      Parameter that describes potential risk about whether data associated with the sensor is mostly monotonic.
      - Status (string) –
        
        Indicates whether there is a potential data issue related to having monotonic values.
      - Monotonicity (string) –
        
        Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.
    - DataStartTime (datetime) –
      
      Indicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.
    - DataEndTime (datetime) –
      
      Indicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.
- NextToken (string) –
  
  An opaque pagination token indicating where to continue the listing of sensor statistics.

Exceptions

LookoutEquipment.Client.exceptions.ValidationException
LookoutEquipment.Client.exceptions.ResourceNotFoundException
LookoutEquipment.Client.exceptions.ThrottlingException
LookoutEquipment.Client.exceptions.AccessDeniedException
LookoutEquipment.Client.exceptions.InternalServerException