MgnClientProtocol
The Application Migration Service service.
public protocol MgnClientProtocol
Requirements
changeServerLifeCycleState(input:completion:)
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.)
func changeServerLifeCycleState(input: ChangeServerLifeCycleStateInput, completion: @escaping (ClientRuntime.SdkResult<ChangeServerLifeCycleStateOutputResponse, ChangeServerLifeCycleStateOutputError>) -> Void)
createReplicationConfigurationTemplate(input:completion:)
Creates a new ReplicationConfigurationTemplate.
func createReplicationConfigurationTemplate(input: CreateReplicationConfigurationTemplateInput, completion: @escaping (ClientRuntime.SdkResult<CreateReplicationConfigurationTemplateOutputResponse, CreateReplicationConfigurationTemplateOutputError>) -> Void)
deleteJob(input:completion:)
Deletes a single Job by ID.
func deleteJob(input: DeleteJobInput, completion: @escaping (ClientRuntime.SdkResult<DeleteJobOutputResponse, DeleteJobOutputError>) -> Void)
deleteReplicationConfigurationTemplate(input:completion:)
Deletes a single Replication Configuration Template by ID
func deleteReplicationConfigurationTemplate(input: DeleteReplicationConfigurationTemplateInput, completion: @escaping (ClientRuntime.SdkResult<DeleteReplicationConfigurationTemplateOutputResponse, DeleteReplicationConfigurationTemplateOutputError>) -> Void)
deleteSourceServer(input:completion:)
Deletes a single source server by ID.
func deleteSourceServer(input: DeleteSourceServerInput, completion: @escaping (ClientRuntime.SdkResult<DeleteSourceServerOutputResponse, DeleteSourceServerOutputError>) -> Void)
describeJobLogItems(input:completion:)
Retrieves detailed Job log with paging.
func describeJobLogItems(input: DescribeJobLogItemsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeJobLogItemsOutputResponse, DescribeJobLogItemsOutputError>) -> Void)
describeJobs(input:completion:)
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 normaly 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.
func describeJobs(input: DescribeJobsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeJobsOutputResponse, DescribeJobsOutputError>) -> Void)
describeReplicationConfigurationTemplates(input:completion:)
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
func describeReplicationConfigurationTemplates(input: DescribeReplicationConfigurationTemplatesInput, completion: @escaping (ClientRuntime.SdkResult<DescribeReplicationConfigurationTemplatesOutputResponse, DescribeReplicationConfigurationTemplatesOutputError>) -> Void)
describeSourceServers(input:completion:)
Retrieves all SourceServers or multiple SourceServers by ID.
func describeSourceServers(input: DescribeSourceServersInput, completion: @escaping (ClientRuntime.SdkResult<DescribeSourceServersOutputResponse, DescribeSourceServersOutputError>) -> Void)
disconnectFromService(input:completion:)
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 communciating 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.lagDurationwill be nullified.
func disconnectFromService(input: DisconnectFromServiceInput, completion: @escaping (ClientRuntime.SdkResult<DisconnectFromServiceOutputResponse, DisconnectFromServiceOutputError>) -> Void)
finalizeCutover(input:completion:)
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 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.lagDurationwill be nullified.
func finalizeCutover(input: FinalizeCutoverInput, completion: @escaping (ClientRuntime.SdkResult<FinalizeCutoverOutputResponse, FinalizeCutoverOutputError>) -> Void)
getLaunchConfiguration(input:completion:)
Lists all LaunchConfigurations available, filtered by Source Server IDs.
func getLaunchConfiguration(input: GetLaunchConfigurationInput, completion: @escaping (ClientRuntime.SdkResult<GetLaunchConfigurationOutputResponse, GetLaunchConfigurationOutputError>) -> Void)
getReplicationConfiguration(input:completion:)
Lists all ReplicationConfigurations, filtered by Source Server ID.
func getReplicationConfiguration(input: GetReplicationConfigurationInput, completion: @escaping (ClientRuntime.SdkResult<GetReplicationConfigurationOutputResponse, GetReplicationConfigurationOutputError>) -> Void)
initializeService(input:completion:)
Initialize Application Migration Service.
func initializeService(input: InitializeServiceInput, completion: @escaping (ClientRuntime.SdkResult<InitializeServiceOutputResponse, InitializeServiceOutputError>) -> Void)
listTagsForResource(input:completion:)
List all tags for your Application Migration Service resources.
func listTagsForResource(input: ListTagsForResourceInput, completion: @escaping (ClientRuntime.SdkResult<ListTagsForResourceOutputResponse, ListTagsForResourceOutputError>) -> Void)
markAsArchived(input:completion:)
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.
func markAsArchived(input: MarkAsArchivedInput, completion: @escaping (ClientRuntime.SdkResult<MarkAsArchivedOutputResponse, MarkAsArchivedOutputError>) -> Void)
retryDataReplication(input:completion:)
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.
func retryDataReplication(input: RetryDataReplicationInput, completion: @escaping (ClientRuntime.SdkResult<RetryDataReplicationOutputResponse, RetryDataReplicationOutputError>) -> Void)
startCutover(input:completion:)
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.
func startCutover(input: StartCutoverInput, completion: @escaping (ClientRuntime.SdkResult<StartCutoverOutputResponse, StartCutoverOutputError>) -> Void)
startTest(input:completion:)
Lauches 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.
func startTest(input: StartTestInput, completion: @escaping (ClientRuntime.SdkResult<StartTestOutputResponse, StartTestOutputError>) -> Void)
tagResource(input:completion:)
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.
func tagResource(input: TagResourceInput, completion: @escaping (ClientRuntime.SdkResult<TagResourceOutputResponse, TagResourceOutputError>) -> Void)
terminateTargetInstances(input:completion:)
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.
func terminateTargetInstances(input: TerminateTargetInstancesInput, completion: @escaping (ClientRuntime.SdkResult<TerminateTargetInstancesOutputResponse, TerminateTargetInstancesOutputError>) -> Void)
untagResource(input:completion:)
Deletes the specified set of tags from the specified set of Application Migration Service resources.
func untagResource(input: UntagResourceInput, completion: @escaping (ClientRuntime.SdkResult<UntagResourceOutputResponse, UntagResourceOutputError>) -> Void)
updateLaunchConfiguration(input:completion:)
Updates multiple LaunchConfigurations by Source Server ID.
func updateLaunchConfiguration(input: UpdateLaunchConfigurationInput, completion: @escaping (ClientRuntime.SdkResult<UpdateLaunchConfigurationOutputResponse, UpdateLaunchConfigurationOutputError>) -> Void)
updateReplicationConfiguration(input:completion:)
Allows you to update multiple ReplicationConfigurations by Source Server ID.
func updateReplicationConfiguration(input: UpdateReplicationConfigurationInput, completion: @escaping (ClientRuntime.SdkResult<UpdateReplicationConfigurationOutputResponse, UpdateReplicationConfigurationOutputError>) -> Void)
updateReplicationConfigurationTemplate(input:completion:)
Updates multiple ReplicationConfigurationTemplates by ID.
func updateReplicationConfigurationTemplate(input: UpdateReplicationConfigurationTemplateInput, completion: @escaping (ClientRuntime.SdkResult<UpdateReplicationConfigurationTemplateOutputResponse, UpdateReplicationConfigurationTemplateOutputError>) -> Void)