[ aws . greengrass ]
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.
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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
--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
| --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.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
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.
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.