Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1492266201.3 KB

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.

post/greengrass/updates

Headers

X-Amzn-Client-Tokenstring

A client token used to correlate requests and responses.

Request body

S3UrlSignerRolestring required

The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.

SoftwareToUpdate'core' | 'ota_agent' required

The piece of software on the Greengrass core that will be updated.

UpdateAgentLogLevel'NONE' | 'TRACE' | 'DEBUG' | 'VERBOSE' | 'INFO' | 'WARN' | 'ERROR' | 'FATAL'

The minimum level of log statements that should be logged by the OTA Agent during an update.

UpdateTargetsString[] required

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

UpdateTargetsArchitecture'armv6l' | 'armv7l' | 'x86_64' | 'aarch64' required

The architecture of the cores which are the targets of an update.

UpdateTargetsOperatingSystem'ubuntu' | 'raspbian' | 'amazon_linux' | 'openwrt' required

The operating system of the cores which are the targets of an update.

Response

Success

IotJobArnstring

The IoT Job ARN corresponding to this update.

IotJobIdstring

The IoT Job Id corresponding to this update.

PlatformSoftwareVersionstring

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