Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDevice

Returns information about a device.

Request Syntax


GET /devices/DeviceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DeviceId

The device's ID.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AlternateSoftwares": [ 
      { 
         "Version": "string"
      }
   ],
   "Arn": "string",
   "Brand": "string",
   "CreatedTime": number,
   "CurrentNetworkingStatus": { 
      "Ethernet0Status": { 
         "ConnectionStatus": "string",
         "HwAddress": "string",
         "IpAddress": "string"
      },
      "Ethernet1Status": { 
         "ConnectionStatus": "string",
         "HwAddress": "string",
         "IpAddress": "string"
      },
      "LastUpdatedTime": number,
      "NtpStatus": { 
         "ConnectionStatus": "string",
         "IpAddress": "string",
         "NtpServerName": "string"
      }
   },
   "CurrentSoftware": "string",
   "Description": "string",
   "DeviceAggregatedStatus": "string",
   "DeviceConnectionStatus": "string",
   "DeviceId": "string",
   "LatestAlternateSoftware": "string",
   "LatestDeviceJob": { 
      "ImageVersion": "string",
      "JobType": "string",
      "Status": "string"
   },
   "LatestSoftware": "string",
   "LeaseExpirationTime": number,
   "Name": "string",
   "NetworkingConfiguration": { 
      "Ethernet0": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ethernet1": { 
         "ConnectionType": "string",
         "StaticIpConnectionInfo": { 
            "DefaultGateway": "string",
            "Dns": [ "string" ],
            "IpAddress": "string",
            "Mask": "string"
         }
      },
      "Ntp": { 
         "NtpServers": [ "string" ]
      }
   },
   "ProvisioningStatus": "string",
   "SerialNumber": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Type": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AlternateSoftwares

Beta software releases available for the device.

Type: Array of AlternateSoftwareMetadata objects

Arn

The device's ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Brand

The device's maker.

Type: String

Valid Values: AWS_PANORAMA | LENOVO

CreatedTime

When the device was created.

Type: Timestamp

CurrentNetworkingStatus

The device's networking status.

Type: NetworkStatus object

CurrentSoftware

The device's current software version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Description

The device's description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ^.*$

DeviceAggregatedStatus

A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

Type: String

DeviceConnectionStatus

The device's connection status.

Type: String

Valid Values: ONLINE | OFFLINE | AWAITING_CREDENTIALS | NOT_AVAILABLE | ERROR

DeviceId

The device's ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

LatestAlternateSoftware

The most recent beta software release.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

LatestDeviceJob

A device's latest job. Includes the target image version, and the job status.

Type: LatestDeviceJob object

LatestSoftware

The latest software version available for the device.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

LeaseExpirationTime

The device's lease expiration time.

Type: Timestamp

Name

The device's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9\-\_]+$

NetworkingConfiguration

The device's networking configuration.

Type: NetworkPayload object

ProvisioningStatus

The device's provisioning status.

Type: String

SerialNumber

The device's serial number.

Type: String

Pattern: ^[0-9]{1,20}$

Tags

The device's tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^.+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^.*$

Type

The device's type.

Type: String

Valid Values: PANORAMA_APPLIANCE_DEVELOPER_KIT | PANORAMA_APPLIANCE

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The target resource was not found.

HTTP Status Code: 404

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400