---
title: "POST /list-servers"
method: POST
path: "/list-servers"
---

# POST /list-servers

`POST /list-servers`

Returns a list of all the servers.

## Request body

- object
  - `filterValue` string — Specifies the filter value, which is based on the type of server criteria. For example, if <code>serverCriteria</code> is <code>OS_NAME</code>, and the <code>filterValue</code> is equal to <code>WindowsServer</code>, then <code>ListServers</code> returns all of the servers matching the OS name <code>WindowsServer</code>.
  - `groupIdFilter` Group[] — Specifies the group ID to filter on.
    - `name` 'ExternalId' | 'ExternalSourceType' — The key of the specific import group.
    - `value` string — The value of the specific import group.
  - `maxResults` integer — The maximum number of items to include in the response. The maximum value is 100.
  - `nextToken` string — 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 <code>maxResults</code> 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.
  - `serverCriteria` 'NOT_DEFINED' | 'OS_NAME' | 'STRATEGY' | 'DESTINATION' | 'SERVER_ID' | 'ANALYSIS_STATUS' | 'ERROR_CATEGORY' — Criteria for filtering servers.
  - `sort` 'ASC' | 'DESC' — Specifies whether to sort by ascending (<code>ASC</code>) or descending (<code>DESC</code>) order.

## Response `200`

Success

- ListServersResponse
  - `nextToken` string — The token you use to retrieve the next set of results, or null if there are no more results.
  - `serverInfos` ServerDetail[] — The list of servers with detailed information about each server.
    - `antipatternReportS3Object` object — The S3 bucket name and Amazon S3 key name for anti-pattern report.
      - `s3Bucket` string — The S3 bucket name.
      - `s3key` string — The Amazon S3 key name.
    - `antipatternReportStatus` 'FAILED' | 'IN_PROGRESS' | 'SUCCESS' — The status of the anti-pattern report generation.
    - `antipatternReportStatusMessage` string — A message about the status of the anti-pattern report generation.
    - `applicationComponentStrategySummary` StrategySummary[] — A list of strategy summaries.
      - `count` integer — The count of recommendations per strategy.
      - `strategy` 'Rehost' | 'Retirement' | 'Refactor' | 'Replatform' | 'Retain' | 'Relocate' | 'Repurchase' — The name of recommended strategy.
    - `dataCollectionStatus` 'dataCollectionTaskToBeScheduled' | 'dataCollectionTaskScheduled' | 'dataCollectionTaskStarted' | 'dataCollectionTaskStopped' | 'dataCollectionTaskSuccess' | 'dataCollectionTaskFailed' | 'dataCollectionTaskPartialSuccess' — The status of assessment for the server.
    - `id` string — The server ID.
    - `lastAnalyzedTimestamp` string, date-time — The timestamp of when the server was assessed.
    - `listAntipatternSeveritySummary` AntipatternSeveritySummary[] — A list of anti-pattern severity summaries.
      - `count` integer — Contains the count of anti-patterns.
      - `severity` 'HIGH' | 'MEDIUM' | 'LOW' — Contains the severity of anti-patterns.
    - `name` string — The name of the server.
    - `recommendationSet` object — A set of recommendations.
      - `strategy` 'Rehost' | 'Retirement' | 'Refactor' | 'Replatform' | 'Retain' | 'Relocate' | 'Repurchase' — The recommended strategy.
      - `targetDestination` 'None specified' | 'AWS Elastic BeanStalk' | 'AWS Fargate' | 'Amazon Elastic Cloud Compute (EC2)' | 'Amazon Elastic Container Service (ECS)' | 'Amazon Elastic Kubernetes Service (EKS)' | 'Aurora MySQL' | 'Aurora PostgreSQL' | 'Amazon Relational Database Service on MySQL' | 'Amazon Relational Database Service on PostgreSQL' | 'Amazon DocumentDB' | 'Amazon DynamoDB' | 'Amazon Relational Database Service' | 'Babelfish for Aurora PostgreSQL' — The recommended target destination.
      - `transformationTool` object — The target destination for the recommendation set.
        - `description` string — Description of the tool.
        - `name` 'App2Container' | 'Porting Assistant For .NET' | 'End of Support Migration' | 'Windows Web Application Migration Assistant' | 'Application Migration Service' | 'Strategy Recommendation Support' | 'In Place Operating System Upgrade' | 'Schema Conversion Tool' | 'Database Migration Service' | 'Native SQL Server Backup/Restore' — Name of the tool.
        - `tranformationToolInstallationLink` string — URL for installing the tool.
    - `serverError` object — The error in server analysis.
      - `serverErrorCategory` 'CONNECTIVITY_ERROR' | 'CREDENTIAL_ERROR' | 'PERMISSION_ERROR' | 'ARCHITECTURE_ERROR' | 'OTHER_ERROR' — The error category of server analysis.
    - `serverType` string — The type of server.
    - `statusMessage` string — A message about the status of data collection, which contains detailed descriptions of any error messages.
    - `systemInfo` object — System information about the server.
      - `cpuArchitecture` string — CPU architecture type for the server.
      - `fileSystemType` string — File system type for the server.
      - `networkInfoList` NetworkInfo[] — Networking information related to a server.
        - `interfaceName` string, required — Information about the name of the interface of the server for which the assessment was run.
        - `ipAddress` string, required — Information about the IP address of the server for which the assessment was run.
        - `macAddress` string, required — Information about the MAC address of the server for which the assessment was run.
        - `netMask` string, required — Information about the subnet mask of the server for which the assessment was run.
      - `osInfo` object — Operating system corresponding to a server.
        - `type` 'LINUX' | 'WINDOWS' — Information about the type of operating system.
        - `version` string — Information about the version of operating system.

## Other responses

- `480` — AccessDeniedException
- `481` — ThrottlingException
- `482` — ValidationException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/migrationhubstrategy.md) · [All operations](https://skmtc.net/aws/apis/migrationhubstrategy/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/migrationhubstrategy/versions/5fde79aed042/schema)