StartOnDemandReplicationRun - Amazon Server Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

Request Syntax

{ "description": "string", "replicationJobId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The description of the replication run.

Type: String

Required: No


The ID of the replication job.

Type: String

Required: Yes

Response Syntax

{ "replicationRunId": "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.


The ID of the replication run.

Type: String


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


The user has the required permissions, so the request would have succeeded, but a dry run was performed.

HTTP Status Code: 400


A specified parameter is not valid.

HTTP Status Code: 400


A required parameter is missing.

HTTP Status Code: 400


This operation is not allowed.

HTTP Status Code: 400


You have exceeded the number of on-demand replication runs you can request in a 24-hour period.

HTTP Status Code: 400


You lack permissions needed to perform this operation.

HTTP Status Code: 400

See Also

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