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

StartRecovery

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

Request Syntax


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

{
   "isDrill": boolean,
   "sourceServers": [ 
      { 
         "recoverySnapshotID": "string",
         "sourceServerID": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

isDrill

Whether this Source Server Recovery operation is a drill or not.

Type: Boolean

Required: No

sourceServers

The Source Servers that we want to start a Recovery Job for.

Type: Array of StartRecoveryRequestSourceServer objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: Yes

tags

The tags to be associated with the Recovery Job.

Type: String to string map

Key Length Constraints: Minimum length of 0. Maximum length of 256.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "job": { 
      "arn": "string",
      "creationDateTime": "string",
      "endDateTime": "string",
      "initiatedBy": "string",
      "jobID": "string",
      "participatingResources": [ 
         { 
            "launchStatus": "string",
            "participatingResourceID": { ... }
         }
      ],
      "participatingServers": [ 
         { 
            "launchActionsStatus": { 
               "runs": [ 
                  { 
                     "action": { 
                        "actionCode": "string",
                        "actionId": "string",
                        "actionVersion": "string",
                        "active": boolean,
                        "category": "string",
                        "description": "string",
                        "name": "string",
                        "optional": boolean,
                        "order": number,
                        "parameters": { 
                           "string" : { 
                              "type": "string",
                              "value": "string"
                           }
                        },
                        "type": "string"
                     },
                     "failureReason": "string",
                     "runId": "string",
                     "status": "string"
                  }
               ],
               "ssmAgentDiscoveryDatetime": "string"
            },
            "launchStatus": "string",
            "recoveryInstanceID": "string",
            "sourceServerID": "string"
         }
      ],
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

job

The Recovery Job.

Type: Job object

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

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ServiceQuotaExceededException

The request could not be completed because its exceeded the service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UninitializedAccountException

The account performing the request has not been initialized.

HTTP Status Code: 400