DescribeDevice
Describes the device.
Request Syntax
{
"DeviceFleetName": "string",
"DeviceName": "string",
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DeviceFleetName
-
The name of the fleet the devices belong to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: Yes
- DeviceName
-
The unique ID of the device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: Yes
- NextToken
-
Next token of device description.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
Response Syntax
{
"AgentVersion": "string",
"Description": "string",
"DeviceArn": "string",
"DeviceFleetName": "string",
"DeviceName": "string",
"IotThingName": "string",
"LatestHeartbeat": number,
"MaxModels": number,
"Models": [
{
"LatestInference": number,
"LatestSampleTime": number,
"ModelName": "string",
"ModelVersion": "string"
}
],
"NextToken": "string",
"RegistrationTime": number
}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.
- AgentVersion
-
Edge Manager agent version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Pattern:
[a-zA-Z0-9\ \_\.]+ - Description
-
A description of the device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
^[-a-zA-Z0-9_.,;:! ]*$ - DeviceArn
-
The Amazon Resource Name (ARN) of the device.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:[a-z\-]*:[a-z\-]*:\d{12}:[a-z\-]*/?[a-zA-Z_0-9+=,.@\-_/]+$ - DeviceFleetName
-
The name of the fleet the device belongs to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ - DeviceName
-
The unique identifier of the device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ - IotThingName
-
The AWS Internet of Things (IoT) object thing name associated with the device.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+ - LatestHeartbeat
-
The last heartbeat received from the device.
Type: Timestamp
- MaxModels
-
The maximum number of models.
Type: Integer
- Models
-
Models on the device.
Type: Array of EdgeModel objects
- NextToken
-
The response from the last list when returning a list large enough to need tokening.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.* - RegistrationTime
-
The timestamp of the last registration or de-reregistration.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
