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

ReplicationJob

Represents a replication job.

Contents

description

The description of the replication job.

Type: String

Required: No

encrypted

Whether the replication job should produce encrypted AMIs. For more information, see KmsKeyId.

Type: Boolean

Required: No

frequency

The time between consecutive replication runs, in hours.

Type: Integer

Required: No

kmsKeyId

KMS key ID for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to the KMS key ID

  • ARN referring to the KMS key alias

If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Type: String

Required: No

latestAmiId

The ID of the latest Amazon Machine Image (AMI).

Type: String

Required: No

licenseType

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

Type: String

Valid Values: AWS | BYOL

Required: No

nextReplicationRunStartTime

The start time of the next replication run.

Type: Timestamp

Required: No

numberOfRecentAmisToKeep

Number of recent AMIs to keep in the customer's account for a replication job. By default, the value is set to zero, meaning that all AMIs are kept.

Type: Integer

Required: No

replicationJobId

The identifier of the replication job.

Type: String

Required: No

replicationRunList

Information about the replication runs.

Type: Array of ReplicationRun objects

Required: No

roleName

The name of the IAM role to be used by AWS SMS.

Type: String

Required: No

runOnce

Type: Boolean

Required: No

seedReplicationTime

The seed replication time.

Type: Timestamp

Required: No

serverId

The identifier of the server.

Type: String

Required: No

serverType

The type of server.

Type: String

Valid Values: VIRTUAL_MACHINE

Required: No

state

The state of the replication job.

Type: String

Valid Values: PENDING | ACTIVE | FAILED | DELETING | DELETED | COMPLETED | PAUSED_ON_FAILURE | FAILING

Required: No

statusMessage

The description of the current status of the replication job.

Type: String

Required: No

vmServer

Information about the VM server.

Type: VmServer object

Required: No

See Also

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

On this page: