update-wireless-device¶

Description¶

Updates properties of a wireless device.

Synopsis¶

  update-wireless-device
--id <value>
[--destination-name <value>]
[--name <value>]
[--description <value>]
[--lorawan <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--id (string)

The ID of the resource to update.

--destination-name (string)

The name of the new destination for the device.

--name (string)

The new name of the resource.

--description (string)

A new description of the resource.

--lorawan (structure)

The updated wireless device’s configuration.

DeviceProfileId -> (string)

The ID of the device profile for the wireless device.

ServiceProfileId -> (string)

The ID of the service profile.

AbpV1_1 -> (structure)

ABP device object for update APIs for v1.1

FCntStart -> (integer)

The FCnt init value.

AbpV1_0_x -> (structure)

ABP device object for update APIs for v1.0.x

FCntStart -> (integer)

The FCnt init value.

FPorts -> (structure)

FPorts object for the positioning information of the device.

Positioning -> (structure)

Positioning FPorts for the ClockSync, Stream, and GNSS functions.

ClockSync -> (integer)

The Fport value.

Stream -> (integer)

The Fport value.

Gnss -> (integer)

The Fport value.

Shorthand Syntax:

DeviceProfileId=string,ServiceProfileId=string,AbpV1_1={FCntStart=integer},AbpV1_0_x={FCntStart=integer},FPorts={Positioning={ClockSync=integer,Stream=integer,Gnss=integer}}

JSON Syntax:

{
  "DeviceProfileId": "string",
  "ServiceProfileId": "string",
  "AbpV1_1": {
    "FCntStart": integer
  },
  "AbpV1_0_x": {
    "FCntStart": integer
  },
  "FPorts": {
    "Positioning": {
      "ClockSync": integer,
      "Stream": integer,
      "Gnss": integer
    }
  }
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

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 update the properties of a wireless device

The following update-wireless-device example updates the properties of a wireless device registered to your AWS account.

aws iotwireless update-wireless-device \
    --id "1ffd32c8-8130-4194-96df-622f072a315f" \
    --destination-name IoTWirelessDestination2 \
    --description "Using my first LoRaWAN device"

This command produces no output.

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

Output¶

None

Table of Contents

Feedback

User Guide