# ListDevices
<a name="API_ListDevices"></a>

A list of devices.

## Request Syntax
<a name="API_ListDevices_RequestSyntax"></a>

```
{
   "DeviceFleetName": "string",
   "LatestHeartbeatAfter": number,
   "MaxResults": number,
   "ModelName": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListDevices_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DeviceFleetName](#API_ListDevices_RequestSyntax) **   <a name="sagemaker-ListDevices-request-DeviceFleetName"></a>
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](#API_ListDevices_RequestSyntax) **   <a name="sagemaker-ListDevices-request-LatestHeartbeatAfter"></a>
Select fleets where the job was updated after X  
Type: Timestamp  
Required: No

 ** [MaxResults](#API_ListDevices_RequestSyntax) **   <a name="sagemaker-ListDevices-request-MaxResults"></a>
Maximum number of results to select.  
Type: Integer  
Valid Range: Maximum value of 100.  
Required: No

 ** [ModelName](#API_ListDevices_RequestSyntax) **   <a name="sagemaker-ListDevices-request-ModelName"></a>
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](#API_ListDevices_RequestSyntax) **   <a name="sagemaker-ListDevices-request-NextToken"></a>
The response from the last list when returning a list large enough to need tokening.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `.*`   
Required: No

## Response Syntax
<a name="API_ListDevices_ResponseSyntax"></a>

```
{
   "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
<a name="API_ListDevices_ResponseElements"></a>

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](#API_ListDevices_ResponseSyntax) **   <a name="sagemaker-ListDevices-response-DeviceSummaries"></a>
Summary of devices.  
Type: Array of [DeviceSummary](API_DeviceSummary.md) objects

 ** [NextToken](#API_ListDevices_ResponseSyntax) **   <a name="sagemaker-ListDevices-response-NextToken"></a>
The response from the last list when returning a list large enough to need tokening.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `.*` 

## Errors
<a name="API_ListDevices_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListDevices_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListDevices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListDevices)