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 ]

list-wireless-gateways

Description

Lists the wireless gateways registered to your AWS account.

See also: AWS API Documentation

Synopsis

  list-wireless-gateways
[--next-token <value>]
[--max-results <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

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

--max-results (integer)

The maximum number of results to return in this operation.

--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 list the wireless gateways

The following list-wireless-gateways example lists the available wireless gateways in your AWS account.

aws iotwireless list-wireless-gateways

Output:

{
    "WirelessGatewayList": [
        {
            "Description": "My first LoRaWAN gateway",
            "LoRaWAN": {
                "RfRegion": "US915",
                "GatewayEui": "dac632ebc01d23e4"
            },
            "Id": "3039b406-5cc9-4307-925b-9948c63da25b",
            "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/3039b406-5cc9-4307-925b-9948c63da25b",
            "Name": "myFirstLoRaWANGateway"
        },
        {
            "Description": "My second LoRaWAN gateway",
            "LoRaWAN": {
                "RfRegion": "US915",
                "GatewayEui": "cda123fffe92ecd2"
            },
            "Id": "3285bdc7-5a12-4991-84ed-dadca65e342e",
            "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/3285bdc7-5a12-4991-84ed-dadca65e342e",
            "Name": "mySecondLoRaWANGateway"
        }
    ]
}

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.

WirelessGatewayList -> (list)

The ID of the wireless gateway.

(structure)

Information about a wireless gateway's operation.

Arn -> (string)

The Amazon Resource Name of the resource.

Id -> (string)

The ID of the wireless gateway reporting the data.

Name -> (string)

The name of the resource.

Description -> (string)

The description of the resource.

LoRaWAN -> (structure)

LoRaWAN gateway info.

GatewayEui -> (string)

The gateway's EUI value.

RfRegion -> (string)

The frequency band (RFRegion) value.

JoinEuiFilters -> (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)

NetIdFilters -> (list)

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

(string)

LoRaWAN network ID.

SubBands -> (list)

A list of integer indicating which sub bands are supported by LoRa gateway.

(integer)

A subset of supported frequency channels in a certain RFRegion.

Beaconing -> (structure)

Beaconing object information, which consists of the data rate and frequency parameters.

DataRate -> (integer)

The data rate for gateways that are sending the beacons.

Frequencies -> (list)

The frequency list for the gateways to send the beacons.

(integer)

MaxEirp -> (float)

The MaxEIRP value.

LastUplinkReceivedAt -> (string)

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

Note

This value is only valid for 3 months.