AWS CLI Command Reference

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 ]

update-wireless-device

Description

Updates properties of a wireless device.

See also: AWS API Documentation

Synopsis

  update-wireless-device
--id <value>
[--destination-name <value>]
[--name <value>]
[--description <value>]
[--positioning <value>]
[--lorawan <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

--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.

--positioning (string)

FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

Possible values:

  • Enabled
  • Disabled

--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.

Applications -> (list)

LoRaWAN application, which can be used for geolocation by activating positioning.

(structure)

LoRaWAN application configuration, which can be used to perform geolocation.

FPort -> (integer)

The Fport value.

Type -> (string)

Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

DestinationName -> (string)

The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

JSON Syntax:

{
  "DeviceProfileId": "string",
  "ServiceProfileId": "string",
  "AbpV1_1": {
    "FCntStart": integer
  },
  "AbpV1_0_x": {
    "FCntStart": integer
  },
  "FPorts": {
    "Positioning": {
      "ClockSync": integer,
      "Stream": integer,
      "Gnss": integer
    },
    "Applications": [
      {
        "FPort": integer,
        "Type": "SemtechGeolocation",
        "DestinationName": "string"
      }
      ...
    ]
  }
}

--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 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