Table Of Contents


User Guide

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

[ aws . greengrass ]



Creates an Iot Job that will trigger your Greengrass Cores to update the software they are running.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--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>]


--amzn-client-token (string) The client token used to request idempotent operations.

--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
  • INFO
  • WARN

--update-targets (list) The target arns that this update will be applied to.


"string" "string" ...

--update-targets-architecture (string) The architecture of the Cores in the targets of an update

Possible values:

  • armv7l
  • x86_64
  • aarch64

--update-targets-operating-system (string) The operating system of the Cores in 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.

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


IotJobArn -> (string)

The Iot Job Arn corresponding to this update.

IotJobId -> (string)

The Iot Job Id corresponding to this update.