AWS Panorama

2023/01/19 - AWS Panorama - 1 updated api methods

Changes  Added AllowMajorVersionUpdate option to OTAJobConfig to make appliance software major version updates opt-in.

CreateJobForDevices (updated) Link ΒΆ
Changes (request)
{'DeviceJobConfig': {'OTAJobConfig': {'AllowMajorVersionUpdate': 'boolean'}}}

Creates a job to run on a device. A job can update a device's software or reboot it.

See also: AWS API Documentation

Request Syntax

client.create_job_for_devices(
    DeviceIds=[
        'string',
    ],
    DeviceJobConfig={
        'OTAJobConfig': {
            'AllowMajorVersionUpdate': True|False,
            'ImageVersion': 'string'
        }
    },
    JobType='OTA'|'REBOOT'
)
type DeviceIds

list

param DeviceIds

[REQUIRED]

ID of target device.

  • (string) --

type DeviceJobConfig

dict

param DeviceJobConfig

Configuration settings for a software update job.

  • OTAJobConfig (dict) --

    A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.

    • AllowMajorVersionUpdate (boolean) --

      Whether to apply the update if it is a major version change.

    • ImageVersion (string) -- [REQUIRED]

      The target version of the device software.

type JobType

string

param JobType

[REQUIRED]

The type of job to run.

rtype

dict

returns

Response Syntax

{
    'Jobs': [
        {
            'DeviceId': 'string',
            'JobId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Jobs (list) --

      A list of jobs.

      • (dict) --

        A job for a device.

        • DeviceId (string) --

          The target device's ID.

        • JobId (string) --

          The job's ID.