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

SearchDevices

Searches for devices using the specified filters.

Request Syntax


POST /devices HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

The filter values to use to search for a device.

Type: Array of SearchDevicesFilter objects

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

Required: Yes

maxResults

The maximum number of results to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "devices": [ 
      { 
         "deviceArn": "string",
         "deviceName": "string",
         "deviceStatus": "string",
         "deviceType": "string",
         "providerName": "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

An array of DeviceSummary objects for devices that match the specified filter values.

Type: Array of DeviceSummary objects

nextToken

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ThrottlingException

The throttling rate limit is met.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400