Table Of Contents

Feedback

User Guide

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

[ aws . greengrass ]

create-software-update-job

Description

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-software-update-job
[--amzn-client-token <value>]
[--s3-url-signer-role <value>]
[--software-to-update <value>]
[--update-agent-log-level <value>]
[--update-targets <value>]
[--update-targets-architecture <value>]
[--update-targets-operating-system <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--amzn-client-token (string) A client token used to correlate requests and responses.

--s3-url-signer-role (string) The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.

--software-to-update (string) The piece of software on the Greengrass core that will be updated.

Possible values:

  • core
  • ota_agent

--update-agent-log-level (string) The minimum level of log statements that should be logged by the OTA Agent during an update.

Possible values:

  • NONE
  • TRACE
  • DEBUG
  • VERBOSE
  • INFO
  • WARN
  • ERROR
  • FATAL

--update-targets (list) The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.

Syntax:

"string" "string" ...

--update-targets-architecture (string) The architecture of the cores which are the targets of an update.

Possible values:

  • armv7l
  • x86_64
  • aarch64

--update-targets-operating-system (string) The operating system of the cores which are the targets of an update.

Possible values:

  • ubuntu
  • raspbian
  • amazon_linux

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

Output

IotJobArn -> (string)

The IoT Job ARN corresponding to this update.

IotJobId -> (string)

The IoT Job Id corresponding to this update.