POST

/greengrass/updates

http://greengrass.{region}.amazonaws.com/greengrass/updates

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.

Access Token Required: API Key

Body Params

UpdateTargetsarrayrequired

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

S3UrlSignerRolestringrequired

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

SoftwareToUpdatestringrequired

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

UpdateAgentLogLevelstring

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

UpdateTargetsArchitecturestringrequired

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

UpdateTargetsOperatingSystemstringrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/updates' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}