create-wireless-gateway-task-definition¶

Description¶

Creates a gateway task definition.

Synopsis¶

  create-wireless-gateway-task-definition
--auto-create-tasks | --no-auto-create-tasks
[--name <value>]
[--update <value>]
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--auto-create-tasks | --no-auto-create-tasks (boolean)

Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false , the task must me created by calling CreateWirelessGatewayTask .

--name (string)

The name of the new resource.

--update (structure)

Information about the gateways to update.

UpdateDataSource -> (string)

The link to the S3 bucket.

UpdateDataRole -> (string)

The IAM role used to read data from the S3 bucket.

LoRaWAN -> (structure)

The properties that relate to the LoRaWAN wireless gateway.

UpdateSignature -> (string)

The signature used to verify the update firmware.

SigKeyCrc -> (long)

The CRC of the signature private key to check.

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.

Shorthand Syntax:

UpdateDataSource=string,UpdateDataRole=string,LoRaWAN={UpdateSignature=string,SigKeyCrc=long,CurrentVersion={PackageVersion=string,Model=string,Station=string},UpdateVersion={PackageVersion=string,Model=string,Station=string}}

JSON Syntax:

{
  "UpdateDataSource": "string",
  "UpdateDataRole": "string",
  "LoRaWAN": {
    "UpdateSignature": "string",
    "SigKeyCrc": long,
    "CurrentVersion": {
      "PackageVersion": "string",
      "Model": "string",
      "Station": "string"
    },
    "UpdateVersion": {
      "PackageVersion": "string",
      "Model": "string",
      "Station": "string"
    }
  }
}

--client-request-token (string)

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

--tags (list)

The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

(structure)

A simple label consisting of a customer-defined key-value pair

Key -> (string)

The tag’s key value.

Value -> (string)

The tag’s value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "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 create a wireless gateway task definition

The following create-wireless-gateway-task-definition automatically creates tasks using this task definition for all gateways with the specified current version.

aws iotwireless create-wireless-gateway-task-definition \
    --cli-input-json file://input.json

Contents of input.json:

{
    "AutoCreateTasks": true,
    "Name": "TestAutoUpdate",
    "Update":{
        "UpdateDataSource" : "s3://cupsalphagafirmwarebin/station",
        "UpdateDataRole" : "arn:aws:iam::001234567890:role/SDK_Test_Role",
        "LoRaWAN" :{
            "CurrentVersion" :{
                "PackageVersion" : "1.0.0",
                "Station" : "2.0.5",
                "Model" : "linux"
            },
            "UpdateVersion" :{
                "PackageVersion" : "1.0.1",
                "Station" : "2.0.5",
                "Model" : "minihub"
            }
        }
    }
}

Output:

{
    "Id": "b7d3baad-25c7-35e7-a4e1-1683a0d61da9"
}

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

Output¶

Id -> (string)

The ID of the new wireless gateway task definition.

Arn -> (string)

The Amazon Resource Name of the resource.

Table of Contents

Feedback

User Guide