Class ListSensorStatisticsCommandProtected

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

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",
// };

Param

ListSensorStatisticsCommandInput

Returns

ListSensorStatisticsCommandOutput

See

• ListSensorStatisticsCommandInput for command's input shape.
• ListSensorStatisticsCommandOutput for command's response shape.
• config for LookoutEquipmentClient's config shape.

Throws

AccessDeniedException (client fault)

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

Throws

InternalServerException (server fault)

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

Throws

ResourceNotFoundException (client fault)

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

Throws

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

ValidationException (client fault)

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

Throws

LookoutEquipmentServiceException

Base exception class for all service exceptions from LookoutEquipment service.