Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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-gateway-task-definitions

Description

List the wireless gateway tasks definitions registered to your AWS account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-wireless-gateway-task-definitions
[--max-results <value>]
[--next-token <value>]
[--task-definition-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of results to return in this operation.

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

--task-definition-type (string)

A filter to list only the wireless gateway task definitions that use this task definition type.

Possible values:

  • UPDATE

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

See 'aws help' for descriptions of global parameters.

Examples

To list the wireless gateway task definitions

The following list-wireless-gateway-task-definitions example lists the available wireless gateway task definitions registered to your AWS account.

aws iotwireless list-wireless-gateway-task-definitions

Output:

{
    "TaskDefinitions": [
        {
            "Id": "b7d3baad-25c7-35e7-a4e1-1683a0d61da9",
            "LoRaWAN" :
                {
                "CurrentVersion" :{
                    "PackageVersion" : "1.0.0",
                    "Station" : "2.0.5",
                    "Model" : "linux"
                },
                "UpdateVersion" :{
                    "PackageVersion" : "1.0.1",
                    "Station" : "2.0.5",
                    "Model" : "minihub"
                }
            }
        }
    ]
}

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.

TaskDefinitions -> (list)

The list of task definitions.

(structure)

UpdateWirelessGatewayTaskEntry object.

Id -> (string)

The ID of the new wireless gateway task entry.

LoRaWAN -> (structure)

The properties that relate to the LoRaWAN wireless gateway.

CurrentVersion -> (structure)

The version of the gateways that should receive the update.

PackageVersion -> (string)

The version of the wireless gateway firmware.

Model -> (string)

The model number of the wireless gateway.

Station -> (string)

The basic station version of the wireless gateway.

UpdateVersion -> (structure)

The firmware version to update the gateway to.

PackageVersion -> (string)

The version of the wireless gateway firmware.

Model -> (string)

The model number of the wireless gateway.

Station -> (string)

The basic station version of the wireless gateway.

Arn -> (string)

The Amazon Resource Name of the resource.