- 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.
DescribeDeviceCommand
Returns information about a device.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { PanoramaClient, DescribeDeviceCommand } from "@aws-sdk/client-panorama"; // ES Modules import
// const { PanoramaClient, DescribeDeviceCommand } = require("@aws-sdk/client-panorama"); // CommonJS import
const client = new PanoramaClient(config);
const input = { // DescribeDeviceRequest
DeviceId: "STRING_VALUE", // required
};
const command = new DescribeDeviceCommand(input);
const response = await client.send(command);
// { // DescribeDeviceResponse
// DeviceId: "STRING_VALUE",
// Name: "STRING_VALUE",
// Arn: "STRING_VALUE",
// Description: "STRING_VALUE",
// Type: "STRING_VALUE",
// DeviceConnectionStatus: "STRING_VALUE",
// CreatedTime: new Date("TIMESTAMP"),
// ProvisioningStatus: "STRING_VALUE",
// LatestSoftware: "STRING_VALUE",
// CurrentSoftware: "STRING_VALUE",
// SerialNumber: "STRING_VALUE",
// Tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// NetworkingConfiguration: { // NetworkPayload
// Ethernet0: { // EthernetPayload
// ConnectionType: "STRING_VALUE", // required
// StaticIpConnectionInfo: { // StaticIpConnectionInfo
// IpAddress: "STRING_VALUE", // required
// Mask: "STRING_VALUE", // required
// Dns: [ // DnsList // required
// "STRING_VALUE",
// ],
// DefaultGateway: "STRING_VALUE", // required
// },
// },
// Ethernet1: {
// ConnectionType: "STRING_VALUE", // required
// StaticIpConnectionInfo: {
// IpAddress: "STRING_VALUE", // required
// Mask: "STRING_VALUE", // required
// Dns: [ // required
// "STRING_VALUE",
// ],
// DefaultGateway: "STRING_VALUE", // required
// },
// },
// Ntp: { // NtpPayload
// NtpServers: [ // NtpServerList // required
// "STRING_VALUE",
// ],
// },
// },
// CurrentNetworkingStatus: { // NetworkStatus
// Ethernet0Status: { // EthernetStatus
// IpAddress: "STRING_VALUE",
// ConnectionStatus: "STRING_VALUE",
// HwAddress: "STRING_VALUE",
// },
// Ethernet1Status: {
// IpAddress: "STRING_VALUE",
// ConnectionStatus: "STRING_VALUE",
// HwAddress: "STRING_VALUE",
// },
// NtpStatus: { // NtpStatus
// ConnectionStatus: "STRING_VALUE",
// IpAddress: "STRING_VALUE",
// NtpServerName: "STRING_VALUE",
// },
// LastUpdatedTime: new Date("TIMESTAMP"),
// },
// LeaseExpirationTime: new Date("TIMESTAMP"),
// AlternateSoftwares: [ // AlternateSoftwares
// { // AlternateSoftwareMetadata
// Version: "STRING_VALUE",
// },
// ],
// LatestAlternateSoftware: "STRING_VALUE",
// Brand: "STRING_VALUE",
// LatestDeviceJob: { // LatestDeviceJob
// ImageVersion: "STRING_VALUE",
// Status: "STRING_VALUE",
// JobType: "STRING_VALUE",
// },
// DeviceAggregatedStatus: "STRING_VALUE",
// };
DescribeDeviceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DeviceId Required | string | undefined | The device's ID. |
DescribeDeviceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AlternateSoftwares | AlternateSoftwareMetadata[] | undefined | Beta software releases available for the device. |
Arn | string | undefined | The device's ARN. |
Brand | DeviceBrand | undefined | The device's maker. |
CreatedTime | Date | undefined | When the device was created. |
CurrentNetworkingStatus | NetworkStatus | undefined | The device's networking status. |
CurrentSoftware | string | undefined | The device's current software version. |
Description | string | undefined | The device's description. |
DeviceAggregatedStatus | DeviceAggregatedStatus | undefined | A device's aggregated status. Including the device's connection status, provisioning status, and lease status. |
DeviceConnectionStatus | DeviceConnectionStatus | undefined | The device's connection status. |
DeviceId | string | undefined | The device's ID. |
LatestAlternateSoftware | string | undefined | The most recent beta software release. |
LatestDeviceJob | LatestDeviceJob | undefined | A device's latest job. Includes the target image version, and the job status. |
LatestSoftware | string | undefined | The latest software version available for the device. |
LeaseExpirationTime | Date | undefined | The device's lease expiration time. |
Name | string | undefined | The device's name. |
NetworkingConfiguration | NetworkPayload | undefined | The device's networking configuration. |
ProvisioningStatus | DeviceStatus | undefined | The device's provisioning status. |
SerialNumber | string | undefined | The device's serial number. |
Tags | Record<string, string> | undefined | The device's tags. |
Type | DeviceType | undefined | The device's type. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The requestor does not have permission to access the target action or resource. |
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. |