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
}
]
},
"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"
}
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.
- applicationID
-
Source server application ID.
Type: String
Length Constraints: Fixed length of 21.
Pattern:
^app-[0-9a-zA-Z]{17}$
- arn
-
Source server ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- connectorAction
-
Source Server connector action.
Type: SourceServerConnectorAction object
- dataReplicationInfo
-
Source server data replication info.
Type: DataReplicationInfo object
- fqdnForActionFramework
-
Source server fqdn for action framework.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- isArchived
-
Source server archived status.
Type: Boolean
- launchedInstance
-
Source server launched instance.
Type: LaunchedInstance object
- lifeCycle
-
Source server lifecycle state.
Type: LifeCycle object
- replicationType
-
Source server replication type.
Type: String
Valid Values:
AGENT_BASED | SNAPSHOT_SHIPPING
- sourceProperties
-
Source server properties.
Type: SourceProperties object
- sourceServerID
-
Source server ID.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
^s-[0-9a-zA-Z]{17}$
-
Source server Tags.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
- userProvidedID
-
Source server user provided ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- vcenterClientID
-
Source server vCenter client id.
Type: String
Length Constraints: Fixed length of 21.
Pattern:
^vcc-[0-9a-zA-Z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 409
- ResourceNotFoundException
-
Resource not found exception.
HTTP Status Code: 404
- UninitializedAccountException
-
Uninitialized account 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: