/wireless-devices/{Identifier}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Gets information about a wireless device.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/wireless-devices/?identifierType='

Response Example

200 - Example 1

{
    "Type": "Sidewalk",
    "Name": "string",
    "Description": "string",
    "DestinationName": "string",
    "Id": "string",
    "Arn": "string",
    "ThingName": "string",
    "ThingArn": "string",
    "LoRaWAN": {
        "DevEui": "string",
        "DeviceProfileId": "string",
        "ServiceProfileId": "string",
        "OtaaV1_1": {
            "AppKey": "string",
            "NwkKey": "string",
            "JoinEui": "string"
        },
        "OtaaV1_0_x": {
            "AppKey": "string",
            "AppEui": "string"
        },
        "AbpV1_1": {
            "DevAddr": "string",
            "SessionKeys": {
                "FNwkSIntKey": "string",
                "SNwkSIntKey": "string",
                "NwkSEncKey": "string",
                "AppSKey": "string"
            }
        },
        "AbpV1_0_x": {
            "DevAddr": "string",
            "SessionKeys": {
                "NwkSKey": "string",
                "AppSKey": "string"
            }
        }
    },
    "Sidewalk": {
        "AmazonId": "string",
        "SidewalkId": "string",
        "SidewalkManufacturingSn": "string",
        "DeviceCertificates": []
    }
}

Request

Path Params

Identifier

string

required

The identifier of the wireless device to get.

Query Params

identifierType

string

required

The type of identifier used in identifier.

Responses

🟢200Success

application/json

Body

Type

enum<string>

optional

The wireless device type.

Allowed values:

SidewalkLoRaWAN

Name

string

optional

The name of the resource.

<= 256 characters

Description

string

optional

The description of the resource.

<= 2048 characters

DestinationName

string

optional

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

<= 128 characters

Match pattern:

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

string

optional

The ID of the wireless device.

<= 256 characters

Arn

string

optional

The Amazon Resource Name of the resource.

ThingName

string

optional

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

ThingArn

string

optional

The ARN of the thing associated with the wireless device.

LoRaWAN

object

optional

Information about the wireless device.

DevEui

string

optional

The DevEUI value.

Match pattern:

[a-fA-F0-9]{16}

DeviceProfileId

string

optional

The ID of the device profile for the new wireless device.

<= 256 characters

ServiceProfileId

string

optional

The ID of the service profile.

<= 256 characters

OtaaV1_1

object

optional

OTAA device object for v1.1 for create APIs

OtaaV1_0_x

object

optional

OTAA device object for create APIs for v1.0.x

AbpV1_1

object

optional

ABP device object for create APIs for v1.1

AbpV1_0_x

object

optional

LoRaWAN object for create APIs

Sidewalk

object

optional

Sidewalk device object.

AmazonId

string

AmazonId

optional

The Sidewalk Amazon ID.

<= 2048 characters

SidewalkId

string

optional

The sidewalk device identification.

<= 256 characters

SidewalkManufacturingSn

string

optional

The Sidewalk manufacturing series number.

<= 64 characters

DeviceCertificates

array[object (CertificateList) {2}]

optional

The sidewalk device certificates for Ed25519 and P256r1.

🟠480ValidationException

🟠481AccessDeniedException

🟠482ResourceNotFoundException

🟠483InternalServerException

🟠484ThrottlingException

Modified at 2022-09-10 19:46:41

/dynamic-thing-groups/{thingGroupName}