ListDevicesJobsCommand

Suggest an Edit

Returns a list of jobs.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { PanoramaClient, ListDevicesJobsCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, ListDevicesJobsCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // ListDevicesJobsRequest
  DeviceId: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListDevicesJobsCommand(input);
const response = await client.send(command);
// { // ListDevicesJobsResponse
//   DeviceJobs: [ // DeviceJobList
//     { // DeviceJob
//       DeviceName: "STRING_VALUE",
//       DeviceId: "STRING_VALUE",
//       JobId: "STRING_VALUE",
//       CreatedTime: new Date("TIMESTAMP"),
//       JobType: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListDevicesJobsCommand Input

See ListDevicesJobsCommandInput for more details

Parameter
Type
Description
DeviceId
string | undefined

Filter results by the job's target device ID.

MaxResults
number | undefined

The maximum number of device jobs to return in one page of results.

NextToken
string | undefined

Specify the pagination token from a previous request to retrieve the next page of results.

ListDevicesJobsCommand Output

See ListDevicesJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DeviceJobs
DeviceJob[] | undefined

A list of jobs.

NextToken
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

The requestor does not have permission to access the target action or resource.

ConflictException
client

The target resource is in use.

InternalServerException
server

An internal error occurred.

ResourceNotFoundException
client

The target resource was not found.

ValidationException
client

The request contains an invalid parameter value.

PanoramaServiceException
Base exception class for all service exceptions from Panorama service.