Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1435213121.1 KB

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).

post/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.CreateReplicationJob

Headers

X-Amz-Target'AWSServerMigrationService_V2016_10_24.CreateReplicationJob' required

Request body

serverIdstring required

The ID of the server.

seedReplicationTimestring date-time required

The seed replication time.

frequencyinteger

The time between consecutive replication runs, in hours.

runOnceboolean

Indicates whether to run the replication job one time.

licenseType'AWS' | 'BYOL'

The license type to be used for the AMI created by a successful replication run.

roleNamestring

The name of the IAM role to be used by the Server Migration Service.

descriptionstring

The description of the replication job.

numberOfRecentAmisToKeepinteger

The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.

encryptedboolean

Indicates whether the replication job produces encrypted AMIs.

kmsKeyIdstring
<p>The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:</p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to the KMS key ID</p> </li> <li> <p>ARN referring to the KMS key alias</p> </li> </ul> <p> If encrypted is <i>true</i> but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used. </p>

Response

Success

replicationJobIdstring

The unique identifier of the replication job.