update-wireless-gateway¶

Description¶

Updates properties of a wireless gateway.

Synopsis¶

  update-wireless-gateway
--id <value>
[--name <value>]
[--description <value>]
[--join-eui-filters <value>]
[--net-id-filters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--id (string)

The ID of the resource to update.

--name (string)

The new name of the resource.

--description (string)

A new description of the resource.

--join-eui-filters (list)

A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

(list)

A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.

(string)

Shorthand Syntax:

string,string ...

JSON Syntax:

[
  ["string", ...]
  ...
]

--net-id-filters (list)

A list of NetId values that are used by LoRa gateways to filter the uplink frames.

(string)

LoRaWAN network ID.

Syntax:

"string" "string" ...

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

The following update-wireless-gateway example updates the description of your wireless gateway.

aws iotwireless update-wireless-gateway \
    --id "3285bdc7-5a12-4991-84ed-dadca65e342e" \
    --description "Using my LoRaWAN gateway"

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