com.amazonaws.services.servermigration

Class AWSServerMigrationClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.servermigration.AWSServerMigrationClient

All Implemented Interfaces:

AWSServerMigration

Direct Known Subclasses:

AWSServerMigrationAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSServerMigrationClient
extends AmazonWebServiceClient
implements AWSServerMigration

Client for accessing SMS. All service calls made using this client are blocking, and will not return until the service call completes.

Product update

We recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift migrations. If Amazon Web Services MGN is unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March 2023.

Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following resources:

• Server Migration Service product page

• Server Migration Service User Guide

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.servermigration.AWSServerMigration

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSServerMigrationClient() Deprecated. use AWSServerMigrationClientBuilder.defaultClient()
AWSServerMigrationClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSServerMigrationClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSServerMigrationClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSServerMigrationClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSServerMigrationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSServerMigrationClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSServerMigrationClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSServerMigrationClientBuilder	builder()
CreateAppResult	createApp(CreateAppRequest request) Creates an application.
CreateReplicationJobResult	createReplicationJob(CreateReplicationJobRequest request) Creates a replication job.
DeleteAppResult	deleteApp(DeleteAppRequest request) Deletes the specified application.
DeleteAppLaunchConfigurationResult	deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest request) Deletes the launch configuration for the specified application.
DeleteAppReplicationConfigurationResult	deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest request) Deletes the replication configuration for the specified application.
DeleteAppValidationConfigurationResult	deleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest request) Deletes the validation configuration for the specified application.
DeleteReplicationJobResult	deleteReplicationJob(DeleteReplicationJobRequest request) Deletes the specified replication job.
DeleteServerCatalogResult	deleteServerCatalog(DeleteServerCatalogRequest request) Deletes all servers from your server catalog.
DisassociateConnectorResult	disassociateConnector(DisassociateConnectorRequest request) Disassociates the specified connector from Server Migration Service.
GenerateChangeSetResult	generateChangeSet(GenerateChangeSetRequest request) Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
GenerateTemplateResult	generateTemplate(GenerateTemplateRequest request) Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
GetAppResult	getApp(GetAppRequest request) Retrieve information about the specified application.
GetAppLaunchConfigurationResult	getAppLaunchConfiguration(GetAppLaunchConfigurationRequest request) Retrieves the application launch configuration associated with the specified application.
GetAppReplicationConfigurationResult	getAppReplicationConfiguration(GetAppReplicationConfigurationRequest request) Retrieves the application replication configuration associated with the specified application.
GetAppValidationConfigurationResult	getAppValidationConfiguration(GetAppValidationConfigurationRequest request) Retrieves information about a configuration for validating an application.
GetAppValidationOutputResult	getAppValidationOutput(GetAppValidationOutputRequest request) Retrieves output from validating an application.
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.
GetConnectorsResult	getConnectors(GetConnectorsRequest request) Describes the connectors registered with the Server Migration Service.
GetReplicationJobsResult	getReplicationJobs(GetReplicationJobsRequest request) Describes the specified replication job or all of your replication jobs.
GetReplicationRunsResult	getReplicationRuns(GetReplicationRunsRequest request) Describes the replication runs for the specified replication job.
GetServersResult	getServers(GetServersRequest request) Describes the servers in your server catalog.
ImportAppCatalogResult	importAppCatalog(ImportAppCatalogRequest request) Allows application import from Migration Hub.
ImportServerCatalogResult	importServerCatalog(ImportServerCatalogRequest request) Gathers a complete list of on-premises servers.
LaunchAppResult	launchApp(LaunchAppRequest request) Launches the specified application as a stack in CloudFormation.
ListAppsResult	listApps(ListAppsRequest request) Retrieves summaries for all applications.
NotifyAppValidationOutputResult	notifyAppValidationOutput(NotifyAppValidationOutputRequest request) Provides information to Server Migration Service about whether application validation is successful.
PutAppLaunchConfigurationResult	putAppLaunchConfiguration(PutAppLaunchConfigurationRequest request) Creates or updates the launch configuration for the specified application.
PutAppReplicationConfigurationResult	putAppReplicationConfiguration(PutAppReplicationConfigurationRequest request) Creates or updates the replication configuration for the specified application.
PutAppValidationConfigurationResult	putAppValidationConfiguration(PutAppValidationConfigurationRequest request) Creates or updates a validation configuration for the specified application.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAppReplicationResult	startAppReplication(StartAppReplicationRequest request) Starts replicating the specified application by creating replication jobs for each server in the application.
StartOnDemandAppReplicationResult	startOnDemandAppReplication(StartOnDemandAppReplicationRequest request) Starts an on-demand replication run for the specified application.
StartOnDemandReplicationRunResult	startOnDemandReplicationRun(StartOnDemandReplicationRunRequest request) Starts an on-demand replication run for the specified replication job.
StopAppReplicationResult	stopAppReplication(StopAppReplicationRequest request) Stops replicating the specified application by deleting the replication job for each server in the application.
TerminateAppResult	terminateApp(TerminateAppRequest request) Terminates the stack for the specified application.
UpdateAppResult	updateApp(UpdateAppRequest request) Updates the specified application.
UpdateReplicationJobResult	updateReplicationJob(UpdateReplicationJobRequest request) Updates the specified settings for the specified replication job.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.servermigration.AWSServerMigration

setEndpoint, setRegion

Constructor Detail

AWSServerMigrationClient

@Deprecated
public AWSServerMigrationClient()

Deprecated. use AWSServerMigrationClientBuilder.defaultClient()

Constructs a new client to invoke service methods on SMS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSServerMigrationClient

@Deprecated
public AWSServerMigrationClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on SMS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to SMS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSServerMigrationClient

@Deprecated
public AWSServerMigrationClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSServerMigrationClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on SMS using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSServerMigrationClient

@Deprecated
public AWSServerMigrationClient(AWSCredentials awsCredentials,
                                            ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on SMS using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to SMS (ex: proxy settings, retry counts, etc.).

AWSServerMigrationClient

@Deprecated
public AWSServerMigrationClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on SMS using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSServerMigrationClient

@Deprecated
public AWSServerMigrationClient(AWSCredentialsProvider awsCredentialsProvider,
                                            ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on SMS using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to SMS (ex: proxy settings, retry counts, etc.).

AWSServerMigrationClient

@Deprecated
public AWSServerMigrationClient(AWSCredentialsProvider awsCredentialsProvider,
                                            ClientConfiguration clientConfiguration,
                                            RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on SMS using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to SMS (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSServerMigrationClientBuilder builder()

createApp

public CreateAppResult createApp(CreateAppRequest request)

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

Specified by:

createApp in interface AWSServerMigration

Parameters:

createAppRequest -

Returns:

Result of the CreateApp operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

createReplicationJob

public CreateReplicationJobResult createReplicationJob(CreateReplicationJobRequest request)

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).

Specified by:

createReplicationJob in interface AWSServerMigration

Parameters:

createReplicationJobRequest -

Returns:

Result of the CreateReplicationJob operation returned by the service.

Throws:

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException - This operation is not allowed.

ServerCannotBeReplicatedException - The specified server cannot be replicated.

ReplicationJobAlreadyExistsException - The specified replication job already exists.

NoConnectorsAvailableException - There are no connectors available.

InternalErrorException - An internal error occurred.

TemporarilyUnavailableException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteApp

public DeleteAppResult deleteApp(DeleteAppRequest request)

Deletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for servers in the application.

Specified by:

deleteApp in interface AWSServerMigration

Parameters:

deleteAppRequest -

Returns:

Result of the DeleteApp operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

deleteAppLaunchConfiguration

public DeleteAppLaunchConfigurationResult deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest request)

Deletes the launch configuration for the specified application.

Specified by:

deleteAppLaunchConfiguration in interface AWSServerMigration

Parameters:

deleteAppLaunchConfigurationRequest -

Returns:

Result of the DeleteAppLaunchConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

deleteAppReplicationConfiguration

public DeleteAppReplicationConfigurationResult deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest request)

Deletes the replication configuration for the specified application.

Specified by:

deleteAppReplicationConfiguration in interface AWSServerMigration

Parameters:

deleteAppReplicationConfigurationRequest -

Returns:

Result of the DeleteAppReplicationConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

deleteAppValidationConfiguration

public DeleteAppValidationConfigurationResult deleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest request)

Deletes the validation configuration for the specified application.

Specified by:

deleteAppValidationConfiguration in interface AWSServerMigration

Parameters:

deleteAppValidationConfigurationRequest -

Returns:

Result of the DeleteAppValidationConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

deleteReplicationJob

public DeleteReplicationJobResult deleteReplicationJob(DeleteReplicationJobRequest request)

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted.

Specified by:

deleteReplicationJob in interface AWSServerMigration

Parameters:

deleteReplicationJobRequest -

Returns:

Result of the DeleteReplicationJob operation returned by the service.

Throws:

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException - This operation is not allowed.

ReplicationJobNotFoundException - The specified replication job does not exist.

See Also:

AWS API Documentation

deleteServerCatalog

public DeleteServerCatalogResult deleteServerCatalog(DeleteServerCatalogRequest request)

Deletes all servers from your server catalog.

Specified by:

deleteServerCatalog in interface AWSServerMigration

Parameters:

deleteServerCatalogRequest -

Returns:

Result of the DeleteServerCatalog operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException - This operation is not allowed.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

See Also:

AWS API Documentation

disassociateConnector

public DisassociateConnectorResult disassociateConnector(DisassociateConnectorRequest request)

Disassociates the specified connector from Server Migration Service.

After you disassociate a connector, it is no longer available to support replication jobs.

Specified by:

disassociateConnector in interface AWSServerMigration

Parameters:

disassociateConnectorRequest -

Returns:

Result of the DisassociateConnector operation returned by the service.

Throws:

MissingRequiredParameterException - A required parameter is missing.

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException - This operation is not allowed.

InvalidParameterException - A specified parameter is not valid.

See Also:

AWS API Documentation

generateChangeSet

public GenerateChangeSetResult generateChangeSet(GenerateChangeSetRequest request)

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Specified by:

generateChangeSet in interface AWSServerMigration

Parameters:

generateChangeSetRequest -

Returns:

Result of the GenerateChangeSet operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

generateTemplate

public GenerateTemplateResult generateTemplate(GenerateTemplateRequest request)

Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Specified by:

generateTemplate in interface AWSServerMigration

Parameters:

generateTemplateRequest -

Returns:

Result of the GenerateTemplate operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

getApp

public GetAppResult getApp(GetAppRequest request)

Retrieve information about the specified application.

Specified by:

getApp in interface AWSServerMigration

Parameters:

getAppRequest -

Returns:

Result of the GetApp operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

getAppLaunchConfiguration

public GetAppLaunchConfigurationResult getAppLaunchConfiguration(GetAppLaunchConfigurationRequest request)

Retrieves the application launch configuration associated with the specified application.

Specified by:

getAppLaunchConfiguration in interface AWSServerMigration

Parameters:

getAppLaunchConfigurationRequest -

Returns:

Result of the GetAppLaunchConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

getAppReplicationConfiguration

public GetAppReplicationConfigurationResult getAppReplicationConfiguration(GetAppReplicationConfigurationRequest request)

Retrieves the application replication configuration associated with the specified application.

Specified by:

getAppReplicationConfiguration in interface AWSServerMigration

Parameters:

getAppReplicationConfigurationRequest -

Returns:

Result of the GetAppReplicationConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

getAppValidationConfiguration

public GetAppValidationConfigurationResult getAppValidationConfiguration(GetAppValidationConfigurationRequest request)

Retrieves information about a configuration for validating an application.

Specified by:

getAppValidationConfiguration in interface AWSServerMigration

Parameters:

getAppValidationConfigurationRequest -

Returns:

Result of the GetAppValidationConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

getAppValidationOutput

public GetAppValidationOutputResult getAppValidationOutput(GetAppValidationOutputRequest request)

Retrieves output from validating an application.

Specified by:

getAppValidationOutput in interface AWSServerMigration

Parameters:

getAppValidationOutputRequest -

Returns:

Result of the GetAppValidationOutput operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

getConnectors

public GetConnectorsResult getConnectors(GetConnectorsRequest request)

Describes the connectors registered with the Server Migration Service.

Specified by:

getConnectors in interface AWSServerMigration

Parameters:

getConnectorsRequest -

Returns:

Result of the GetConnectors operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

See Also:

AWS API Documentation

getReplicationJobs

public GetReplicationJobsResult getReplicationJobs(GetReplicationJobsRequest request)

Describes the specified replication job or all of your replication jobs.

Specified by:

getReplicationJobs in interface AWSServerMigration

Parameters:

getReplicationJobsRequest -

Returns:

Result of the GetReplicationJobs operation returned by the service.

Throws:

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

See Also:

AWS API Documentation

getReplicationRuns

public GetReplicationRunsResult getReplicationRuns(GetReplicationRunsRequest request)

Describes the replication runs for the specified replication job.

Specified by:

getReplicationRuns in interface AWSServerMigration

Parameters:

getReplicationRunsRequest -

Returns:

Result of the GetReplicationRuns operation returned by the service.

Throws:

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

See Also:

AWS API Documentation

getServers

public GetServersResult getServers(GetServersRequest request)

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

Specified by:

getServers in interface AWSServerMigration

Parameters:

getServersRequest -

Returns:

Result of the GetServers operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

See Also:

AWS API Documentation

importAppCatalog

public ImportAppCatalogResult importAppCatalog(ImportAppCatalogRequest request)

Allows application import from Migration Hub.

Specified by:

importAppCatalog in interface AWSServerMigration

Parameters:

importAppCatalogRequest -

Returns:

Result of the ImportAppCatalog operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

importServerCatalog

public ImportServerCatalogResult importServerCatalog(ImportServerCatalogRequest request)

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

This call returns immediately, but might take additional time to retrieve all the servers.

Specified by:

importServerCatalog in interface AWSServerMigration

Parameters:

importServerCatalogRequest -

Returns:

Result of the ImportServerCatalog operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException - This operation is not allowed.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

NoConnectorsAvailableException - There are no connectors available.

See Also:

AWS API Documentation

launchApp

public LaunchAppResult launchApp(LaunchAppRequest request)

Launches the specified application as a stack in CloudFormation.

Specified by:

launchApp in interface AWSServerMigration

Parameters:

launchAppRequest -

Returns:

Result of the LaunchApp operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

listApps

public ListAppsResult listApps(ListAppsRequest request)

Retrieves summaries for all applications.

Specified by:

listApps in interface AWSServerMigration

Parameters:

listAppsRequest -

Returns:

Result of the ListApps operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

notifyAppValidationOutput

public NotifyAppValidationOutputResult notifyAppValidationOutput(NotifyAppValidationOutputRequest request)

Provides information to Server Migration Service about whether application validation is successful.

Specified by:

notifyAppValidationOutput in interface AWSServerMigration

Parameters:

notifyAppValidationOutputRequest -

Returns:

Result of the NotifyAppValidationOutput operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

putAppLaunchConfiguration

public PutAppLaunchConfigurationResult putAppLaunchConfiguration(PutAppLaunchConfigurationRequest request)

Creates or updates the launch configuration for the specified application.

Specified by:

putAppLaunchConfiguration in interface AWSServerMigration

Parameters:

putAppLaunchConfigurationRequest -

Returns:

Result of the PutAppLaunchConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

putAppReplicationConfiguration

public PutAppReplicationConfigurationResult putAppReplicationConfiguration(PutAppReplicationConfigurationRequest request)

Creates or updates the replication configuration for the specified application.

Specified by:

putAppReplicationConfiguration in interface AWSServerMigration

Parameters:

putAppReplicationConfigurationRequest -

Returns:

Result of the PutAppReplicationConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

putAppValidationConfiguration

public PutAppValidationConfigurationResult putAppValidationConfiguration(PutAppValidationConfigurationRequest request)

Creates or updates a validation configuration for the specified application.

Specified by:

putAppValidationConfiguration in interface AWSServerMigration

Parameters:

putAppValidationConfigurationRequest -

Returns:

Result of the PutAppValidationConfiguration operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

startAppReplication

public StartAppReplicationResult startAppReplication(StartAppReplicationRequest request)

Starts replicating the specified application by creating replication jobs for each server in the application.

Specified by:

startAppReplication in interface AWSServerMigration

Parameters:

startAppReplicationRequest -

Returns:

Result of the StartAppReplication operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

startOnDemandAppReplication

public StartOnDemandAppReplicationResult startOnDemandAppReplication(StartOnDemandAppReplicationRequest request)

Starts an on-demand replication run for the specified application.

Specified by:

startOnDemandAppReplication in interface AWSServerMigration

Parameters:

startOnDemandAppReplicationRequest -

Returns:

Result of the StartOnDemandAppReplication operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

startOnDemandReplicationRun

public StartOnDemandReplicationRunResult startOnDemandReplicationRun(StartOnDemandReplicationRunRequest request)

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

Specified by:

startOnDemandReplicationRun in interface AWSServerMigration

Parameters:

startOnDemandReplicationRunRequest -

Returns:

Result of the StartOnDemandReplicationRun operation returned by the service.

Throws:

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

OperationNotPermittedException - This operation is not allowed.

ReplicationRunLimitExceededException - You have exceeded the number of on-demand replication runs you can request in a 24-hour period.

DryRunOperationException - The user has the required permissions, so the request would have succeeded, but a dry run was performed.

See Also:

AWS API Documentation

stopAppReplication

public StopAppReplicationResult stopAppReplication(StopAppReplicationRequest request)

Stops replicating the specified application by deleting the replication job for each server in the application.

Specified by:

stopAppReplication in interface AWSServerMigration

Parameters:

stopAppReplicationRequest -

Returns:

Result of the StopAppReplication operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

terminateApp

public TerminateAppResult terminateApp(TerminateAppRequest request)

Terminates the stack for the specified application.

Specified by:

terminateApp in interface AWSServerMigration

Parameters:

terminateAppRequest -

Returns:

Result of the TerminateApp operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

updateApp

public UpdateAppResult updateApp(UpdateAppRequest request)

Updates the specified application.

Specified by:

updateApp in interface AWSServerMigration

Parameters:

updateAppRequest -

Returns:

Result of the UpdateApp operation returned by the service.

Throws:

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

InternalErrorException - An internal error occurred.

OperationNotPermittedException - This operation is not allowed.

See Also:

AWS API Documentation

updateReplicationJob

public UpdateReplicationJobResult updateReplicationJob(UpdateReplicationJobRequest request)

Updates the specified settings for the specified replication job.

Specified by:

updateReplicationJob in interface AWSServerMigration

Parameters:

updateReplicationJobRequest -

Returns:

Result of the UpdateReplicationJob operation returned by the service.

Throws:

InvalidParameterException - A specified parameter is not valid.

MissingRequiredParameterException - A required parameter is missing.

OperationNotPermittedException - This operation is not allowed.

UnauthorizedOperationException - You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

ServerCannotBeReplicatedException - The specified server cannot be replicated.

ReplicationJobNotFoundException - The specified replication job does not exist.

InternalErrorException - An internal error occurred.

TemporarilyUnavailableException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSServerMigration

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSServerMigration

Overrides:

shutdown in class AmazonWebServiceClient