com.amazonaws.services.mgn.AWSmgn Maven / Gradle / Ivy
Show all versions of aws-java-sdk-mgn Show documentation
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mgn;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.mgn.model.*;
/**
* Interface for accessing mgn.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.mgn.AbstractAWSmgn} instead.
*
*
*
* The Application Migration Service service.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSmgn {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "mgn";
/**
*
* 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.)
*
*
* @param changeServerLifeCycleStateRequest
* @return Result of the ChangeServerLifeCycleState operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ValidationException
* Validate exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.ChangeServerLifeCycleState
* @see AWS
* API Documentation
*/
ChangeServerLifeCycleStateResult changeServerLifeCycleState(ChangeServerLifeCycleStateRequest changeServerLifeCycleStateRequest);
/**
*
* Creates a new ReplicationConfigurationTemplate.
*
*
* @param createReplicationConfigurationTemplateRequest
* @return Result of the CreateReplicationConfigurationTemplate operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ValidationException
* Validate exception.
* @sample AWSmgn.CreateReplicationConfigurationTemplate
* @see AWS API Documentation
*/
CreateReplicationConfigurationTemplateResult createReplicationConfigurationTemplate(
CreateReplicationConfigurationTemplateRequest createReplicationConfigurationTemplateRequest);
/**
*
* Deletes a single Job by ID.
*
*
* @param deleteJobRequest
* @return Result of the DeleteJob operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.DeleteJob
* @see AWS API
* Documentation
*/
DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest);
/**
*
* Deletes a single Replication Configuration Template by ID
*
*
* @param deleteReplicationConfigurationTemplateRequest
* @return Result of the DeleteReplicationConfigurationTemplate operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.DeleteReplicationConfigurationTemplate
* @see AWS API Documentation
*/
DeleteReplicationConfigurationTemplateResult deleteReplicationConfigurationTemplate(
DeleteReplicationConfigurationTemplateRequest deleteReplicationConfigurationTemplateRequest);
/**
*
* Deletes a single source server by ID.
*
*
* @param deleteSourceServerRequest
* @return Result of the DeleteSourceServer operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.DeleteSourceServer
* @see AWS API
* Documentation
*/
DeleteSourceServerResult deleteSourceServer(DeleteSourceServerRequest deleteSourceServerRequest);
/**
*
* Retrieves detailed Job log with paging.
*
*
* @param describeJobLogItemsRequest
* @return Result of the DescribeJobLogItems operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ValidationException
* Validate exception.
* @sample AWSmgn.DescribeJobLogItems
* @see AWS API
* Documentation
*/
DescribeJobLogItemsResult describeJobLogItems(DescribeJobLogItemsRequest describeJobLogItemsRequest);
/**
*
* 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.
*
*
* @param describeJobsRequest
* @return Result of the DescribeJobs operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ValidationException
* Validate exception.
* @sample AWSmgn.DescribeJobs
* @see AWS API
* Documentation
*/
DescribeJobsResult describeJobs(DescribeJobsRequest describeJobsRequest);
/**
*
* Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
*
*
* @param describeReplicationConfigurationTemplatesRequest
* @return Result of the DescribeReplicationConfigurationTemplates operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ValidationException
* Validate exception.
* @sample AWSmgn.DescribeReplicationConfigurationTemplates
* @see AWS API Documentation
*/
DescribeReplicationConfigurationTemplatesResult describeReplicationConfigurationTemplates(
DescribeReplicationConfigurationTemplatesRequest describeReplicationConfigurationTemplatesRequest);
/**
*
* Retrieves all SourceServers or multiple SourceServers by ID.
*
*
* @param describeSourceServersRequest
* @return Result of the DescribeSourceServers operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ValidationException
* Validate exception.
* @sample AWSmgn.DescribeSourceServers
* @see AWS API
* Documentation
*/
DescribeSourceServersResult describeSourceServers(DescribeSourceServersRequest describeSourceServersRequest);
/**
*
* 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.
*
*
* @param disconnectFromServiceRequest
* @return Result of the DisconnectFromService operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.DisconnectFromService
* @see AWS API
* Documentation
*/
DisconnectFromServiceResult disconnectFromService(DisconnectFromServiceRequest disconnectFromServiceRequest);
/**
*
* 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.
*
*
* @param finalizeCutoverRequest
* @return Result of the FinalizeCutover operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ValidationException
* Validate exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.FinalizeCutover
* @see AWS API
* Documentation
*/
FinalizeCutoverResult finalizeCutover(FinalizeCutoverRequest finalizeCutoverRequest);
/**
*
* Lists all LaunchConfigurations available, filtered by Source Server IDs.
*
*
* @param getLaunchConfigurationRequest
* @return Result of the GetLaunchConfiguration operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @sample AWSmgn.GetLaunchConfiguration
* @see AWS API
* Documentation
*/
GetLaunchConfigurationResult getLaunchConfiguration(GetLaunchConfigurationRequest getLaunchConfigurationRequest);
/**
*
* Lists all ReplicationConfigurations, filtered by Source Server ID.
*
*
* @param getReplicationConfigurationRequest
* @return Result of the GetReplicationConfiguration operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @sample AWSmgn.GetReplicationConfiguration
* @see AWS API Documentation
*/
GetReplicationConfigurationResult getReplicationConfiguration(GetReplicationConfigurationRequest getReplicationConfigurationRequest);
/**
*
* Initialize Application Migration Service.
*
*
* @param initializeServiceRequest
* @return Result of the InitializeService operation returned by the service.
* @throws ValidationException
* Validate exception.
* @throws AccessDeniedException
* Operating denied due to a file permission or access check error.
* @sample AWSmgn.InitializeService
* @see AWS API
* Documentation
*/
InitializeServiceResult initializeService(InitializeServiceRequest initializeServiceRequest);
/**
*
* List all tags for your Application Migration Service resources.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ThrottlingException
* Reached throttling quota exception.
* @throws ValidationException
* Validate exception.
* @throws AccessDeniedException
* Operating denied due to a file permission or access check error.
* @throws InternalServerException
* The server encountered an unexpected condition that prevented it from fulfilling the request.
* @sample AWSmgn.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
* @param markAsArchivedRequest
* @return Result of the MarkAsArchived operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.MarkAsArchived
* @see AWS API
* Documentation
*/
MarkAsArchivedResult markAsArchived(MarkAsArchivedRequest markAsArchivedRequest);
/**
*
* 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.
*
*
* @param retryDataReplicationRequest
* @return Result of the RetryDataReplication operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ValidationException
* Validate exception.
* @sample AWSmgn.RetryDataReplication
* @see AWS API
* Documentation
*/
RetryDataReplicationResult retryDataReplication(RetryDataReplicationRequest retryDataReplicationRequest);
/**
*
* 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.
*
*
* @param startCutoverRequest
* @return Result of the StartCutover operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ValidationException
* Validate exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.StartCutover
* @see AWS API
* Documentation
*/
StartCutoverResult startCutover(StartCutoverRequest startCutoverRequest);
/**
*
* 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.
*
*
* @param startTestRequest
* @return Result of the StartTest operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ValidationException
* Validate exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.StartTest
* @see AWS API
* Documentation
*/
StartTestResult startTest(StartTestRequest startTestRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ThrottlingException
* Reached throttling quota exception.
* @throws ValidationException
* Validate exception.
* @throws AccessDeniedException
* Operating denied due to a file permission or access check error.
* @throws InternalServerException
* The server encountered an unexpected condition that prevented it from fulfilling the request.
* @sample AWSmgn.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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.
*
*
* @param terminateTargetInstancesRequest
* @return Result of the TerminateTargetInstances operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ValidationException
* Validate exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.TerminateTargetInstances
* @see AWS
* API Documentation
*/
TerminateTargetInstancesResult terminateTargetInstances(TerminateTargetInstancesRequest terminateTargetInstancesRequest);
/**
*
* Deletes the specified set of tags from the specified set of Application Migration Service resources.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ThrottlingException
* Reached throttling quota exception.
* @throws ValidationException
* Validate exception.
* @throws AccessDeniedException
* Operating denied due to a file permission or access check error.
* @throws InternalServerException
* The server encountered an unexpected condition that prevented it from fulfilling the request.
* @sample AWSmgn.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates multiple LaunchConfigurations by Source Server ID.
*
*
* @param updateLaunchConfigurationRequest
* @return Result of the UpdateLaunchConfiguration operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ValidationException
* Validate exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.UpdateLaunchConfiguration
* @see AWS
* API Documentation
*/
UpdateLaunchConfigurationResult updateLaunchConfiguration(UpdateLaunchConfigurationRequest updateLaunchConfigurationRequest);
/**
*
* Allows you to update multiple ReplicationConfigurations by Source Server ID.
*
*
* @param updateReplicationConfigurationRequest
* @return Result of the UpdateReplicationConfiguration operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ValidationException
* Validate exception.
* @throws ConflictException
* The request could not be completed due to a conflict with the current state of the target resource.
* @sample AWSmgn.UpdateReplicationConfiguration
* @see AWS API Documentation
*/
UpdateReplicationConfigurationResult updateReplicationConfiguration(UpdateReplicationConfigurationRequest updateReplicationConfigurationRequest);
/**
*
* Updates multiple ReplicationConfigurationTemplates by ID.
*
*
* @param updateReplicationConfigurationTemplateRequest
* @return Result of the UpdateReplicationConfigurationTemplate operation returned by the service.
* @throws UninitializedAccountException
* Unitialized account exception.
* @throws ResourceNotFoundException
* Resource not found exception.
* @throws ValidationException
* Validate exception.
* @sample AWSmgn.UpdateReplicationConfigurationTemplate
* @see AWS API Documentation
*/
UpdateReplicationConfigurationTemplateResult updateReplicationConfigurationTemplate(
UpdateReplicationConfigurationTemplateRequest updateReplicationConfigurationTemplateRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}