AWS CLI Command Reference

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

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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.(string)

Syntax:

"string" "string" ...

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

Possible values:

  • armv6l
  • 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
  • openwrt

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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 software update job for a core

The following create-software-update-job example creates an over-the-air (OTA) update job to update the AWS IoT Greengrass Core software on the core whose name is MyFirstGroup_Core. This command requires an IAM role that allows access to software update packages in Amazon S3 and includes iot.amazonaws.com as a trusted entity.

aws greengrass create-software-update-job \
    --update-targets-architecture armv7l \
    --update-targets [\"arn:aws:iot:us-west-2:123456789012:thing/MyFirstGroup_Core\"] \
    --update-targets-operating-system raspbian \
    --software-to-update core \
    --s3-url-signer-role arn:aws:iam::123456789012:role/OTA_signer_role \
    --update-agent-log-level WARN

Output:

{
    "IotJobId": "GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e",
    "IotJobArn": "arn:aws:iot:us-west-2:123456789012:job/GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e",
    "PlatformSoftwareVersion": "1.9.3"
}

For more information, see OTA Updates of AWS IoT Greengrass Core Software in the AWS IoT Greengrass Developer Guide.

Output

IotJobArn -> (string)

The IoT Job ARN corresponding to this update.

IotJobId -> (string)

The IoT Job Id corresponding to this update.

PlatformSoftwareVersion -> (string)

The software version installed on the device or devices after the update.