Amazon Lookout for Equipment is no longer open to new customers.
Existing customers can continue to use the service as normal.
For capabilities similar to Amazon Lookout for Equipment see our
blog post
ListSensorStatistics
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
{
"DatasetName": "string",
"IngestionJobId": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
The request accepts the following data in JSON format.
- DatasetName
-
The name of the dataset associated with the list of Sensor Statistics.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$Required: Yes
- IngestionJobId
-
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.
Type: String
Length Constraints: Maximum length of 32.
Pattern:
[A-Fa-f0-9]{0,32}Required: No
- MaxResults
-
Specifies the maximum number of sensors for which to retrieve statistics.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- NextToken
-
An opaque pagination token indicating where to continue the listing of sensor statistics.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}Required: No
Response Syntax
{
"NextToken": "string",
"SensorStatisticsSummaries": [
{
"CategoricalValues": {
"NumberOfCategory": number,
"Status": "string"
},
"ComponentName": "string",
"DataEndTime": number,
"DataExists": boolean,
"DataStartTime": number,
"DuplicateTimestamps": {
"Count": number,
"Percentage": number
},
"InvalidDateEntries": {
"Count": number,
"Percentage": number
},
"InvalidValues": {
"Count": number,
"Percentage": number
},
"LargeTimestampGaps": {
"MaxTimestampGapInDays": number,
"NumberOfLargeTimestampGaps": number,
"Status": "string"
},
"MissingValues": {
"Count": number,
"Percentage": number
},
"MonotonicValues": {
"Monotonicity": "string",
"Status": "string"
},
"MultipleOperatingModes": {
"Status": "string"
},
"SensorName": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
An opaque pagination token indicating where to continue the listing of sensor statistics.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192} - SensorStatisticsSummaries
-
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.
Type: Array of SensorStatisticsSummary objects
Errors
- AccessDeniedException
-
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400
- InternalServerException
-
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource requested could not be found. Verify the resource ID and retry your request.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
