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

ListDetectors

Lists detectors (the instances of a detector model).

Request Syntax


GET /detectors/detectorModelName?maxResults=maxResults&nextToken=nextToken&stateName=stateName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

detectorModelName

The name of the detector model whose detectors (instances) are listed.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

maxResults

The maximum number of results to be returned per request.

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

nextToken

The token that you can use to return the next set of results.

stateName

A filter that limits results to those detectors (instances) in the given state.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "detectorSummaries": [ 
      { 
         "creationTime": number,
         "detectorModelName": "string",
         "detectorModelVersion": "string",
         "keyValue": "string",
         "lastUpdateTime": number,
         "state": { 
            "stateName": "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.

detectorSummaries

A list of summary information about the detectors (instances).

Type: Array of DetectorSummary objects

nextToken

The token that you can use to return the next set of results, or null if there are no more results.

Type: String

Errors

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

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidRequestException

The request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429