DescribeSourceServers - Application Migration Service

DescribeSourceServers

Retrieves all SourceServers or multiple SourceServers by ID.

Request Syntax

POST /DescribeSourceServers HTTP/1.1 Content-type: application/json { "filters": { "isArchived": boolean, "sourceServerIDs": [ "string" ] }, "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filters

Request to filter Source Servers list.

Type: DescribeSourceServersRequestFilters object

Required: Yes

maxResults

Request to filter Source Servers list by maximum results.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

nextToken

Request to filter Source Servers list by next token.

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "items": [ { "arn": "string", "dataReplicationInfo": { "dataReplicationError": { "error": "string", "rawError": "string" }, "dataReplicationInitiation": { "nextAttemptDateTime": "string", "startDateTime": "string", "steps": [ { "name": "string", "status": "string" } ] }, "dataReplicationState": "string", "etaDateTime": "string", "lagDuration": "string", "replicatedDisks": [ { "backloggedStorageBytes": number, "deviceName": "string", "replicatedStorageBytes": number, "rescannedStorageBytes": number, "totalStorageBytes": number } ] }, "isArchived": boolean, "launchedInstance": { "ec2InstanceID": "string", "firstBoot": "string", "jobID": "string" }, "lifeCycle": { "addedToServiceDateTime": "string", "elapsedReplicationDuration": "string", "firstByteDateTime": "string", "lastCutover": { "finalized": { "apiCallDateTime": "string" }, "initiated": { "apiCallDateTime": "string", "jobID": "string" }, "reverted": { "apiCallDateTime": "string" } }, "lastSeenByServiceDateTime": "string", "lastTest": { "finalized": { "apiCallDateTime": "string" }, "initiated": { "apiCallDateTime": "string", "jobID": "string" }, "reverted": { "apiCallDateTime": "string" } }, "state": "string" }, "sourceProperties": { "cpus": [ { "cores": number, "modelName": "string" } ], "disks": [ { "bytes": number, "deviceName": "string" } ], "identificationHints": { "awsInstanceID": "string", "fqdn": "string", "hostname": "string", "vmWareUuid": "string" }, "lastUpdatedDateTime": "string", "networkInterfaces": [ { "ips": [ "string" ], "isPrimary": boolean, "macAddress": "string" } ], "os": { "fullString": "string" }, "ramBytes": number, "recommendedInstanceType": "string" }, "sourceServerID": "string", "tags": { "string" : "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.

items

Request to filter Source Servers list by item.

Type: Array of SourceServer objects

nextToken

Request to filter Source Servers next token.

Type: String

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

Errors

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

UninitializedAccountException

Unitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

HTTP Status Code: 400

See Also

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