GetWirelessDevice - AWS IoT Wireless
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetWirelessDevice

Gets information about a wireless device.

Request Syntax

GET /wireless-devices/Identifier?identifierType=IdentifierType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

The identifier of the wireless device to get.

Length Constraints: Maximum length of 256.

Required: Yes

IdentifierType

The type of identifier used in identifier.

Valid Values: WirelessDeviceId | DevEui | ThingName | SidewalkManufacturingSn

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Description": "string",
   "DestinationName": "string",
   "Id": "string",
   "LoRaWAN": { 
      "AbpV1_0_x": { 
         "DevAddr": "string",
         "FCntStart": number,
         "SessionKeys": { 
            "AppSKey": "string",
            "NwkSKey": "string"
         }
      },
      "AbpV1_1": { 
         "DevAddr": "string",
         "FCntStart": number,
         "SessionKeys": { 
            "AppSKey": "string",
            "FNwkSIntKey": "string",
            "NwkSEncKey": "string",
            "SNwkSIntKey": "string"
         }
      },
      "DevEui": "string",
      "DeviceProfileId": "string",
      "FPorts": { 
         "Applications": [ 
            { 
               "DestinationName": "string",
               "FPort": number,
               "Type": "string"
            }
         ],
         "ClockSync": number,
         "Fuota": number,
         "Multicast": number,
         "Positioning": { 
            "ClockSync": number,
            "Gnss": number,
            "Stream": number
         }
      },
      "OtaaV1_0_x": { 
         "AppEui": "string",
         "AppKey": "string",
         "GenAppKey": "string",
         "JoinEui": "string"
      },
      "OtaaV1_1": { 
         "AppKey": "string",
         "JoinEui": "string",
         "NwkKey": "string"
      },
      "ServiceProfileId": "string"
   },
   "Name": "string",
   "Positioning": "string",
   "Sidewalk": { 
      "AmazonId": "string",
      "CertificateId": "string",
      "DeviceCertificates": [ 
         { 
            "SigningAlg": "string",
            "Value": "string"
         }
      ],
      "DeviceProfileId": "string",
      "PrivateKeys": [ 
         { 
            "SigningAlg": "string",
            "Value": "string"
         }
      ],
      "SidewalkId": "string",
      "SidewalkManufacturingSn": "string",
      "Status": "string"
   },
   "ThingArn": "string",
   "ThingName": "string",
   "Type": "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.

Arn

The Amazon Resource Name of the resource.

Type: String

Description

The description of the resource.

Type: String

Length Constraints: Maximum length of 2048.

DestinationName

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

Type: String

Length Constraints: Maximum length of 128.

Pattern: [a-zA-Z0-9-_]+

Id

The ID of the wireless device.

Type: String

Length Constraints: Maximum length of 256.

LoRaWAN

Information about the wireless device.

Type: LoRaWANDevice object

Name

The name of the resource.

Type: String

Length Constraints: Maximum length of 256.

Positioning

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

Type: String

Valid Values: Enabled | Disabled

Sidewalk

Sidewalk device object.

Type: SidewalkDevice object

ThingArn

The ARN of the thing associated with the wireless device.

Type: String

ThingName

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

Type: String

Type

The wireless device type.

Type: String

Valid Values: Sidewalk | LoRaWAN

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: