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

MarkAsArchived

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

Request Syntax


POST /MarkAsArchived HTTP/1.1
Content-type: application/json

{
   "accountID": "string",
   "sourceServerID": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountID

Mark as archived by Account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12,}

Required: No

sourceServerID

Mark as archived by Source Server ID.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^s-[0-9a-zA-Z]{17}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationID": "string",
   "arn": "string",
   "connectorAction": { 
      "connectorArn": "string",
      "credentialsSecretArn": "string"
   },
   "dataReplicationInfo": { 
      "dataReplicationError": { 
         "error": "string",
         "rawError": "string"
      },
      "dataReplicationInitiation": { 
         "nextAttemptDateTime": "string",
         "startDateTime": "string",
         "steps": [ 
            { 
               "name": "string",
               "status": "string"
            }
         ]
      },
      "dataReplicationState": "string",
      "etaDateTime": "string",
      "lagDuration": "string",
      "lastSnapshotDateTime": "string",
      "replicatedDisks": [ 
         { 
            "backloggedStorageBytes": number,
            "deviceName": "string",
            "replicatedStorageBytes": number,
            "rescannedStorageBytes": number,
            "totalStorageBytes": number
         }
      ],
      "replicatorId": "string"
   },
   "fqdnForActionFramework": "string",
   "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"
   },
   "replicationType": "string",
   "sourceProperties": { 
      "cpus": [ 
         { 
            "cores": number,
            "modelName": "string"
         }
      ],
      "disks": [ 
         { 
            "bytes": number,
            "deviceName": "string"
         }
      ],
      "identificationHints": { 
         "awsInstanceID": "string",
         "fqdn": "string",
         "hostname": "string",
         "vmPath": "string",
         "vmWareUuid": "string"
      },
      "lastUpdatedDateTime": "string",
      "networkInterfaces": [ 
         { 
            "ips": [ "string" ],
            "isPrimary": boolean,
            "macAddress": "string"
         }
      ],
      "os": { 
         "fullString": "string"
      },
      "ramBytes": number,
      "recommendedInstanceType": "string"
   },
   "sourceServerID": "string",
   "tags": { 
      "string" : "string" 
   },
   "userProvidedID": "string",
   "vcenterClientID": "string"
}