Package-level declarations

Types

Link copied to clipboard
interface MgnClient

The Application Migration Service service.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

Archive application.

Link copied to clipboard
inline suspend fun MgnClient.archiveWave(crossinline block: ArchiveWaveRequest.Builder.() -> Unit): ArchiveWaveResponse

Archive wave.

Link copied to clipboard

Associate applications to wave.

Link copied to clipboard

Associate source servers to application.

Link copied to clipboard

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

Link copied to clipboard

Create application.

Link copied to clipboard

Create Connector.

Link copied to clipboard

Creates a new Launch Configuration Template.

Link copied to clipboard

Creates a new network migration definition that specifies the source and target network configuration for a migration.

Link copied to clipboard
inline suspend fun MgnClient.createWave(crossinline block: CreateWaveRequest.Builder.() -> Unit): CreateWaveResponse

Create wave.

Link copied to clipboard

Delete application.

Link copied to clipboard

Delete Connector.

Link copied to clipboard
inline suspend fun MgnClient.deleteJob(crossinline block: DeleteJobRequest.Builder.() -> Unit): DeleteJobResponse

Deletes a single Job by ID.

Link copied to clipboard

Deletes a single Launch Configuration Template by ID.

Link copied to clipboard

Deletes a network migration definition. This operation removes the migration definition and all associated metadata.

Link copied to clipboard

Deletes a single Replication Configuration Template by ID

Link copied to clipboard

Deletes a single source server by ID.

Link copied to clipboard

Deletes a given vCenter client by ID.

Link copied to clipboard
inline suspend fun MgnClient.deleteWave(crossinline block: DeleteWaveRequest.Builder.() -> Unit): DeleteWaveResponse

Delete wave.

Link copied to clipboard

Retrieves detailed job log items with paging.

Link copied to clipboard
inline suspend fun MgnClient.describeJobs(crossinline block: DescribeJobsRequest.Builder.() -> Unit): DescribeJobsResponse

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

Link copied to clipboard

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Link copied to clipboard

Retrieves all SourceServers or multiple SourceServers by ID.

Link copied to clipboard

Returns a list of the installed vCenter clients.

Link copied to clipboard

Disassociate applications from wave.

Link copied to clipboard

Disassociate source servers from application.

Link copied to clipboard

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link copied to clipboard

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link copied to clipboard

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Link copied to clipboard

Retrieves the details of a network migration definition including source and target configurations.

Retrieves detailed information about a specific construct within a mapper segment, including its properties and configuration data.

Link copied to clipboard

Lists all ReplicationConfigurations, filtered by Source Server ID.

Link copied to clipboard

Initialize Application Migration Service.

Link copied to clipboard

Retrieves all applications or multiple applications by ID.

Link copied to clipboard

List Connectors.

Link copied to clipboard

List export errors.

Link copied to clipboard
inline suspend fun MgnClient.listExports(crossinline block: ListExportsRequest.Builder.() -> Unit): ListExportsResponse

List exports.

Link copied to clipboard

List import errors.

Link copied to clipboard

Lists import file enrichment jobs with optional filtering by job IDs.

Link copied to clipboard
inline suspend fun MgnClient.listImports(crossinline block: ListImportsRequest.Builder.() -> Unit): ListImportsResponse

List imports.

Link copied to clipboard

List Managed Accounts.

Link copied to clipboard

Lists network migration analysis jobs for a specified execution. Returns information about analysis job status and results.

Link copied to clipboard

Lists the results of network migration analyses, showing connectivity and compatibility findings for migrated resources.

Link copied to clipboard

Lists network migration code generation jobs, which convert network mappings into infrastructure-as-code templates.

Lists code generation segments, which represent individual infrastructure components generated as code templates.

Link copied to clipboard

Lists all network migration definitions in the account, with optional filtering.

Link copied to clipboard

Lists CloudFormation stacks that have been deployed as part of the network migration.

Link copied to clipboard

Lists network migration deployment jobs and their current status.

Link copied to clipboard

Lists network migration execution instances for a given definition, showing the status and progress of each execution.

Lists constructs within a mapper segment, representing individual infrastructure components like VPCs, subnets, or security groups.

Link copied to clipboard

Lists mapper segments, which represent logical groupings of network resources to be migrated together.

Link copied to clipboard

Lists network migration mapping jobs, which analyze and create relationships between source and target network resources.

Link copied to clipboard

Lists mapping update jobs, which apply customer modifications to the generated network mappings.

Link copied to clipboard

List source server post migration custom actions.

Link copied to clipboard

List all tags for your Application Migration Service resources.

Link copied to clipboard

List template post migration custom actions.

Link copied to clipboard
inline suspend fun MgnClient.listWaves(crossinline block: ListWavesRequest.Builder.() -> Unit): ListWavesResponse

Retrieves all waves or multiple waves by ID.

Link copied to clipboard

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

Link copied to clipboard

Pause Replication.

Link copied to clipboard

Put source server post migration custom action.

Link copied to clipboard

Put template post migration custom action.

Link copied to clipboard

Remove source server post migration custom action.

Link copied to clipboard

Remove template post migration custom action.

Link copied to clipboard

Resume Replication.

Link copied to clipboard

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

Link copied to clipboard
inline suspend fun MgnClient.startCutover(crossinline block: StartCutoverRequest.Builder.() -> Unit): StartCutoverResponse

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

Link copied to clipboard
inline suspend fun MgnClient.startExport(crossinline block: StartExportRequest.Builder.() -> Unit): StartExportResponse

Start export.

Link copied to clipboard
inline suspend fun MgnClient.startImport(crossinline block: StartImportRequest.Builder.() -> Unit): StartImportResponse

Start import.

Link copied to clipboard

Starts an import file enrichment job to process and enrich network migration import files with additional metadata and IP assignment strategies.

Link copied to clipboard

Starts a network migration analysis job to evaluate connectivity and compatibility of the migration mappings.

Link copied to clipboard

Starts a code generation job to convert network migration mappings into infrastructure-as-code templates.

Link copied to clipboard

Starts a deployment job to create the target network infrastructure based on the generated code templates.

Link copied to clipboard

Starts the network migration mapping process for a given network migration execution.

Link copied to clipboard

Starts a job to apply customer modifications to network migration mappings, such as changing properties.

Link copied to clipboard

Start replication for source server irrespective of its replication type.

Link copied to clipboard
inline suspend fun MgnClient.startTest(crossinline block: StartTestRequest.Builder.() -> Unit): StartTestResponse

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.

Link copied to clipboard

Stop Replication.

Link copied to clipboard
inline suspend fun MgnClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

Link copied to clipboard

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

Link copied to clipboard

Unarchive application.

Link copied to clipboard
inline suspend fun MgnClient.unarchiveWave(crossinline block: UnarchiveWaveRequest.Builder.() -> Unit): UnarchiveWaveResponse

Unarchive wave.

Link copied to clipboard
inline suspend fun MgnClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes the specified set of tags from the specified set of Application Migration Service resources.

Link copied to clipboard

Update application.

Link copied to clipboard

Update Connector.

Link copied to clipboard

Updates multiple LaunchConfigurations by Source Server ID.

Link copied to clipboard

Updates an existing Launch Configuration Template by ID.

Link copied to clipboard

Updates an existing network migration definition with new source or target configurations.

Link copied to clipboard

Updates a mapper segment's configuration, such as changing its scope tags.

Link copied to clipboard

Allows you to update multiple ReplicationConfigurations by Source Server ID.

Link copied to clipboard

Updates multiple ReplicationConfigurationTemplates by ID.

Link copied to clipboard

Update Source Server.

Link copied to clipboard

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

Link copied to clipboard
inline suspend fun MgnClient.updateWave(crossinline block: UpdateWaveRequest.Builder.() -> Unit): UpdateWaveResponse

Update wave.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.