[ aws . panorama ]

create-job-for-devices

Description

Creates a job to run on one or more devices.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-job-for-devices
--device-ids <value>
--device-job-config <value>
--job-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--device-ids (list)

IDs of target devices.

(string)

Syntax:

"string" "string" ...

--device-job-config (structure)

Configuration settings for the job.

OTAJobConfig -> (structure)

A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.

ImageVersion -> (string)

The target version of the device software.

Shorthand Syntax:

OTAJobConfig={ImageVersion=string}

JSON Syntax:

{
  "OTAJobConfig": {
    "ImageVersion": "string"
  }
}

--job-type (string)

The type of job to run.

Possible values:

  • OTA

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

See ‘aws help’ for descriptions of global parameters.

Output

Jobs -> (list)

A list of jobs.

(structure)

A job for a device.

JobId -> (string)

The job’s ID.

DeviceId -> (string)

The target device’s ID.