Panorama / Client / list_devices_jobs

list_devices_jobs#

Panorama.Client.list_devices_jobs(**kwargs)#

Returns a list of jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_devices_jobs(
    DeviceId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:
  • DeviceId (string) – Filter results by the job’s target device ID.

  • MaxResults (integer) – The maximum number of device jobs to return in one page of results.

  • NextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'DeviceJobs': [
        {
            'CreatedTime': datetime(2015, 1, 1),
            'DeviceId': 'string',
            'DeviceName': 'string',
            'JobId': 'string',
            'JobType': 'OTA'|'REBOOT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DeviceJobs (list) –

      A list of jobs.

      • (dict) –

        A job that runs on a device.

        • CreatedTime (datetime) –

          When the job was created.

        • DeviceId (string) –

          The ID of the target device.

        • DeviceName (string) –

          The name of the target device

        • JobId (string) –

          The job’s ID.

        • JobType (string) –

          The job’s type.

    • NextToken (string) –

      A pagination token that’s included if more results are available.

Exceptions

  • Panorama.Client.exceptions.ConflictException

  • Panorama.Client.exceptions.ValidationException

  • Panorama.Client.exceptions.AccessDeniedException

  • Panorama.Client.exceptions.ResourceNotFoundException

  • Panorama.Client.exceptions.InternalServerException