@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSmgnClient extends AmazonWebServiceClient implements AWSmgn
The Application Migration Service service.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSmgnClientBuilder |
builder() |
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 single vCenter client by ID.
|
DescribeJobLogItemsResult |
describeJobLogItems(DescribeJobLogItemsRequest request)
Retrieves detailed Job log 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)
Lists all 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 on source server by ID.
|
StartTestResult |
startTest(StartTestRequest request)
Lauches 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)
Updates source server Replication Type by ID.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSmgnClientBuilder builder()
public 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. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)
changeServerLifeCycleState
in interface AWSmgn
changeServerLifeCycleStateRequest
- 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.public CreateReplicationConfigurationTemplateResult createReplicationConfigurationTemplate(CreateReplicationConfigurationTemplateRequest request)
Creates a new ReplicationConfigurationTemplate.
createReplicationConfigurationTemplate
in interface AWSmgn
createReplicationConfigurationTemplateRequest
- UninitializedAccountException
- Unitialized account exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.public DeleteJobResult deleteJob(DeleteJobRequest request)
Deletes a single Job by ID.
deleteJob
in interface AWSmgn
deleteJobRequest
- 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.public DeleteReplicationConfigurationTemplateResult deleteReplicationConfigurationTemplate(DeleteReplicationConfigurationTemplateRequest request)
Deletes a single Replication Configuration Template by ID
deleteReplicationConfigurationTemplate
in interface AWSmgn
deleteReplicationConfigurationTemplateRequest
- 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.public DeleteSourceServerResult deleteSourceServer(DeleteSourceServerRequest request)
Deletes a single source server by ID.
deleteSourceServer
in interface AWSmgn
deleteSourceServerRequest
- 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.public DeleteVcenterClientResult deleteVcenterClient(DeleteVcenterClientRequest request)
Deletes a single vCenter client by ID.
deleteVcenterClient
in interface AWSmgn
deleteVcenterClientRequest
- UninitializedAccountException
- Unitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.public DescribeJobLogItemsResult describeJobLogItems(DescribeJobLogItemsRequest request)
Retrieves detailed Job log with paging.
describeJobLogItems
in interface AWSmgn
describeJobLogItemsRequest
- UninitializedAccountException
- Unitialized account exception.ValidationException
- Validate exception.public DescribeJobsResult describeJobs(DescribeJobsRequest request)
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.
describeJobs
in interface AWSmgn
describeJobsRequest
- UninitializedAccountException
- Unitialized account exception.ValidationException
- Validate exception.public DescribeReplicationConfigurationTemplatesResult describeReplicationConfigurationTemplates(DescribeReplicationConfigurationTemplatesRequest request)
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
describeReplicationConfigurationTemplates
in interface AWSmgn
describeReplicationConfigurationTemplatesRequest
- UninitializedAccountException
- Unitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.public DescribeSourceServersResult describeSourceServers(DescribeSourceServersRequest request)
Retrieves all SourceServers or multiple SourceServers by ID.
describeSourceServers
in interface AWSmgn
describeSourceServersRequest
- UninitializedAccountException
- Unitialized account exception.ValidationException
- Validate exception.public DescribeVcenterClientsResult describeVcenterClients(DescribeVcenterClientsRequest request)
Lists all vCenter clients.
describeVcenterClients
in interface AWSmgn
describeVcenterClientsRequest
- UninitializedAccountException
- Unitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.public DisconnectFromServiceResult disconnectFromService(DisconnectFromServiceRequest request)
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.
disconnectFromService
in interface AWSmgn
disconnectFromServiceRequest
- 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.public FinalizeCutoverResult finalizeCutover(FinalizeCutoverRequest request)
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.
finalizeCutover
in interface AWSmgn
finalizeCutoverRequest
- 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.public GetLaunchConfigurationResult getLaunchConfiguration(GetLaunchConfigurationRequest request)
Lists all LaunchConfigurations available, filtered by Source Server IDs.
getLaunchConfiguration
in interface AWSmgn
getLaunchConfigurationRequest
- UninitializedAccountException
- Unitialized account exception.ResourceNotFoundException
- Resource not found exception.public GetReplicationConfigurationResult getReplicationConfiguration(GetReplicationConfigurationRequest request)
Lists all ReplicationConfigurations, filtered by Source Server ID.
getReplicationConfiguration
in interface AWSmgn
getReplicationConfigurationRequest
- UninitializedAccountException
- Unitialized account exception.ResourceNotFoundException
- Resource not found exception.public InitializeServiceResult initializeService(InitializeServiceRequest request)
Initialize Application Migration Service.
initializeService
in interface AWSmgn
initializeServiceRequest
- ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List all tags for your Application Migration Service resources.
listTagsForResource
in interface AWSmgn
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.public MarkAsArchivedResult markAsArchived(MarkAsArchivedRequest request)
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.
markAsArchived
in interface AWSmgn
markAsArchivedRequest
- 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.public 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. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.
retryDataReplication
in interface AWSmgn
retryDataReplicationRequest
- UninitializedAccountException
- Unitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.public StartCutoverResult startCutover(StartCutoverRequest request)
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.
startCutover
in interface AWSmgn
startCutoverRequest
- 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.public StartReplicationResult startReplication(StartReplicationRequest request)
Starts replication on source server by ID.
startReplication
in interface AWSmgn
startReplicationRequest
- UninitializedAccountException
- Unitialized 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.public StartTestResult startTest(StartTestRequest request)
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.
startTest
in interface AWSmgn
startTestRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AWSmgn
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.public TerminateTargetInstancesResult terminateTargetInstances(TerminateTargetInstancesRequest request)
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.
terminateTargetInstances
in interface AWSmgn
terminateTargetInstancesRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes the specified set of tags from the specified set of Application Migration Service resources.
untagResource
in interface AWSmgn
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.public UpdateLaunchConfigurationResult updateLaunchConfiguration(UpdateLaunchConfigurationRequest request)
Updates multiple LaunchConfigurations by Source Server ID.
updateLaunchConfiguration
in interface AWSmgn
updateLaunchConfigurationRequest
- 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.public UpdateReplicationConfigurationResult updateReplicationConfiguration(UpdateReplicationConfigurationRequest request)
Allows you to update multiple ReplicationConfigurations by Source Server ID.
updateReplicationConfiguration
in interface AWSmgn
updateReplicationConfigurationRequest
- 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.public UpdateReplicationConfigurationTemplateResult updateReplicationConfigurationTemplate(UpdateReplicationConfigurationTemplateRequest request)
Updates multiple ReplicationConfigurationTemplates by ID.
updateReplicationConfigurationTemplate
in interface AWSmgn
updateReplicationConfigurationTemplateRequest
- UninitializedAccountException
- Unitialized account exception.ResourceNotFoundException
- Resource not found exception.ValidationException
- Validate exception.AccessDeniedException
- Operating denied due to a file permission or access check error.public UpdateSourceServerReplicationTypeResult updateSourceServerReplicationType(UpdateSourceServerReplicationTypeRequest request)
Updates source server Replication Type by ID.
updateSourceServerReplicationType
in interface AWSmgn
updateSourceServerReplicationTypeRequest
- 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.public 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 the request.
getCachedResponseMetadata
in interface AWSmgn
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSmgn
shutdown
in class AmazonWebServiceClient