(constructor)

[configuration]

Constructs a new instance of the <code>MgnClient</code> class

config

The resolved configuration of MgnClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-mgn!MgnClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

MgnClient

The Application Migration Service service.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

ArchiveApplicationCommand

ArchiveWaveCommand

AssociateApplicationsCommand

AssociateSourceServersCommand

Associate source servers to application.

ChangeServerLifeCycleStateCommand

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.)

CreateApplicationCommand

CreateConnectorCommand

CreateLaunchConfigurationTemplateCommand

Creates a new Launch Configuration Template.

CreateReplicationConfigurationTemplateCommand

Creates a new ReplicationConfigurationTemplate.

CreateWaveCommand

DeleteApplicationCommand

DeleteConnectorCommand

DeleteJobCommand

DeleteLaunchConfigurationTemplateCommand

Deletes a single Launch Configuration Template by ID.

DeleteReplicationConfigurationTemplateCommand

Deletes a single Replication Configuration Template by ID

DeleteSourceServerCommand

Deletes a single source server by ID.

DeleteVcenterClientCommand

Deletes a given vCenter client by ID.

DeleteWaveCommand

DescribeJobLogItemsCommand

Retrieves detailed job log items with paging.

DescribeJobsCommand

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.

DescribeLaunchConfigurationTemplatesCommand

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

DescribeReplicationConfigurationTemplatesCommand

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

DescribeSourceServersCommand

Retrieves all SourceServers or multiple SourceServers by ID.

DescribeVcenterClientsCommand

Returns a list of the installed vCenter clients.

DisassociateApplicationsCommand

Disassociate applications from wave.

DisassociateSourceServersCommand

Disassociate source servers from application.

DisconnectFromServiceCommand

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.

FinalizeCutoverCommand

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.

GetLaunchConfigurationCommand

Lists all LaunchConfigurations available, filtered by Source Server IDs.

GetReplicationConfigurationCommand

Lists all ReplicationConfigurations, filtered by Source Server ID.

InitializeServiceCommand

Initialize Application Migration Service.

ListApplicationsCommand

Retrieves all applications or multiple applications by ID.

ListConnectorsCommand

ListExportErrorsCommand

ListExportsCommand

ListImportErrorsCommand

ListImportsCommand

ListManagedAccountsCommand

ListSourceServerActionsCommand

List source server post migration custom actions.

ListTagsForResourceCommand

List all tags for your Application Migration Service resources.

ListTemplateActionsCommand

List template post migration custom actions.

ListWavesCommand

Retrieves all waves or multiple waves by ID.

MarkAsArchivedCommand

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.

PauseReplicationCommand

PutSourceServerActionCommand

Put source server post migration custom action.

PutTemplateActionCommand

Put template post migration custom action.

RemoveSourceServerActionCommand

Remove source server post migration custom action.

RemoveTemplateActionCommand

Remove template post migration custom action.

ResumeReplicationCommand

RetryDataReplicationCommand

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.

StartCutoverCommand

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.

StartExportCommand

StartImportCommand

StartReplicationCommand

Starts replication for SNAPSHOT_SHIPPING agents.

StartTestCommand

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.

StopReplicationCommand

TagResourceCommand

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.

TerminateTargetInstancesCommand

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.

UnarchiveApplicationCommand

UnarchiveWaveCommand

UntagResourceCommand

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

UpdateApplicationCommand

UpdateConnectorCommand

UpdateLaunchConfigurationCommand

Updates multiple LaunchConfigurations by Source Server ID. <note> bootMode valid values are <code>LEGACY_BIOS | UEFI</code> </note>

UpdateLaunchConfigurationTemplateCommand

Updates an existing Launch Configuration Template by ID.

UpdateReplicationConfigurationCommand

Allows you to update multiple ReplicationConfigurations by Source Server ID.

UpdateReplicationConfigurationTemplateCommand

Updates multiple ReplicationConfigurationTemplates by ID.

UpdateSourceServerCommand

UpdateSourceServerReplicationTypeCommand

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