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

ListServers

Returns a list of all the servers.

Request Syntax


POST /list-servers HTTP/1.1
Content-type: application/json

{
   "filterValue": "string",
   "groupIdFilter": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "serverCriteria": "string",
   "sort": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filterValue

Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.

Type: String

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

Pattern: .*\S.*

Required: No

groupIdFilter

Specifies the group ID to filter on.

Type: Array of Group objects

Required: No

maxResults

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

Type: Integer

Required: No

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.

Type: String

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

Pattern: .*\S.*

Required: No

serverCriteria

Criteria for filtering servers.

Type: String

Required: No

sort

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

Type: String

Valid Values: ASC | DESC

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "serverInfos": [ 
      { 
         "antipatternReportS3Object": { 
            "s3Bucket": "string",
            "s3key": "string"
         },
         "antipatternReportStatus": "string",
         "antipatternReportStatusMessage": "string",
         "applicationComponentStrategySummary": [ 
            { 
               "count": number,
               "strategy": "string"
            }
         ],
         "dataCollectionStatus": "string",
         "id": "string",
         "lastAnalyzedTimestamp": number,
         "listAntipatternSeveritySummary": [ 
            { 
               "count": number,
               "severity": "string"
            }
         ],
         "name": "string",
         "recommendationSet": { 
            "strategy": "string",
            "targetDestination": "string",
            "transformationTool": { 
               "description": "string",
               "name": "string",
               "tranformationToolInstallationLink": "string"
            }
         },
         "serverError": { 
            "serverErrorCategory": "string"
         },
         "serverType": "string",
         "statusMessage": "string",
         "systemInfo": { 
            "cpuArchitecture": "string",
            "fileSystemType": "string",
            "networkInfoList": [ 
               { 
                  "interfaceName": "string",
                  "ipAddress": "string",
                  "macAddress": "string",
                  "netMask": "string"
               }
            ],
            "osInfo": { 
               "type": "string",
               "version": "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.

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.*

serverInfos

The list of servers with detailed information about each server.

Type: Array of ServerDetail objects

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