AWS Greengrass

{'PlatformSoftwareVersion': 'string'}

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

Request Syntax

client.create_software_update_job(
    AmznClientToken='string',
    S3UrlSignerRole='string',
    SoftwareToUpdate='core'|'ota_agent',
    UpdateAgentLogLevel='NONE'|'TRACE'|'DEBUG'|'VERBOSE'|'INFO'|'WARN'|'ERROR'|'FATAL',
    UpdateTargets=[
        'string',
    ],
    UpdateTargetsArchitecture='armv7l'|'x86_64'|'aarch64'|'openwrt',
    UpdateTargetsOperatingSystem='ubuntu'|'raspbian'|'amazon_linux'
)

type AmznClientToken

string

param AmznClientToken

A client token used to correlate requests and responses.

type S3UrlSignerRole

string

param S3UrlSignerRole

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

type SoftwareToUpdate

string

param SoftwareToUpdate

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

type UpdateAgentLogLevel

string

param UpdateAgentLogLevel

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

type UpdateTargets

list

param UpdateTargets

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

• (string) --

type UpdateTargetsArchitecture

string

param UpdateTargetsArchitecture

[REQUIRED] The architecture of the cores which are the targets of an update.

type UpdateTargetsOperatingSystem

string

param UpdateTargetsOperatingSystem

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

rtype

dict

returns

Response Syntax

{
    'IotJobArn': 'string',
    'IotJobId': 'string',
    'PlatformSoftwareVersion': 'string'
}

Response Structure

• (dict) -- success

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