software_update_jobs

Creates, updates, deletes, gets or lists a software_update_jobs resource.

Overview

Name	software_update_jobs
Type	Resource
Id	aws.greengrass.software_update_jobs

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_software_update_job	insert	region, S3UrlSignerRole, SoftwareToUpdate, UpdateTargets, UpdateTargetsArchitecture, UpdateTargetsOperatingSystem	X-Amzn-Client-Token	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
X-Amzn-Client-Token	string	A client token used to correlate requests and responses.

INSERT examples

create_software_update_job

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.

INSERT INTO aws.greengrass.software_update_jobs (
S3UrlSignerRole,
SoftwareToUpdate,
UpdateAgentLogLevel,
UpdateTargets,
UpdateTargetsArchitecture,
UpdateTargetsOperatingSystem,
region,
`X-Amzn-Client-Token`
)
SELECT 
'{{ S3UrlSignerRole }}' /* required */,
'{{ SoftwareToUpdate }}' /* required */,
'{{ UpdateAgentLogLevel }}',
'{{ UpdateTargets }}' /* required */,
'{{ UpdateTargetsArchitecture }}' /* required */,
'{{ UpdateTargetsOperatingSystem }}' /* required */,
'{{ region }}',
'{{ X-Amzn-Client-Token }}'
RETURNING
iot_job_arn,
iot_job_id,
platform_software_version
;

Manifest

# Description fields are for documentation purposes
- name: software_update_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the software_update_jobs resource.
  - name: S3UrlSignerRole
    value: "{{ S3UrlSignerRole }}"
    description: |
      The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.
  - name: SoftwareToUpdate
    value: "{{ SoftwareToUpdate }}"
    description: |
      The piece of software on the Greengrass core that will be updated.
    valid_values: ['core', 'ota_agent']
  - name: UpdateAgentLogLevel
    value: "{{ UpdateAgentLogLevel }}"
    description: |
      The minimum level of log statements that should be logged by the OTA Agent during an update.
    valid_values: ['NONE', 'TRACE', 'DEBUG', 'VERBOSE', 'INFO', 'WARN', 'ERROR', 'FATAL']
  - name: UpdateTargets
    value:
      - "{{ UpdateTargets }}"
    description: |
      The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.
  - name: UpdateTargetsArchitecture
    value: "{{ UpdateTargetsArchitecture }}"
    description: |
      The architecture of the cores which are the targets of an update.
    valid_values: ['armv6l', 'armv7l', 'x86_64', 'aarch64']
  - name: UpdateTargetsOperatingSystem
    value: "{{ UpdateTargetsOperatingSystem }}"
    description: |
      The operating system of the cores which are the targets of an update.
    valid_values: ['ubuntu', 'raspbian', 'amazon_linux', 'openwrt']
  - name: X-Amzn-Client-Token
    value: "{{ X-Amzn-Client-Token }}"
    description: A client token used to correlate requests and responses.
    description: A client token used to correlate requests and responses.