[ aws . iotwireless ]

list-wireless-devices

Description

Lists the wireless devices registered to your AWS account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-wireless-devices
[--max-results <value>]
[--next-token <value>]
[--destination-name <value>]
[--device-profile-id <value>]
[--service-profile-id <value>]
[--wireless-device-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of results to return in this operation.

--next-token (string)

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

--destination-name (string)

A filter to list only the wireless devices that use this destination.

--device-profile-id (string)

A filter to list only the wireless devices that use this device profile.

--service-profile-id (string)

A filter to list only the wireless devices that use this service profile.

--wireless-device-type (string)

A filter to list only the wireless devices that use this wireless device type.

Possible values:

• Sidewalk

• LoRaWAN

--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 list the available wireless devices

The following list-wireless-devices example lists the available wireless devices registered to your AWS account.

aws iotwireless list-wireless-devices

Output:

{
    "WirelessDeviceList": [
        {
            "Name": "myLoRaWANDevice",
            "DestinationName": "IoTWirelessDestination",
            "Id": "1ffd32c8-8130-4194-96df-622f072a315f",
            "Type": "LoRaWAN",
            "LoRaWAN": {
                "DevEui": "ac12efc654d23fc2"
            },
            "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessDevice/1ffd32c8-8130-4194-96df-622f072a315f"
        }
    ]
}

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

Output

NextToken -> (string)

The token to use to get the next set of results, or null if there are no additional results.

WirelessDeviceList -> (list)

The ID of the wireless device.

(structure)

Information about a wireless device’s operation.

Arn -> (string)

The Amazon Resource Name of the resource.

Id -> (string)

The ID of the wireless device reporting the data.

Type -> (string)

The wireless device type.

Name -> (string)

The name of the resource.

DestinationName -> (string)

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

LastUplinkReceivedAt -> (string)

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

LoRaWAN -> (structure)

LoRaWAN device info.

DevEui -> (string)

The DevEUI value.

Sidewalk -> (structure)

The Sidewalk account credentials.

AmazonId -> (string)

The Sidewalk Amazon ID.