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

ListDeviceDiscoveries

Lists all device discovery tasks, with optional filtering by type and status.

Request Syntax


GET /device-discoveries?MaxResults=MaxResults&NextToken=NextToken&StatusFilter=StatusFilter&TypeFilter=TypeFilter HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of device discovery jobs to return in a single response.

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

NextToken

A token used for pagination of results.

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

Pattern: [a-zA-Z0-9=_-]+

StatusFilter

The status to filter device discovery jobs by.

Valid Values: RUNNING | SUCCEEDED | FAILED | TIMED_OUT

TypeFilter

The discovery type to filter device discovery jobs by.

Valid Values: ZWAVE | ZIGBEE | CLOUD | CUSTOM

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "DiscoveryType": "string",
         "Id": "string",
         "Status": "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.

Items

The list of device discovery jobs that match the specified criteria.

Type: Array of DeviceDiscoverySummary objects

NextToken

A token used for pagination of results when there are more device discovery jobs than can be returned in a single response.

Type: String

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

Pattern: [a-zA-Z0-9=_-]+

Errors

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

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400