GetWirelessDeviceCommand

Suggest an Edit

Gets information about a wireless device.

Example Syntax

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

import { IoTWirelessClient, GetWirelessDeviceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, GetWirelessDeviceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // GetWirelessDeviceRequest
  Identifier: "STRING_VALUE", // required
  IdentifierType: "WirelessDeviceId" || "DevEui" || "ThingName" || "SidewalkManufacturingSn", // required
};
const command = new GetWirelessDeviceCommand(input);
const response = await client.send(command);
// { // GetWirelessDeviceResponse
//   Type: "Sidewalk" || "LoRaWAN",
//   Name: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   DestinationName: "STRING_VALUE",
//   Id: "STRING_VALUE",
//   Arn: "STRING_VALUE",
//   ThingName: "STRING_VALUE",
//   ThingArn: "STRING_VALUE",
//   LoRaWAN: { // LoRaWANDevice
//     DevEui: "STRING_VALUE",
//     DeviceProfileId: "STRING_VALUE",
//     ServiceProfileId: "STRING_VALUE",
//     OtaaV1_1: { // OtaaV1_1
//       AppKey: "STRING_VALUE",
//       NwkKey: "STRING_VALUE",
//       JoinEui: "STRING_VALUE",
//     },
//     OtaaV1_0_x: { // OtaaV1_0_x
//       AppKey: "STRING_VALUE",
//       AppEui: "STRING_VALUE",
//       JoinEui: "STRING_VALUE",
//       GenAppKey: "STRING_VALUE",
//     },
//     AbpV1_1: { // AbpV1_1
//       DevAddr: "STRING_VALUE",
//       SessionKeys: { // SessionKeysAbpV1_1
//         FNwkSIntKey: "STRING_VALUE",
//         SNwkSIntKey: "STRING_VALUE",
//         NwkSEncKey: "STRING_VALUE",
//         AppSKey: "STRING_VALUE",
//       },
//       FCntStart: Number("int"),
//     },
//     AbpV1_0_x: { // AbpV1_0_x
//       DevAddr: "STRING_VALUE",
//       SessionKeys: { // SessionKeysAbpV1_0_x
//         NwkSKey: "STRING_VALUE",
//         AppSKey: "STRING_VALUE",
//       },
//       FCntStart: Number("int"),
//     },
//     FPorts: { // FPorts
//       Fuota: Number("int"),
//       Multicast: Number("int"),
//       ClockSync: Number("int"),
//       Positioning: { // Positioning
//         ClockSync: Number("int"),
//         Stream: Number("int"),
//         Gnss: Number("int"),
//       },
//       Applications: [ // Applications
//         { // ApplicationConfig
//           FPort: Number("int"),
//           Type: "SemtechGeolocation",
//           DestinationName: "STRING_VALUE",
//         },
//       ],
//     },
//   },
//   Sidewalk: { // SidewalkDevice
//     AmazonId: "STRING_VALUE",
//     SidewalkId: "STRING_VALUE",
//     SidewalkManufacturingSn: "STRING_VALUE",
//     DeviceCertificates: [ // DeviceCertificateList
//       { // CertificateList
//         SigningAlg: "Ed25519" || "P256r1", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     PrivateKeys: [ // PrivateKeysList
//       {
//         SigningAlg: "Ed25519" || "P256r1", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     DeviceProfileId: "STRING_VALUE",
//     CertificateId: "STRING_VALUE",
//     Status: "PROVISIONED" || "REGISTERED" || "ACTIVATED" || "UNKNOWN",
//   },
//   Positioning: "Enabled" || "Disabled",
// };

GetWirelessDeviceCommand Input

See GetWirelessDeviceCommandInput for more details

Parameter
Type
Description
Identifier
Required
string | undefined

The identifier of the wireless device to get.

IdentifierType
Required
WirelessDeviceIdType | undefined

The type of identifier used in identifier.

GetWirelessDeviceCommand Output

See GetWirelessDeviceCommandOutput for details

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

The Amazon Resource Name of the resource.

Description
string | undefined

The description of the resource.

DestinationName
string | undefined

The name of the destination to which the device is assigned.

Id
string | undefined

The ID of the wireless device.

LoRaWAN
LoRaWANDevice | undefined

Information about the wireless device.

Name
string | undefined

The name of the resource.

Positioning
PositioningConfigStatus | undefined

FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

Sidewalk
SidewalkDevice | undefined

Sidewalk device object.

ThingArn
string | undefined

The ARN of the thing associated with the wireless device.

ThingName
string | undefined

The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.

Type
WirelessDeviceType | undefined

The wireless device type.

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.