AbstractAWSmgn (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mgn.AbstractAWSmgn

All Implemented Interfaces:

AWSmgn

Direct Known Subclasses:

AbstractAWSmgnAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSmgn
extends Object
implements AWSmgn
```
Abstract implementation of AWSmgn. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.mgn.AWSmgn
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChangeServerLifeCycleStateResult`	`changeServerLifeCycleState(ChangeServerLifeCycleStateRequest request)` 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.
`CreateReplicationConfigurationTemplateResult`	`createReplicationConfigurationTemplate(CreateReplicationConfigurationTemplateRequest request)` Creates a new ReplicationConfigurationTemplate.
`DeleteJobResult`	`deleteJob(DeleteJobRequest request)` Deletes a single Job by ID.
`DeleteReplicationConfigurationTemplateResult`	`deleteReplicationConfigurationTemplate(DeleteReplicationConfigurationTemplateRequest request)` Deletes a single Replication Configuration Template by ID
`DeleteSourceServerResult`	`deleteSourceServer(DeleteSourceServerRequest request)` Deletes a single source server by ID.
`DeleteVcenterClientResult`	`deleteVcenterClient(DeleteVcenterClientRequest request)` Deletes a given vCenter client by ID.
`DescribeJobLogItemsResult`	`describeJobLogItems(DescribeJobLogItemsRequest request)` Retrieves detailed job log items with paging.
`DescribeJobsResult`	`describeJobs(DescribeJobsRequest request)` Returns a list of Jobs.
`DescribeReplicationConfigurationTemplatesResult`	`describeReplicationConfigurationTemplates(DescribeReplicationConfigurationTemplatesRequest request)` Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
`DescribeSourceServersResult`	`describeSourceServers(DescribeSourceServersRequest request)` Retrieves all SourceServers or multiple SourceServers by ID.
`DescribeVcenterClientsResult`	`describeVcenterClients(DescribeVcenterClientsRequest request)` Returns a list of the installed vCenter clients.
`DisconnectFromServiceResult`	`disconnectFromService(DisconnectFromServiceRequest request)` Disconnects specific Source Servers from Application Migration Service.
`FinalizeCutoverResult`	`finalizeCutover(FinalizeCutoverRequest request)` Finalizes the cutover immediately for specific Source Servers.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetLaunchConfigurationResult`	`getLaunchConfiguration(GetLaunchConfigurationRequest request)` Lists all LaunchConfigurations available, filtered by Source Server IDs.
`GetReplicationConfigurationResult`	`getReplicationConfiguration(GetReplicationConfigurationRequest request)` Lists all ReplicationConfigurations, filtered by Source Server ID.
`InitializeServiceResult`	`initializeService(InitializeServiceRequest request)` Initialize Application Migration Service.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List all tags for your Application Migration Service resources.
`MarkAsArchivedResult`	`markAsArchived(MarkAsArchivedRequest request)` Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID.
`RetryDataReplicationResult`	`retryDataReplication(RetryDataReplicationRequest request)` Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartCutoverResult`	`startCutover(StartCutoverRequest request)` Launches a Cutover Instance for specific Source Servers.
`StartReplicationResult`	`startReplication(StartReplicationRequest request)` Starts replication for SNAPSHOT_SHIPPING agents.
`StartTestResult`	`startTest(StartTestRequest request)` Launches a Test Instance for specific Source Servers.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources.
`TerminateTargetInstancesResult`	`terminateTargetInstances(TerminateTargetInstancesRequest request)` Starts a job that terminates specific launched EC2 Test and Cutover instances.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Deletes the specified set of tags from the specified set of Application Migration Service resources.
`UpdateLaunchConfigurationResult`	`updateLaunchConfiguration(UpdateLaunchConfigurationRequest request)` Updates multiple LaunchConfigurations by Source Server ID.
`UpdateReplicationConfigurationResult`	`updateReplicationConfiguration(UpdateReplicationConfigurationRequest request)` Allows you to update multiple ReplicationConfigurations by Source Server ID.
`UpdateReplicationConfigurationTemplateResult`	`updateReplicationConfigurationTemplate(UpdateReplicationConfigurationTemplateRequest request)` Updates multiple ReplicationConfigurationTemplates by ID.
`UpdateSourceServerReplicationTypeResult`	`updateSourceServerReplicationType(UpdateSourceServerReplicationTypeRequest request)` Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - changeServerLifeCycleState
```
public ChangeServerLifeCycleStateResult changeServerLifeCycleState(ChangeServerLifeCycleStateRequest request)
```
    Description copied from interface: AWSmgn
    
    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.)
    
    Specified by:
    
    changeServerLifeCycleState in interface AWSmgn
    
    Returns:
    
    Result of the ChangeServerLifeCycleState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createReplicationConfigurationTemplate
```
public CreateReplicationConfigurationTemplateResult createReplicationConfigurationTemplate(CreateReplicationConfigurationTemplateRequest request)
```
    Description copied from interface: AWSmgn
    
    Creates a new ReplicationConfigurationTemplate.
    
    Specified by:
    
    createReplicationConfigurationTemplate in interface AWSmgn
    
    Returns:
    
    Result of the CreateReplicationConfigurationTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteJob
```
public DeleteJobResult deleteJob(DeleteJobRequest request)
```
    Description copied from interface: AWSmgn
    
    Deletes a single Job by ID.
    
    Specified by:
    
    deleteJob in interface AWSmgn
    
    Returns:
    
    Result of the DeleteJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationConfigurationTemplate
```
public DeleteReplicationConfigurationTemplateResult deleteReplicationConfigurationTemplate(DeleteReplicationConfigurationTemplateRequest request)
```
    Description copied from interface: AWSmgn
    
    Deletes a single Replication Configuration Template by ID
    
    Specified by:
    
    deleteReplicationConfigurationTemplate in interface AWSmgn
    
    Returns:
    
    Result of the DeleteReplicationConfigurationTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteSourceServer
```
public DeleteSourceServerResult deleteSourceServer(DeleteSourceServerRequest request)
```
    Description copied from interface: AWSmgn
    
    Deletes a single source server by ID.
    
    Specified by:
    
    deleteSourceServer in interface AWSmgn
    
    Returns:
    
    Result of the DeleteSourceServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteVcenterClient
```
public DeleteVcenterClientResult deleteVcenterClient(DeleteVcenterClientRequest request)
```
    Description copied from interface: AWSmgn
    
    Deletes a given vCenter client by ID.
    
    Specified by:
    
    deleteVcenterClient in interface AWSmgn
    
    Returns:
    
    Result of the DeleteVcenterClient operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeJobLogItems
```
public DescribeJobLogItemsResult describeJobLogItems(DescribeJobLogItemsRequest request)
```
    Description copied from interface: AWSmgn
    
    Retrieves detailed job log items with paging.
    
    Specified by:
    
    describeJobLogItems in interface AWSmgn
    
    Returns:
    
    Result of the DescribeJobLogItems operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeJobs
```
public DescribeJobsResult describeJobs(DescribeJobsRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    describeJobs in interface AWSmgn
    
    Returns:
    
    Result of the DescribeJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplicationConfigurationTemplates
```
public DescribeReplicationConfigurationTemplatesResult describeReplicationConfigurationTemplates(DescribeReplicationConfigurationTemplatesRequest request)
```
    Description copied from interface: AWSmgn
    
    Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
    
    Specified by:
    
    describeReplicationConfigurationTemplates in interface AWSmgn
    
    Returns:
    
    Result of the DescribeReplicationConfigurationTemplates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSourceServers
```
public DescribeSourceServersResult describeSourceServers(DescribeSourceServersRequest request)
```
    Description copied from interface: AWSmgn
    
    Retrieves all SourceServers or multiple SourceServers by ID.
    
    Specified by:
    
    describeSourceServers in interface AWSmgn
    
    Returns:
    
    Result of the DescribeSourceServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeVcenterClients
```
public DescribeVcenterClientsResult describeVcenterClients(DescribeVcenterClientsRequest request)
```
    Description copied from interface: AWSmgn
    
    Returns a list of the installed vCenter clients.
    
    Specified by:
    
    describeVcenterClients in interface AWSmgn
    
    Returns:
    
    Result of the DescribeVcenterClients operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disconnectFromService
```
public DisconnectFromServiceResult disconnectFromService(DisconnectFromServiceRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    disconnectFromService in interface AWSmgn
    
    Returns:
    
    Result of the DisconnectFromService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - finalizeCutover
```
public FinalizeCutoverResult finalizeCutover(FinalizeCutoverRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    finalizeCutover in interface AWSmgn
    
    Returns:
    
    Result of the FinalizeCutover operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLaunchConfiguration
```
public GetLaunchConfigurationResult getLaunchConfiguration(GetLaunchConfigurationRequest request)
```
    Description copied from interface: AWSmgn
    
    Lists all LaunchConfigurations available, filtered by Source Server IDs.
    
    Specified by:
    
    getLaunchConfiguration in interface AWSmgn
    
    Returns:
    
    Result of the GetLaunchConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getReplicationConfiguration
```
public GetReplicationConfigurationResult getReplicationConfiguration(GetReplicationConfigurationRequest request)
```
    Description copied from interface: AWSmgn
    
    Lists all ReplicationConfigurations, filtered by Source Server ID.
    
    Specified by:
    
    getReplicationConfiguration in interface AWSmgn
    
    Returns:
    
    Result of the GetReplicationConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - initializeService
```
public InitializeServiceResult initializeService(InitializeServiceRequest request)
```
    Description copied from interface: AWSmgn
    
    Initialize Application Migration Service.
    
    Specified by:
    
    initializeService in interface AWSmgn
    
    Returns:
    
    Result of the InitializeService operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSmgn
    
    List all tags for your Application Migration Service resources.
    
    Specified by:
    
    listTagsForResource in interface AWSmgn
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - markAsArchived
```
public MarkAsArchivedResult markAsArchived(MarkAsArchivedRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    markAsArchived in interface AWSmgn
    
    Returns:
    
    Result of the MarkAsArchived operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - retryDataReplication
```
public RetryDataReplicationResult retryDataReplication(RetryDataReplicationRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    retryDataReplication in interface AWSmgn
    
    Returns:
    
    Result of the RetryDataReplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startCutover
```
public StartCutoverResult startCutover(StartCutoverRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    startCutover in interface AWSmgn
    
    Returns:
    
    Result of the StartCutover operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startReplication
```
public StartReplicationResult startReplication(StartReplicationRequest request)
```
    Description copied from interface: AWSmgn
    
    Starts replication for SNAPSHOT_SHIPPING agents.
    
    Specified by:
    
    startReplication in interface AWSmgn
    
    Returns:
    
    Result of the StartReplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTest
```
public StartTestResult startTest(StartTestRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    startTest in interface AWSmgn
    
    Returns:
    
    Result of the StartTest operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    tagResource in interface AWSmgn
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - terminateTargetInstances
```
public TerminateTargetInstancesResult terminateTargetInstances(TerminateTargetInstancesRequest request)
```
    Description copied from interface: AWSmgn
    
    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.
    
    Specified by:
    
    terminateTargetInstances in interface AWSmgn
    
    Returns:
    
    Result of the TerminateTargetInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSmgn
    
    Deletes the specified set of tags from the specified set of Application Migration Service resources.
    
    Specified by:
    
    untagResource in interface AWSmgn
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLaunchConfiguration
```
public UpdateLaunchConfigurationResult updateLaunchConfiguration(UpdateLaunchConfigurationRequest request)
```
    Description copied from interface: AWSmgn
    
    Updates multiple LaunchConfigurations by Source Server ID.
    
    Specified by:
    
    updateLaunchConfiguration in interface AWSmgn
    
    Returns:
    
    Result of the UpdateLaunchConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateReplicationConfiguration
```
public UpdateReplicationConfigurationResult updateReplicationConfiguration(UpdateReplicationConfigurationRequest request)
```
    Description copied from interface: AWSmgn
    
    Allows you to update multiple ReplicationConfigurations by Source Server ID.
    
    Specified by:
    
    updateReplicationConfiguration in interface AWSmgn
    
    Returns:
    
    Result of the UpdateReplicationConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateReplicationConfigurationTemplate
```
public UpdateReplicationConfigurationTemplateResult updateReplicationConfigurationTemplate(UpdateReplicationConfigurationTemplateRequest request)
```
    Description copied from interface: AWSmgn
    
    Updates multiple ReplicationConfigurationTemplates by ID.
    
    Specified by:
    
    updateReplicationConfigurationTemplate in interface AWSmgn
    
    Returns:
    
    Result of the UpdateReplicationConfigurationTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSourceServerReplicationType
```
public UpdateSourceServerReplicationTypeResult updateSourceServerReplicationType(UpdateSourceServerReplicationTypeRequest request)
```
    Description copied from interface: AWSmgn
    
    Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
    
    Specified by:
    
    updateSourceServerReplicationType in interface AWSmgn
    
    Returns:
    
    Result of the UpdateSourceServerReplicationType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSmgn
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSmgn
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSmgn
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSmgn
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSmgn

Field Summary

Fields inherited from interface com.amazonaws.services.mgn.AWSmgn

Method Summary

Methods inherited from class java.lang.Object

Method Detail

changeServerLifeCycleState

createReplicationConfigurationTemplate

deleteJob

deleteReplicationConfigurationTemplate

deleteSourceServer

deleteVcenterClient

describeJobLogItems

describeJobs

describeReplicationConfigurationTemplates

describeSourceServers

describeVcenterClients

disconnectFromService

finalizeCutover

getLaunchConfiguration

getReplicationConfiguration

initializeService

listTagsForResource

markAsArchived

retryDataReplication

startCutover

startReplication

startTest

tagResource

terminateTargetInstances

untagResource

updateLaunchConfiguration

updateReplicationConfiguration

updateReplicationConfigurationTemplate

updateSourceServerReplicationType

shutdown

getCachedResponseMetadata