com.amazonaws.services.mgn

Interface AWSmgn

All Known Subinterfaces:

AWSmgnAsync

All Known Implementing Classes:

AbstractAWSmgn, AbstractAWSmgnAsync, AWSmgnAsyncClient, AWSmgnClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSmgn

Interface for accessing mgn.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSmgn instead.

The Application Migration Service service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.
CreateReplicationConfigurationTemplateResult	createReplicationConfigurationTemplate(CreateReplicationConfigurationTemplateRequest createReplicationConfigurationTemplateRequest) Creates a new ReplicationConfigurationTemplate.
DeleteJobResult	deleteJob(DeleteJobRequest deleteJobRequest) Deletes a single Job by ID.
DeleteReplicationConfigurationTemplateResult	deleteReplicationConfigurationTemplate(DeleteReplicationConfigurationTemplateRequest deleteReplicationConfigurationTemplateRequest) Deletes a single Replication Configuration Template by ID
DeleteSourceServerResult	deleteSourceServer(DeleteSourceServerRequest deleteSourceServerRequest) Deletes a single source server by ID.
DescribeJobLogItemsResult	describeJobLogItems(DescribeJobLogItemsRequest describeJobLogItemsRequest) Retrieves detailed Job log with paging.
DescribeJobsResult	describeJobs(DescribeJobsRequest describeJobsRequest) Returns a list of Jobs.
DescribeReplicationConfigurationTemplatesResult	describeReplicationConfigurationTemplates(DescribeReplicationConfigurationTemplatesRequest describeReplicationConfigurationTemplatesRequest) Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
DescribeSourceServersResult	describeSourceServers(DescribeSourceServersRequest describeSourceServersRequest) Retrieves all SourceServers or multiple SourceServers by ID.
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.
StartTestResult	startTest(StartTestRequest startTestRequest) Lauches 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.
UpdateReplicationConfigurationResult	updateReplicationConfiguration(UpdateReplicationConfigurationRequest updateReplicationConfigurationRequest) Allows you to update multiple ReplicationConfigurations by Source Server ID.
UpdateReplicationConfigurationTemplateResult	updateReplicationConfigurationTemplate(UpdateReplicationConfigurationTemplateRequest updateReplicationConfigurationTemplateRequest) Updates multiple ReplicationConfigurationTemplates by ID.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

changeServerLifeCycleState

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

Parameters:

changeServerLifeCycleStateRequest -

Returns:

Result of the ChangeServerLifeCycleState operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

createReplicationConfigurationTemplate

CreateReplicationConfigurationTemplateResult createReplicationConfigurationTemplate(CreateReplicationConfigurationTemplateRequest createReplicationConfigurationTemplateRequest)

Creates a new ReplicationConfigurationTemplate.

Parameters:

createReplicationConfigurationTemplateRequest -

Returns:

Result of the CreateReplicationConfigurationTemplate operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ValidationException - Validate exception.

AccessDeniedException - Operating denied due to a file permission or access check error.

See Also:

AWS API Documentation

deleteJob

DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest)

Deletes a single Job by ID.

Parameters:

deleteJobRequest -

Returns:

Result of the DeleteJob operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

deleteReplicationConfigurationTemplate

DeleteReplicationConfigurationTemplateResult deleteReplicationConfigurationTemplate(DeleteReplicationConfigurationTemplateRequest deleteReplicationConfigurationTemplateRequest)

Deletes a single Replication Configuration Template by ID

Parameters:

deleteReplicationConfigurationTemplateRequest -

Returns:

Result of the DeleteReplicationConfigurationTemplate operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

deleteSourceServer

DeleteSourceServerResult deleteSourceServer(DeleteSourceServerRequest deleteSourceServerRequest)

Deletes a single source server by ID.

Parameters:

deleteSourceServerRequest -

Returns:

Result of the DeleteSourceServer operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

describeJobLogItems

DescribeJobLogItemsResult describeJobLogItems(DescribeJobLogItemsRequest describeJobLogItemsRequest)

Retrieves detailed Job log with paging.

Parameters:

describeJobLogItemsRequest -

Returns:

Result of the DescribeJobLogItems operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ValidationException - Validate exception.

See Also:

AWS API Documentation

describeJobs

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

Parameters:

describeJobsRequest -

Returns:

Result of the DescribeJobs operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ValidationException - Validate exception.

See Also:

AWS API Documentation

describeReplicationConfigurationTemplates

DescribeReplicationConfigurationTemplatesResult describeReplicationConfigurationTemplates(DescribeReplicationConfigurationTemplatesRequest describeReplicationConfigurationTemplatesRequest)

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Parameters:

describeReplicationConfigurationTemplatesRequest -

Returns:

Result of the DescribeReplicationConfigurationTemplates operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ResourceNotFoundException - Resource not found exception.

ValidationException - Validate exception.

See Also:

AWS API Documentation

describeSourceServers

DescribeSourceServersResult describeSourceServers(DescribeSourceServersRequest describeSourceServersRequest)

Retrieves all SourceServers or multiple SourceServers by ID.

Parameters:

describeSourceServersRequest -

Returns:

Result of the DescribeSourceServers operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ValidationException - Validate exception.

See Also:

AWS API Documentation

disconnectFromService

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

Parameters:

disconnectFromServiceRequest -

Returns:

Result of the DisconnectFromService operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

finalizeCutover

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

Parameters:

finalizeCutoverRequest -

Returns:

Result of the FinalizeCutover operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

getLaunchConfiguration

GetLaunchConfigurationResult getLaunchConfiguration(GetLaunchConfigurationRequest getLaunchConfigurationRequest)

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Parameters:

getLaunchConfigurationRequest -

Returns:

Result of the GetLaunchConfiguration operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ResourceNotFoundException - Resource not found exception.

See Also:

AWS API Documentation

getReplicationConfiguration

GetReplicationConfigurationResult getReplicationConfiguration(GetReplicationConfigurationRequest getReplicationConfigurationRequest)

Lists all ReplicationConfigurations, filtered by Source Server ID.

Parameters:

getReplicationConfigurationRequest -

Returns:

Result of the GetReplicationConfiguration operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ResourceNotFoundException - Resource not found exception.

See Also:

AWS API Documentation

initializeService

InitializeServiceResult initializeService(InitializeServiceRequest initializeServiceRequest)

Initialize Application Migration Service.

Parameters:

initializeServiceRequest -

Returns:

Result of the InitializeService operation returned by the service.

Throws:

ValidationException - Validate exception.

AccessDeniedException - Operating denied due to a file permission or access check error.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List all tags for your Application Migration Service resources.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

markAsArchived

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.

Parameters:

markAsArchivedRequest -

Returns:

Result of the MarkAsArchived operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

retryDataReplication

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.

Parameters:

retryDataReplicationRequest -

Returns:

Result of the RetryDataReplication operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ResourceNotFoundException - Resource not found exception.

ValidationException - Validate exception.

See Also:

AWS API Documentation

startCutover

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.

Parameters:

startCutoverRequest -

Returns:

Result of the StartCutover operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ValidationException - Validate exception.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

See Also:

AWS API Documentation

startTest

StartTestResult startTest(StartTestRequest startTestRequest)

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.

Parameters:

startTestRequest -

Returns:

Result of the StartTest operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ValidationException - Validate exception.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

See Also:

AWS API Documentation

tagResource

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

terminateTargetInstances

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.

Parameters:

terminateTargetInstancesRequest -

Returns:

Result of the TerminateTargetInstances operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ValidationException - Validate exception.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateLaunchConfiguration

UpdateLaunchConfigurationResult updateLaunchConfiguration(UpdateLaunchConfigurationRequest updateLaunchConfigurationRequest)

Updates multiple LaunchConfigurations by Source Server ID.

Parameters:

updateLaunchConfigurationRequest -

Returns:

Result of the UpdateLaunchConfiguration operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

updateReplicationConfiguration

UpdateReplicationConfigurationResult updateReplicationConfiguration(UpdateReplicationConfigurationRequest updateReplicationConfigurationRequest)

Allows you to update multiple ReplicationConfigurations by Source Server ID.

Parameters:

updateReplicationConfigurationRequest -

Returns:

Result of the UpdateReplicationConfiguration operation returned by the service.

Throws:

UninitializedAccountException - Unitialized 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.

See Also:

AWS API Documentation

updateReplicationConfigurationTemplate

UpdateReplicationConfigurationTemplateResult updateReplicationConfigurationTemplate(UpdateReplicationConfigurationTemplateRequest updateReplicationConfigurationTemplateRequest)

Updates multiple ReplicationConfigurationTemplates by ID.

Parameters:

updateReplicationConfigurationTemplateRequest -

Returns:

Result of the UpdateReplicationConfigurationTemplate operation returned by the service.

Throws:

UninitializedAccountException - Unitialized account exception.

ResourceNotFoundException - Resource not found exception.

ValidationException - Validate exception.

AccessDeniedException - Operating denied due to a file permission or access check error.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.