@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSmgn
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSmgn
instead.
The Application Migration Service service.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
ChangeServerLifeCycleStateResult |
changeServerLifeCycleState(ChangeServerLifeCycleStateRequest changeServerLifeCycleStateRequest)
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.
|
CreateLaunchConfigurationTemplateResult |
createLaunchConfigurationTemplate(CreateLaunchConfigurationTemplateRequest createLaunchConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
|
CreateReplicationConfigurationTemplateResult |
createReplicationConfigurationTemplate(CreateReplicationConfigurationTemplateRequest createReplicationConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
|
DeleteJobResult |
deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a single Job by ID.
|
DeleteLaunchConfigurationTemplateResult |
deleteLaunchConfigurationTemplate(DeleteLaunchConfigurationTemplateRequest deleteLaunchConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
|
DeleteReplicationConfigurationTemplateResult |
deleteReplicationConfigurationTemplate(DeleteReplicationConfigurationTemplateRequest deleteReplicationConfigurationTemplateRequest)
Deletes a single Replication Configuration Template by ID
|
DeleteSourceServerResult |
deleteSourceServer(DeleteSourceServerRequest deleteSourceServerRequest)
Deletes a single source server by ID.
|
DeleteVcenterClientResult |
deleteVcenterClient(DeleteVcenterClientRequest deleteVcenterClientRequest)
Deletes a given vCenter client by ID.
|
DescribeJobLogItemsResult |
describeJobLogItems(DescribeJobLogItemsRequest describeJobLogItemsRequest)
Retrieves detailed job log items with paging.
|
DescribeJobsResult |
describeJobs(DescribeJobsRequest describeJobsRequest)
Returns a list of Jobs.
|
DescribeLaunchConfigurationTemplatesResult |
describeLaunchConfigurationTemplates(DescribeLaunchConfigurationTemplatesRequest describeLaunchConfigurationTemplatesRequest)
Creates a new ReplicationConfigurationTemplate.
|
DescribeReplicationConfigurationTemplatesResult |
describeReplicationConfigurationTemplates(DescribeReplicationConfigurationTemplatesRequest describeReplicationConfigurationTemplatesRequest)
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
|
DescribeSourceServersResult |
describeSourceServers(DescribeSourceServersRequest describeSourceServersRequest)
Retrieves all SourceServers or multiple SourceServers by ID.
|
DescribeVcenterClientsResult |
describeVcenterClients(DescribeVcenterClientsRequest describeVcenterClientsRequest)
Returns a list of the installed vCenter clients.
|
DisconnectFromServiceResult |
disconnectFromService(DisconnectFromServiceRequest disconnectFromServiceRequest)
Disconnects specific Source Servers from Application Migration Service.
|
FinalizeCutoverResult |
finalizeCutover(FinalizeCutoverRequest finalizeCutoverRequest)
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 getLaunchConfigurationRequest)
Lists all LaunchConfigurations available, filtered by Source Server IDs.
|
GetReplicationConfigurationResult |
getReplicationConfiguration(GetReplicationConfigurationRequest getReplicationConfigurationRequest)
Lists all ReplicationConfigurations, filtered by Source Server ID.
|
InitializeServiceResult |
initializeService(InitializeServiceRequest initializeServiceRequest)
Initialize Application Migration Service.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags for your Application Migration Service resources.
|
MarkAsArchivedResult |
markAsArchived(MarkAsArchivedRequest markAsArchivedRequest)
Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified
SourceServers by ID.
|
RetryDataReplicationResult |
retryDataReplication(RetryDataReplicationRequest retryDataReplicationRequest)
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 startCutoverRequest)
Launches a Cutover Instance for specific Source Servers.
|
StartReplicationResult |
startReplication(StartReplicationRequest startReplicationRequest)
Starts replication for SNAPSHOT_SHIPPING agents.
|
StartTestResult |
startTest(StartTestRequest startTestRequest)
Launches a Test Instance for specific Source Servers.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources.
|
TerminateTargetInstancesResult |
terminateTargetInstances(TerminateTargetInstancesRequest terminateTargetInstancesRequest)
Starts a job that terminates specific launched EC2 Test and Cutover instances.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified set of tags from the specified set of Application Migration Service resources.
|
UpdateLaunchConfigurationResult |
updateLaunchConfiguration(UpdateLaunchConfigurationRequest updateLaunchConfigurationRequest)
Updates multiple LaunchConfigurations by Source Server ID.
|
UpdateLaunchConfigurationTemplateResult |
updateLaunchConfigurationTemplate(UpdateLaunchConfigurationTemplateRequest updateLaunchConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
|
UpdateReplicationConfigurationResult |
updateReplicationConfiguration(UpdateReplicationConfigurationRequest updateReplicationConfigurationRequest)
Allows you to update multiple ReplicationConfigurations by Source Server ID.
|
UpdateReplicationConfigurationTemplateResult |
updateReplicationConfigurationTemplate(UpdateReplicationConfigurationTemplateRequest updateReplicationConfigurationTemplateRequest)
Updates multiple ReplicationConfigurationTemplates by ID.
|
UpdateSourceServerReplicationTypeResult |
updateSourceServerReplicationType(UpdateSourceServerReplicationTypeRequest updateSourceServerReplicationTypeRequest)
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
|
static final String ENDPOINT_PREFIX
ChangeServerLifeCycleStateResult changeServerLifeCycleState(ChangeServerLifeCycleStateRequest changeServerLifeCycleStateRequest)
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.)
changeServerLifeCycleStateRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.CreateLaunchConfigurationTemplateResult createLaunchConfigurationTemplate(CreateLaunchConfigurationTemplateRequest createLaunchConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
createLaunchConfigurationTemplateRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.CreateReplicationConfigurationTemplateResult createReplicationConfigurationTemplate(CreateReplicationConfigurationTemplateRequest createReplicationConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
createReplicationConfigurationTemplateRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a single Job by ID.
deleteJobRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.DeleteLaunchConfigurationTemplateResult deleteLaunchConfigurationTemplate(DeleteLaunchConfigurationTemplateRequest deleteLaunchConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
deleteLaunchConfigurationTemplateRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.DeleteReplicationConfigurationTemplateResult deleteReplicationConfigurationTemplate(DeleteReplicationConfigurationTemplateRequest deleteReplicationConfigurationTemplateRequest)
Deletes a single Replication Configuration Template by ID
deleteReplicationConfigurationTemplateRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.DeleteSourceServerResult deleteSourceServer(DeleteSourceServerRequest deleteSourceServerRequest)
Deletes a single source server by ID.
deleteSourceServerRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.DeleteVcenterClientResult deleteVcenterClient(DeleteVcenterClientRequest deleteVcenterClientRequest)
Deletes a given vCenter client by ID.
deleteVcenterClientRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.DescribeJobLogItemsResult describeJobLogItems(DescribeJobLogItemsRequest describeJobLogItemsRequest)
Retrieves detailed job log items with paging.
describeJobLogItemsRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.DescribeJobsResult describeJobs(DescribeJobsRequest describeJobsRequest)
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.
describeJobsRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.DescribeLaunchConfigurationTemplatesResult describeLaunchConfigurationTemplates(DescribeLaunchConfigurationTemplatesRequest describeLaunchConfigurationTemplatesRequest)
Creates a new ReplicationConfigurationTemplate.
describeLaunchConfigurationTemplatesRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.DescribeReplicationConfigurationTemplatesResult describeReplicationConfigurationTemplates(DescribeReplicationConfigurationTemplatesRequest describeReplicationConfigurationTemplatesRequest)
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
describeReplicationConfigurationTemplatesRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.DescribeSourceServersResult describeSourceServers(DescribeSourceServersRequest describeSourceServersRequest)
Retrieves all SourceServers or multiple SourceServers by ID.
describeSourceServersRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.DescribeVcenterClientsResult describeVcenterClients(DescribeVcenterClientsRequest describeVcenterClientsRequest)
Returns a list of the installed vCenter clients.
describeVcenterClientsRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.DisconnectFromServiceResult disconnectFromService(DisconnectFromServiceRequest disconnectFromServiceRequest)
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.
disconnectFromServiceRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.FinalizeCutoverResult finalizeCutover(FinalizeCutoverRequest finalizeCutoverRequest)
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.
finalizeCutoverRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.GetLaunchConfigurationResult getLaunchConfiguration(GetLaunchConfigurationRequest getLaunchConfigurationRequest)
Lists all LaunchConfigurations available, filtered by Source Server IDs.
getLaunchConfigurationRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.GetReplicationConfigurationResult getReplicationConfiguration(GetReplicationConfigurationRequest getReplicationConfigurationRequest)
Lists all ReplicationConfigurations, filtered by Source Server ID.
getReplicationConfigurationRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.InitializeServiceResult initializeService(InitializeServiceRequest initializeServiceRequest)
Initialize Application Migration Service.
initializeServiceRequest
- ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags for your Application Migration Service resources.
listTagsForResourceRequest
- ResourceNotFoundException
- Resource not found exception.ThrottlingException
- Reached throttling quota exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.InternalServerException
- The server encountered an unexpected condition that prevented it from fulfilling the request.MarkAsArchivedResult markAsArchived(MarkAsArchivedRequest markAsArchivedRequest)
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.
markAsArchivedRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.RetryDataReplicationResult retryDataReplication(RetryDataReplicationRequest retryDataReplicationRequest)
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.
retryDataReplicationRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.StartCutoverResult startCutover(StartCutoverRequest startCutoverRequest)
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.
startCutoverRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.StartReplicationResult startReplication(StartReplicationRequest startReplicationRequest)
Starts replication for SNAPSHOT_SHIPPING agents.
startReplicationRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.ServiceQuotaExceededException
- The request could not be completed because its exceeded the service quota.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.StartTestResult startTest(StartTestRequest startTestRequest)
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.
startTestRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- ResourceNotFoundException
- Resource not found exception.ThrottlingException
- Reached throttling quota exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.InternalServerException
- The server encountered an unexpected condition that prevented it from fulfilling the request.TerminateTargetInstancesResult terminateTargetInstances(TerminateTargetInstancesRequest terminateTargetInstancesRequest)
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.
terminateTargetInstancesRequest
- UninitializedAccountException
- Uninitialized account exception.ValidationException
- Validate exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified set of tags from the specified set of Application Migration Service resources.
untagResourceRequest
- ResourceNotFoundException
- Resource not found exception.ThrottlingException
- Reached throttling quota exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.InternalServerException
- The server encountered an unexpected condition that prevented it from fulfilling the request.UpdateLaunchConfigurationResult updateLaunchConfiguration(UpdateLaunchConfigurationRequest updateLaunchConfigurationRequest)
Updates multiple LaunchConfigurations by Source Server ID.
updateLaunchConfigurationRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.UpdateLaunchConfigurationTemplateResult updateLaunchConfigurationTemplate(UpdateLaunchConfigurationTemplateRequest updateLaunchConfigurationTemplateRequest)
Creates a new ReplicationConfigurationTemplate.
updateLaunchConfigurationTemplateRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.UpdateReplicationConfigurationResult updateReplicationConfiguration(UpdateReplicationConfigurationRequest updateReplicationConfigurationRequest)
Allows you to update multiple ReplicationConfigurations by Source Server ID.
updateReplicationConfigurationRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.UpdateReplicationConfigurationTemplateResult updateReplicationConfigurationTemplate(UpdateReplicationConfigurationTemplateRequest updateReplicationConfigurationTemplateRequest)
Updates multiple ReplicationConfigurationTemplates by ID.
updateReplicationConfigurationTemplateRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.UpdateSourceServerReplicationTypeResult updateSourceServerReplicationType(UpdateSourceServerReplicationTypeRequest updateSourceServerReplicationTypeRequest)
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
updateSourceServerReplicationTypeRequest
- UninitializedAccountException
- Uninitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.ConflictException
- The request could not be completed due to a conflict with the current state of the target resource.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.