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

DescribeDevice

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Request Syntax


POST /managed-device/managedDeviceId/describe HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

managedDeviceId

The ID of the device that you are checking the information of.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "associatedWithJob": "string",
   "deviceCapacities": [ 
      { 
         "available": number,
         "name": "string",
         "total": number,
         "unit": "string",
         "used": number
      }
   ],
   "deviceState": "string",
   "deviceType": "string",
   "lastReachedOutAt": number,
   "lastUpdatedAt": number,
   "managedDeviceArn": "string",
   "managedDeviceId": "string",
   "physicalNetworkInterfaces": [ 
      { 
         "defaultGateway": "string",
         "ipAddress": "string",
         "ipAddressAssignment": "string",
         "macAddress": "string",
         "netmask": "string",
         "physicalConnectorType": "string",
         "physicalNetworkInterfaceId": "string"
      }
   ],
   "software": { 
      "installedVersion": "string",
      "installingVersion": "string",
      "installState": "string"
   },
   "tags": { 
      "string" : "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.

associatedWithJob

The ID of the job used when ordering the device.

Type: String

deviceCapacities

The hardware specifications of the device.

Type: Array of Capacity objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

deviceState

The current state of the device.

Type: String

Valid Values: UNLOCKED | LOCKED | UNLOCKING

deviceType

The type of AWS Snow Family device.

Type: String

lastReachedOutAt

When the device last contacted the AWS Cloud. Indicates that the device is online.

Type: Timestamp

lastUpdatedAt

When the device last pushed an update to the AWS Cloud. Indicates when the device cache was refreshed.

Type: Timestamp

managedDeviceArn

The Amazon Resource Name (ARN) of the device.

Type: String

managedDeviceId

The ID of the device that you checked the information for.

Type: String

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

physicalNetworkInterfaces

The network interfaces available on the device.

Type: Array of PhysicalNetworkInterface objects

software

The software installed on the device.

Type: SoftwareInformation object

tags

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

Type: String to string map

Errors

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

AccessDeniedException

You don't have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400