- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeDeviceJobCommand
Returns information about a device job.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, DescribeDeviceJobCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribeDeviceJobCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribeDeviceJobRequest
JobId: "STRING_VALUE", // required
};
const command = new DescribeDeviceJobCommand(input);
const response = await client.send(command);
// { // DescribeDeviceJobResponse
// JobId: "STRING_VALUE",
// DeviceId: "STRING_VALUE",
// DeviceArn: "STRING_VALUE",
// DeviceName: "STRING_VALUE",
// DeviceType: "STRING_VALUE",
// ImageVersion: "STRING_VALUE",
// Status: "STRING_VALUE",
// CreatedTime: new Date("TIMESTAMP"),
// JobType: "STRING_VALUE",
// };
DescribeDeviceJobCommand Input
See DescribeDeviceJobCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
JobId Required | string | undefined | The job's ID. |
DescribeDeviceJobCommand Output
See DescribeDeviceJobCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
CreatedTime | Date | undefined | When the job was created. |
DeviceArn | string | undefined | The device's ARN. |
DeviceId | string | undefined | The device's ID. |
DeviceName | string | undefined | The device's name. |
DeviceType | DeviceType | undefined | The device's type. |
ImageVersion | string | undefined | For an OTA job, the target version of the device software. |
JobId | string | undefined | The job's ID. |
JobType | JobType | undefined | The job's type. |
Status | UpdateProgress | undefined | The job's status. |
Throws
Name | Fault | Details |
---|
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. |