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

ListCollectors

Retrieves a list of all the installed collectors.

Request Syntax


GET /list-collectors?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of items to include in the response. The maximum value is 100.

nextToken

The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*\S.*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Collectors": [ 
      { 
         "collectorHealth": "string",
         "collectorId": "string",
         "collectorVersion": "string",
         "configurationSummary": { 
            "ipAddressBasedRemoteInfoList": [ 
               { 
                  "authType": "string",
                  "ipAddressConfigurationTimeStamp": "string",
                  "osType": "string"
               }
            ],
            "pipelineInfoList": [ 
               { 
                  "pipelineConfigurationTimeStamp": "string",
                  "pipelineType": "string"
               }
            ],
            "remoteSourceCodeAnalysisServerInfo": { 
               "remoteSourceCodeAnalysisServerConfigurationTimestamp": "string"
            },
            "vcenterBasedRemoteInfoList": [ 
               { 
                  "osType": "string",
                  "vcenterConfigurationTimeStamp": "string"
               }
            ],
            "versionControlInfoList": [ 
               { 
                  "versionControlConfigurationTimeStamp": "string",
                  "versionControlType": "string"
               }
            ]
         },
         "hostName": "string",
         "ipAddress": "string",
         "lastActivityTimeStamp": "string",
         "registeredTimeStamp": "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.

Collectors

The list of all the installed collectors.

Type: Array of Collector objects

nextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: .*\S.*

Errors

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

AccessDeniedException

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

HTTP Status Code: 403

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request body isn't valid.

HTTP Status Code: 400