[ aws . iotwireless ]

get-wireless-device

Description

Gets information about a wireless device.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-wireless-device
--identifier <value>
--identifier-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--identifier (string)

The identifier of the wireless device to get.

--identifier-type (string)

The type of identifier used in identifier .

Possible values:

• WirelessDeviceId

• DevEui

• ThingName

• SidewalkManufacturingSn

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about the wireless device

The following get-wireless-device example lists the available widgets in your AWS account.

aws iotwireless get-wireless-device \
    --identifier "1ffd32c8-8130-4194-96df-622f072a315f" \
    --identifier-type WirelessDeviceID

Output:

{
    "Name": "myLoRaWANDevice",
    "ThingArn": "arn:aws:iot:us-east-1:123456789012:thing/44b87eb4-9bce-423d-b5fc-973f5ecc358b",
    "DestinationName": "IoTWirelessDestination",
    "Id": "1ffd32c8-8130-4194-96df-622f072a315f",
    "ThingName": "44b87eb4-9bce-423d-b5fc-973f5ecc358b",
    "Type": "LoRaWAN",
    "LoRaWAN": {
        "DeviceProfileId": "ab0c23d3-b001-45ef-6a01-2bc3de4f5333",
        "ServiceProfileId": "fe98dc76-cd12-001e-2d34-5550432da100",
        "OtaaV1_1": {
            "AppKey": "3f4ca100e2fc675ea123f4eb12c4a012",
            "JoinEui": "b4c231a359bc2e3d",
            "NwkKey": "01c3f004a2d6efffe32c4eda14bcd2b4"
        },
        "DevEui": "ac12efc654d23fc2"
    },
    "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessDevice/1ffd32c8-8130-4194-96df-622f072a315f",
    "Description": "My LoRaWAN wireless device"
}

For more information, see Connecting devices and gateways to AWS IoT Core for LoRaWAN in the AWS IoT Developers Guide.

Output

Type -> (string)

The wireless device type.

Name -> (string)

The name of the resource.

Description -> (string)

The description of the resource.

DestinationName -> (string)

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

Id -> (string)

The ID of the wireless device.

Arn -> (string)

The Amazon Resource Name of the resource.

ThingName -> (string)

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)

The ARN of the thing associated with the wireless device.

LoRaWAN -> (structure)

Information about the wireless device.

DevEui -> (string)

The DevEUI value.

DeviceProfileId -> (string)

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

ServiceProfileId -> (string)

The ID of the service profile.

OtaaV1_1 -> (structure)

OTAA device object for v1.1 for create APIs

AppKey -> (string)

The AppKey value.

NwkKey -> (string)

The NwkKey value.

JoinEui -> (string)

The JoinEUI value.

OtaaV1_0_x -> (structure)

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

AppKey -> (string)

The AppKey value.

AppEui -> (string)

The AppEUI value.

GenAppKey -> (string)

The GenAppKey value.

AbpV1_1 -> (structure)

ABP device object for create APIs for v1.1

DevAddr -> (string)

The DevAddr value.

SessionKeys -> (structure)

Session keys for ABP v1.1

FNwkSIntKey -> (string)

The FNwkSIntKey value.

SNwkSIntKey -> (string)

The SNwkSIntKey value.

NwkSEncKey -> (string)

The NwkSEncKey value.

AppSKey -> (string)

The AppSKey value.

FCntStart -> (integer)

The FCnt init value.

AbpV1_0_x -> (structure)

LoRaWAN object for create APIs

DevAddr -> (string)

The DevAddr value.

SessionKeys -> (structure)

Session keys for ABP v1.0.x

NwkSKey -> (string)

The NwkSKey value.

AppSKey -> (string)

The AppSKey value.

FCntStart -> (integer)

The FCnt init value.

FPorts -> (structure)

List of FPort assigned for different LoRaWAN application packages to use

Fuota -> (integer)

The Fport value.

Multicast -> (integer)

The Fport value.

ClockSync -> (integer)

The Fport value.

Sidewalk -> (structure)

Sidewalk device object.

AmazonId -> (string)

The Sidewalk Amazon ID.

SidewalkId -> (string)

The sidewalk device identification.

SidewalkManufacturingSn -> (string)

The Sidewalk manufacturing series number.

DeviceCertificates -> (list)

The sidewalk device certificates for Ed25519 and P256r1.

(structure)

List of sidewalk certificates.

SigningAlg -> (string)

The certificate chain algorithm provided by sidewalk.

Value -> (string)

The value of the chosen sidewalk certificate.