GetWirelessDeviceStatisticsCommand

Suggest an Edit

Gets operating information about a wireless device.

Example Syntax

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

import { IoTWirelessClient, GetWirelessDeviceStatisticsCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, GetWirelessDeviceStatisticsCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // GetWirelessDeviceStatisticsRequest
  WirelessDeviceId: "STRING_VALUE", // required
};
const command = new GetWirelessDeviceStatisticsCommand(input);
const response = await client.send(command);
// { // GetWirelessDeviceStatisticsResponse
//   WirelessDeviceId: "STRING_VALUE",
//   LastUplinkReceivedAt: "STRING_VALUE",
//   LoRaWAN: { // LoRaWANDeviceMetadata
//     DevEui: "STRING_VALUE",
//     FPort: Number("int"),
//     DataRate: Number("int"),
//     Frequency: Number("int"),
//     Timestamp: "STRING_VALUE",
//     Gateways: [ // LoRaWANGatewayMetadataList
//       { // LoRaWANGatewayMetadata
//         GatewayEui: "STRING_VALUE",
//         Snr: Number("double"),
//         Rssi: Number("double"),
//       },
//     ],
//     PublicGateways: [ // LoRaWANPublicGatewayMetadataList
//       { // LoRaWANPublicGatewayMetadata
//         ProviderNetId: "STRING_VALUE",
//         Id: "STRING_VALUE",
//         Rssi: Number("double"),
//         Snr: Number("double"),
//         RfRegion: "STRING_VALUE",
//         DlAllowed: true || false,
//       },
//     ],
//   },
//   Sidewalk: { // SidewalkDeviceMetadata
//     Rssi: Number("int"),
//     BatteryLevel: "normal" || "low" || "critical",
//     Event: "discovered" || "lost" || "ack" || "nack" || "passthrough",
//     DeviceState: "Provisioned" || "RegisteredNotSeen" || "RegisteredReachable" || "RegisteredUnreachable",
//   },
// };

GetWirelessDeviceStatisticsCommand Input

See GetWirelessDeviceStatisticsCommandInput for more details

Parameter
Type
Description
WirelessDeviceId
Required
string | undefined

The ID of the wireless device for which to get the data.

GetWirelessDeviceStatisticsCommand Output

See GetWirelessDeviceStatisticsCommandOutput for details

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

The date and time when the most recent uplink was received.

This value is only valid for 3 months.

LoRaWAN
LoRaWANDeviceMetadata | undefined

Information about the wireless device's operations.

Sidewalk
SidewalkDeviceMetadata | undefined

MetaData for Sidewalk device.

WirelessDeviceId
string | undefined

The ID of the wireless device.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have permission to perform this action.

InternalServerException
server

An unexpected error occurred while processing a request.

ResourceNotFoundException
client

Resource does not exist.

ThrottlingException
client

The request was denied because it exceeded the allowed API request rate.

ValidationException
client

The input did not meet the specified constraints.

IoTWirelessServiceException
Base exception class for all service exceptions from IoTWireless service.