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

ListDiscoveredDevices

Lists all devices discovered during a specific device discovery task.

Request Syntax


GET /device-discoveries/Identifier/devices?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identifier

The identifier of the device discovery job to list discovered devices for.

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

Pattern: [A-Za-z0-9]+

Required: Yes

MaxResults

The maximum number of discovered devices 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=_-]+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "AuthenticationMaterial": "string",
         "Brand": "string",
         "ConnectorDeviceId": "string",
         "ConnectorDeviceName": "string",
         "DeviceTypes": [ "string" ],
         "DiscoveredAt": number,
         "ManagedThingId": "string",
         "Model": "string",
         "Modification": "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 discovered devices that match the specified criteria.

Type: Array of DiscoveredDeviceSummary objects

NextToken

A token used for pagination of results when there are more discovered devices 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

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

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