com.amazonaws.services.servermigration

Interface AWSServerMigration

All Known Subinterfaces:

AWSServerMigrationAsync

All Known Implementing Classes:

AbstractAWSServerMigration, AbstractAWSServerMigrationAsync, AWSServerMigrationAsyncClient, AWSServerMigrationClient

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

Interface for accessing SMS.

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

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

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
CreateAppResult	createApp(CreateAppRequest createAppRequest) Creates an application.
CreateReplicationJobResult	createReplicationJob(CreateReplicationJobRequest createReplicationJobRequest) Creates a replication job.
DeleteAppResult	deleteApp(DeleteAppRequest deleteAppRequest) Deletes the specified application.
DeleteAppLaunchConfigurationResult	deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest) Deletes the launch configuration for the specified application.
DeleteAppReplicationConfigurationResult	deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest) Deletes the replication configuration for the specified application.
DeleteAppValidationConfigurationResult	deleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest deleteAppValidationConfigurationRequest) Deletes the validation configuration for the specified application.
DeleteReplicationJobResult	deleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest) Deletes the specified replication job.
DeleteServerCatalogResult	deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest) Deletes all servers from your server catalog.
DisassociateConnectorResult	disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest) Disassociates the specified connector from Server Migration Service.
GenerateChangeSetResult	generateChangeSet(GenerateChangeSetRequest generateChangeSetRequest) 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 generateTemplateRequest) 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 getAppRequest) Retrieve information about the specified application.
GetAppLaunchConfigurationResult	getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest) Retrieves the application launch configuration associated with the specified application.
GetAppReplicationConfigurationResult	getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest) Retrieves the application replication configuration associated with the specified application.
GetAppValidationConfigurationResult	getAppValidationConfiguration(GetAppValidationConfigurationRequest getAppValidationConfigurationRequest) Retrieves information about a configuration for validating an application.
GetAppValidationOutputResult	getAppValidationOutput(GetAppValidationOutputRequest getAppValidationOutputRequest) 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 getConnectorsRequest) Describes the connectors registered with the Server Migration Service.
GetReplicationJobsResult	getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest) Describes the specified replication job or all of your replication jobs.
GetReplicationRunsResult	getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest) Describes the replication runs for the specified replication job.
GetServersResult	getServers(GetServersRequest getServersRequest) Describes the servers in your server catalog.
ImportAppCatalogResult	importAppCatalog(ImportAppCatalogRequest importAppCatalogRequest) Allows application import from Migration Hub.
ImportServerCatalogResult	importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest) Gathers a complete list of on-premises servers.
LaunchAppResult	launchApp(LaunchAppRequest launchAppRequest) Launches the specified application as a stack in CloudFormation.
ListAppsResult	listApps(ListAppsRequest listAppsRequest) Retrieves summaries for all applications.
NotifyAppValidationOutputResult	notifyAppValidationOutput(NotifyAppValidationOutputRequest notifyAppValidationOutputRequest) Provides information to Server Migration Service about whether application validation is successful.
PutAppLaunchConfigurationResult	putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest) Creates or updates the launch configuration for the specified application.
PutAppReplicationConfigurationResult	putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest) Creates or updates the replication configuration for the specified application.
PutAppValidationConfigurationResult	putAppValidationConfiguration(PutAppValidationConfigurationRequest putAppValidationConfigurationRequest) Creates or updates a validation configuration for the specified application.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAppReplicationResult	startAppReplication(StartAppReplicationRequest startAppReplicationRequest) Starts replicating the specified application by creating replication jobs for each server in the application.
StartOnDemandAppReplicationResult	startOnDemandAppReplication(StartOnDemandAppReplicationRequest startOnDemandAppReplicationRequest) Starts an on-demand replication run for the specified application.
StartOnDemandReplicationRunResult	startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest) Starts an on-demand replication run for the specified replication job.
StopAppReplicationResult	stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest) Stops replicating the specified application by deleting the replication job for each server in the application.
TerminateAppResult	terminateApp(TerminateAppRequest terminateAppRequest) Terminates the stack for the specified application.
UpdateAppResult	updateApp(UpdateAppRequest updateAppRequest) Updates the specified application.
UpdateReplicationJobResult	updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest) Updates the specified settings for the specified replication job.

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

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("sms.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "sms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "sms.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "sms.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "sms.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

createApp

CreateAppResult createApp(CreateAppRequest createAppRequest)

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

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

CreateReplicationJobResult createReplicationJob(CreateReplicationJobRequest createReplicationJobRequest)

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

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

DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)

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.

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

DeleteAppLaunchConfigurationResult deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest)

Deletes the launch configuration for the specified application.

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

DeleteAppReplicationConfigurationResult deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest)

Deletes the replication configuration for the specified application.

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

DeleteAppValidationConfigurationResult deleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest deleteAppValidationConfigurationRequest)

Deletes the validation configuration for the specified application.

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

DeleteReplicationJobResult deleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest)

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.

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

DeleteServerCatalogResult deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest)

Deletes all servers from your server catalog.

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

DisassociateConnectorResult disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest)

Disassociates the specified connector from Server Migration Service.

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

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

GenerateChangeSetResult generateChangeSet(GenerateChangeSetRequest generateChangeSetRequest)

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.

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

GenerateTemplateResult generateTemplate(GenerateTemplateRequest generateTemplateRequest)

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.

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

GetAppResult getApp(GetAppRequest getAppRequest)

Retrieve information about the specified application.

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

GetAppLaunchConfigurationResult getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest)

Retrieves the application launch configuration associated with the specified application.

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

GetAppReplicationConfigurationResult getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest)

Retrieves the application replication configuration associated with the specified application.

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

GetAppValidationConfigurationResult getAppValidationConfiguration(GetAppValidationConfigurationRequest getAppValidationConfigurationRequest)

Retrieves information about a configuration for validating an application.

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

GetAppValidationOutputResult getAppValidationOutput(GetAppValidationOutputRequest getAppValidationOutputRequest)

Retrieves output from validating an application.

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

GetConnectorsResult getConnectors(GetConnectorsRequest getConnectorsRequest)

Describes the connectors registered with the Server Migration Service.

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

GetReplicationJobsResult getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest)

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

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

GetReplicationRunsResult getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest)

Describes the replication runs for the specified replication job.

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

GetServersResult getServers(GetServersRequest getServersRequest)

Describes the servers in your server catalog.

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

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

ImportAppCatalogResult importAppCatalog(ImportAppCatalogRequest importAppCatalogRequest)

Allows application import from Migration Hub.

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

ImportServerCatalogResult importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest)

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.

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

LaunchAppResult launchApp(LaunchAppRequest launchAppRequest)

Launches the specified application as a stack in CloudFormation.

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

ListAppsResult listApps(ListAppsRequest listAppsRequest)

Retrieves summaries for all applications.

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

NotifyAppValidationOutputResult notifyAppValidationOutput(NotifyAppValidationOutputRequest notifyAppValidationOutputRequest)

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

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

PutAppLaunchConfigurationResult putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest)

Creates or updates the launch configuration for the specified application.

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

PutAppReplicationConfigurationResult putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest)

Creates or updates the replication configuration for the specified application.

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

PutAppValidationConfigurationResult putAppValidationConfiguration(PutAppValidationConfigurationRequest putAppValidationConfigurationRequest)

Creates or updates a validation configuration for the specified application.

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

StartAppReplicationResult startAppReplication(StartAppReplicationRequest startAppReplicationRequest)

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

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

StartOnDemandAppReplicationResult startOnDemandAppReplication(StartOnDemandAppReplicationRequest startOnDemandAppReplicationRequest)

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

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

StartOnDemandReplicationRunResult startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest)

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.

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

StopAppReplicationResult stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest)

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

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

TerminateAppResult terminateApp(TerminateAppRequest terminateAppRequest)

Terminates the stack for the specified application.

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

UpdateAppResult updateApp(UpdateAppRequest updateAppRequest)

Updates the specified application.

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

UpdateReplicationJobResult updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest)

Updates the specified settings for the specified replication job.

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

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.