Sign In to the Console
AWS Server Migration Service
API Reference (API Version 2016-10-24)

AWS Documentation » AWS SMS » API Reference » Actions » GetServers
The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetServers

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

Request Syntax

{
   "maxResults": number,
   "nextToken": "string",
   "vmServerAddressList": [ 
      { 
         "vmId": "string",
         "vmManagerId": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

Type: Integer

Required: No

nextToken

The token for the next set of results.

Type: String

Required: No

vmServerAddressList

List of VmServerAddress objects

Type: Array of VmServerAddress objects

Required: No

Response Syntax

{
   "lastModifiedOn": number,
   "nextToken": "string",
   "serverCatalogStatus": "string",
   "serverList": [ 
      { 
         "replicationJobId": "string",
         "replicationJobTerminated": boolean,
         "serverId": "string",
         "serverType": "string",
         "vmServer": { 
            "vmManagerName": "string",
            "vmManagerType": "string",
            "vmName": "string",
            "vmPath": "string",
            "vmServerAddress": { 
               "vmId": "string",
               "vmManagerId": "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.

lastModifiedOn

The time when the server was last modified.

Type: Timestamp

nextToken

The token required to retrieve the next set of results. This value is null when there are no more results to return.

Type: String

serverCatalogStatus

The status of the server catalog.

Type: String

Valid Values: NOT_IMPORTED | IMPORTING | AVAILABLE | DELETED | EXPIRED

serverList

Information about the servers.

Type: Array of Server objects

Errors

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

UnauthorizedOperationException

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: