ListSensorStatisticsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LookoutEquipmentClient, ListSensorStatisticsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, ListSensorStatisticsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // ListSensorStatisticsRequest
  DatasetName: "STRING_VALUE", // required
  IngestionJobId: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListSensorStatisticsCommand(input);
const response = await client.send(command);
// { // ListSensorStatisticsResponse
//   SensorStatisticsSummaries: [ // SensorStatisticsSummaries
//     { // SensorStatisticsSummary
//       ComponentName: "STRING_VALUE",
//       SensorName: "STRING_VALUE",
//       DataExists: true || false,
//       MissingValues: { // CountPercent
//         Count: Number("int"), // required
//         Percentage: Number("float"), // required
//       },
//       InvalidValues: {
//         Count: Number("int"), // required
//         Percentage: Number("float"), // required
//       },
//       InvalidDateEntries: {
//         Count: Number("int"), // required
//         Percentage: Number("float"), // required
//       },
//       DuplicateTimestamps: {
//         Count: Number("int"), // required
//         Percentage: Number("float"), // required
//       },
//       CategoricalValues: { // CategoricalValues
//         Status: "POTENTIAL_ISSUE_DETECTED" || "NO_ISSUE_DETECTED", // required
//         NumberOfCategory: Number("int"),
//       },
//       MultipleOperatingModes: { // MultipleOperatingModes
//         Status: "POTENTIAL_ISSUE_DETECTED" || "NO_ISSUE_DETECTED", // required
//       },
//       LargeTimestampGaps: { // LargeTimestampGaps
//         Status: "POTENTIAL_ISSUE_DETECTED" || "NO_ISSUE_DETECTED", // required
//         NumberOfLargeTimestampGaps: Number("int"),
//         MaxTimestampGapInDays: Number("int"),
//       },
//       MonotonicValues: { // MonotonicValues
//         Status: "POTENTIAL_ISSUE_DETECTED" || "NO_ISSUE_DETECTED", // required
//         Monotonicity: "DECREASING" || "INCREASING" || "STATIC",
//       },
//       DataStartTime: new Date("TIMESTAMP"),
//       DataEndTime: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListSensorStatisticsCommand Input

See ListSensorStatisticsCommandInput for more details

Parameter
Type
Description
DatasetName
Required
string | undefined

The name of the dataset associated with the list of Sensor Statistics.

IngestionJobId
string | undefined

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
number | undefined

Specifies the maximum number of sensors for which to retrieve statistics.

NextToken
string | undefined

An opaque pagination token indicating where to continue the listing of sensor statistics.

ListSensorStatisticsCommand Output

See ListSensorStatisticsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

An opaque pagination token indicating where to continue the listing of sensor statistics.

SensorStatisticsSummaries
SensorStatisticsSummary[] | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

The request could not be completed because you do not have access to the resource.

InternalServerException
server

Processing of the request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

LookoutEquipmentServiceException
Base exception class for all service exceptions from LookoutEquipment service.