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

ListDevices

Returns a list of devices.

Request Syntax


GET /devices?DeviceAggregatedStatusFilter=DeviceAggregatedStatusFilter&MaxResults=MaxResults&NameFilter=NameFilter&NextToken=NextToken&SortBy=SortBy&SortOrder=SortOrder HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DeviceAggregatedStatusFilter

Filter based on a device's status.

MaxResults

The maximum number of devices to return in one page of results.

Valid Range: Minimum value of 0. Maximum value of 25.

NameFilter

Filter based on device's name. Prefixes supported.

NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

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

Pattern: ^.+$

SortBy

The target column to be sorted on. Default column sort is CREATED_TIME.

Valid Values: DEVICE_ID | CREATED_TIME | NAME | DEVICE_AGGREGATED_STATUS

SortOrder

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Valid Values: ASCENDING | DESCENDING

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Devices": [ 
      { 
         "Brand": "string",
         "CreatedTime": number,
         "CurrentSoftware": "string",
         "Description": "string",
         "DeviceAggregatedStatus": "string",
         "DeviceId": "string",
         "LastUpdatedTime": number,
         "LatestDeviceJob": { 
            "ImageVersion": "string",
            "JobType": "string",
            "Status": "string"
         },
         "LeaseExpirationTime": number,
         "Name": "string",
         "ProvisioningStatus": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "string"
      }
   ],
   "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.

Devices

A list of devices.

Type: Array of Device objects

NextToken

A pagination token that's included if more results are available.

Type: String

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

Pattern: ^.+$

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

ConflictException

The target resource is in use.

HTTP Status Code: 409

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400