AWS Server Migration Service
API Reference (API Version 2016-10-24)

StartOnDemandReplicationRun

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.

description

The description of the replication run.

Type: String

Required: No

replicationJobId

The identifier 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.

replicationRunId

The identifier of the replication run.

Type: String

Errors

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

InvalidParameterException

A specified parameter is not valid.

HTTP Status Code: 400

MissingRequiredParameterException

A required parameter is missing.

HTTP Status Code: 400

OperationNotPermittedException

This operation is not allowed.

HTTP Status Code: 400

ReplicationRunLimitExceededException

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

HTTP Status Code: 400

UnauthorizedOperationException

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

HTTP Status Code: 400

See Also

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