Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . iotwireless ]
get-wireless-device-statistics¶
Synopsis¶
get-wireless-device-statistics
--wireless-device-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--wireless-device-id (string)
The ID of the wireless device for which to get the data.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To get operating information about a wireless device
The following get-wireless-device-statistics example gets operating information about a wireless device.
aws iotwireless get-wireless-device-statistics \
--wireless-device-id "1ffd32c8-8130-4194-96df-622f072a315f"
Output:
{
"WirelessDeviceId": "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¶
WirelessDeviceId -> (string)
The ID of the wireless device.
LastUplinkReceivedAt -> (string)
The date and time when the most recent uplink was received.
Note
This value is only valid for 3 months.
LoRaWAN -> (structure)
Information about the wireless device's operations.
DevEui -> (string)
The DevEUI value.FPort -> (integer)
The FPort value.DataRate -> (integer)
The DataRate value.Frequency -> (integer)
The device's channel frequency in Hz.Timestamp -> (string)
The date and time of the metadata.Gateways -> (list)
Information about the gateways accessed by the device.
(structure)
LoRaWAN gateway metatdata.
GatewayEui -> (string)
The gateway's EUI value.Snr -> (double)
The SNR value.Rssi -> (double)
The RSSI value.PublicGateways -> (list)
Information about the LoRaWAN public network accessed by the device.
(structure)
LoRaWAN public gateway metadata.
ProviderNetId -> (string)
The ID of the LoRaWAN public network provider.Id -> (string)
The ID of the gateways that are operated by the network provider.Rssi -> (double)
The RSSI (received signal strength indicator) value.Snr -> (double)
The SNR (signal to noise ratio) value.RfRegion -> (string)
The frequency band (RFRegion) value.DlAllowed -> (boolean)
Boolean that indicates whether downlink is allowed using the network.
Sidewalk -> (structure)
MetaData for Sidewalk device.
Rssi -> (integer)
The RSSI value.BatteryLevel -> (string)
Sidewalk device battery level.Event -> (string)
Sidewalk device status notification.DeviceState -> (string)
Device state defines the device status of sidewalk device.