ListDevices
A list of devices.
Request Syntax
{
"DeviceFleetName": "string",
"LatestHeartbeatAfter": number,
"MaxResults": number,
"ModelName": "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
-
Filter for fleets containing this name in their device fleet name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: No
- LatestHeartbeatAfter
-
Select fleets where the job was updated after X
Type: Timestamp
Required: No
- MaxResults
-
Maximum number of results to select.
Type: Integer
Valid Range: Maximum value of 100.
Required: No
- ModelName
-
A filter that searches devices that contains this name in any of their models.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: No
- 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:
.*Required: No
Response Syntax
{
"DeviceSummaries": [
{
"AgentVersion": "string",
"Description": "string",
"DeviceArn": "string",
"DeviceFleetName": "string",
"DeviceName": "string",
"IotThingName": "string",
"LatestHeartbeat": number,
"Models": [
{
"ModelName": "string",
"ModelVersion": "string"
}
],
"RegistrationTime": number
}
],
"NextToken": "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.
- DeviceSummaries
-
Summary of devices.
Type: Array of DeviceSummary 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:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
