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

StartTest

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

Request Syntax


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

{
   "accountID": "string",
   "sourceServerIDs": [ "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.

accountID

Start Test for Account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12,}

Required: No

sourceServerIDs

Start Test for Source Server IDs.

Type: Array of strings

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

Length Constraints: Fixed length of 19.

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

Required: Yes

tags

Start Test by 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.

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "job": { 
      "arn": "string",
      "creationDateTime": "string",
      "endDateTime": "string",
      "initiatedBy": "string",
      "jobID": "string",
      "participatingServers": [ 
         { 
            "launchedEc2InstanceID": "string",
            "launchStatus": "string",
            "postLaunchActionsStatus": { 
               "postLaunchActionsLaunchStatusList": [ 
                  { 
                     "executionID": "string",
                     "executionStatus": "string",
                     "failureReason": "string",
                     "ssmDocument": { 
                        "actionName": "string",
                        "externalParameters": { 
                           "string" : { ... }
                        },
                        "mustSucceedForCutover": boolean,
                        "parameters": { 
                           "string" : [ 
                              { 
                                 "parameterName": "string",
                                 "parameterType": "string"
                              }
                           ]
                        },
                        "ssmDocumentName": "string",
                        "timeoutSeconds": number
                     },
                     "ssmDocumentType": "string"
                  }
               ],
               "ssmAgentDiscoveryDatetime": "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

Start Test Job response.

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

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

HTTP Status Code: 400