@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSServerMigration
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSServerMigration
instead.
This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
To learn more about the Server Migration Service, see the following resources:
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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 an existing application.
|
DeleteAppLaunchConfigurationResult |
deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest)
Deletes existing launch configuration for an application.
|
DeleteAppReplicationConfigurationResult |
deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest)
Deletes existing replication configuration for an 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 AWS SMS.
|
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 Amazon 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 an application.
|
GetAppLaunchConfigurationResult |
getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest)
Retrieves the application launch configuration associated with an application.
|
GetAppReplicationConfigurationResult |
getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest)
Retrieves an application replication configuration associatd with 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 AWS SMS.
|
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.
|
ImportServerCatalogResult |
importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest)
Gathers a complete list of on-premises servers.
|
LaunchAppResult |
launchApp(LaunchAppRequest launchAppRequest)
Launches an application stack.
|
ListAppsResult |
listApps(ListAppsRequest listAppsRequest)
Returns a list of summaries for all applications.
|
PutAppLaunchConfigurationResult |
putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest)
Creates a launch configuration for an application.
|
PutAppReplicationConfigurationResult |
putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest)
Creates or updates a replication configuration for an 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 an application.
|
StartOnDemandReplicationRunResult |
startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest)
Starts an on-demand replication run for the specified replication job.
|
StopAppReplicationResult |
stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest)
Stops replicating an application.
|
TerminateAppResult |
terminateApp(TerminateAppRequest terminateAppRequest)
Terminates the stack for an application.
|
UpdateAppResult |
updateApp(UpdateAppRequest updateAppRequest)
Updates an application.
|
UpdateReplicationJobResult |
updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest)
Updates the specified settings for the specified replication job.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
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.
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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
CreateAppResult createApp(CreateAppRequest createAppRequest)
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
createAppRequest
- 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.CreateReplicationJobResult createReplicationJob(CreateReplicationJobRequest createReplicationJobRequest)
Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).
createReplicationJobRequest
- 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.DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.
deleteAppRequest
- 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.DeleteAppLaunchConfigurationResult deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest)
Deletes existing launch configuration for an application.
deleteAppLaunchConfigurationRequest
- 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.DeleteAppReplicationConfigurationResult deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest)
Deletes existing replication configuration for an application.
deleteAppReplicationConfigurationRequest
- 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.DeleteReplicationJobResult deleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest)
Deletes the specified replication job.
After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.
deleteReplicationJobRequest
- 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.DeleteServerCatalogResult deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest)
Deletes all servers from your server catalog.
deleteServerCatalogRequest
- 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.DisassociateConnectorResult disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest)
Disassociates the specified connector from AWS SMS.
After you disassociate a connector, it is no longer available to support replication jobs.
disassociateConnectorRequest
- 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.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.
generateChangeSetRequest
- 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.GenerateTemplateResult generateTemplate(GenerateTemplateRequest generateTemplateRequest)
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
generateTemplateRequest
- 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.GetAppResult getApp(GetAppRequest getAppRequest)
Retrieve information about an application.
getAppRequest
- 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.GetAppLaunchConfigurationResult getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest)
Retrieves the application launch configuration associated with an application.
getAppLaunchConfigurationRequest
- 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.GetAppReplicationConfigurationResult getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest)
Retrieves an application replication configuration associatd with an application.
getAppReplicationConfigurationRequest
- 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.GetConnectorsResult getConnectors(GetConnectorsRequest getConnectorsRequest)
Describes the connectors registered with the AWS SMS.
getConnectorsRequest
- UnauthorizedOperationException
- You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are
using the correct access keys.GetReplicationJobsResult getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest)
Describes the specified replication job or all of your replication jobs.
getReplicationJobsRequest
- 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.GetReplicationRunsResult getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest)
Describes the replication runs for the specified replication job.
getReplicationRunsRequest
- 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.GetServersResult getServers(GetServersRequest getServersRequest)
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
getServersRequest
- UnauthorizedOperationException
- You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are
using the correct access keys.ImportServerCatalogResult importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest)
Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import.
This call returns immediately, but might take additional time to retrieve all the servers.
importServerCatalogRequest
- 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.LaunchAppResult launchApp(LaunchAppRequest launchAppRequest)
Launches an application stack.
launchAppRequest
- 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.ListAppsResult listApps(ListAppsRequest listAppsRequest)
Returns a list of summaries for all applications.
listAppsRequest
- 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.PutAppLaunchConfigurationResult putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest)
Creates a launch configuration for an application.
putAppLaunchConfigurationRequest
- 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.PutAppReplicationConfigurationResult putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest)
Creates or updates a replication configuration for an application.
putAppReplicationConfigurationRequest
- 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.StartAppReplicationResult startAppReplication(StartAppReplicationRequest startAppReplicationRequest)
Starts replicating an application.
startAppReplicationRequest
- 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.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 you can request in a 24-hour period.
startOnDemandReplicationRunRequest
- 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.StopAppReplicationResult stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest)
Stops replicating an application.
stopAppReplicationRequest
- 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.TerminateAppResult terminateApp(TerminateAppRequest terminateAppRequest)
Terminates the stack for an application.
terminateAppRequest
- 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.UpdateAppResult updateApp(UpdateAppRequest updateAppRequest)
Updates an application.
updateAppRequest
- 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.UpdateReplicationJobResult updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest)
Updates the specified settings for the specified replication job.
updateReplicationJobRequest
- 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.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.