AbstractAWSServerMigration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.servermigration.AbstractAWSServerMigration

All Implemented Interfaces:

AWSServerMigration

Direct Known Subclasses:

AbstractAWSServerMigrationAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSServerMigration
extends Object
implements AWSServerMigration
```
Abstract implementation of AWSServerMigration. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.servermigration.AWSServerMigration
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAppResult`	`createApp(CreateAppRequest request)` Creates an application.
`CreateReplicationJobResult`	`createReplicationJob(CreateReplicationJobRequest request)` Creates a replication job.
`DeleteAppResult`	`deleteApp(DeleteAppRequest request)` Deletes an existing application.
`DeleteAppLaunchConfigurationResult`	`deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest request)` Deletes existing launch configuration for an application.
`DeleteAppReplicationConfigurationResult`	`deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest request)` Deletes existing replication configuration for an 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 AWS SMS.
`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 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 request)` Retrieve information about an application.
`GetAppLaunchConfigurationResult`	`getAppLaunchConfiguration(GetAppLaunchConfigurationRequest request)` Retrieves the application launch configuration associated with an application.
`GetAppReplicationConfigurationResult`	`getAppReplicationConfiguration(GetAppReplicationConfigurationRequest request)` 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 request)` Describes the connectors registered with the AWS SMS.
`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.
`ImportServerCatalogResult`	`importServerCatalog(ImportServerCatalogRequest request)` Gathers a complete list of on-premises servers.
`LaunchAppResult`	`launchApp(LaunchAppRequest request)` Launches an application stack.
`ListAppsResult`	`listApps(ListAppsRequest request)` Returns a list of summaries for all applications.
`PutAppLaunchConfigurationResult`	`putAppLaunchConfiguration(PutAppLaunchConfigurationRequest request)` Creates a launch configuration for an application.
`PutAppReplicationConfigurationResult`	`putAppReplicationConfiguration(PutAppReplicationConfigurationRequest request)` Creates or updates a replication configuration for an application.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("sms.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSServerMigration.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartAppReplicationResult`	`startAppReplication(StartAppReplicationRequest request)` Starts replicating an application.
`StartOnDemandReplicationRunResult`	`startOnDemandReplicationRun(StartOnDemandReplicationRunRequest request)` Starts an on-demand replication run for the specified replication job.
`StopAppReplicationResult`	`stopAppReplication(StopAppReplicationRequest request)` Stops replicating an application.
`TerminateAppResult`	`terminateApp(TerminateAppRequest request)` Terminates the stack for an application.
`UpdateAppResult`	`updateApp(UpdateAppRequest request)` Updates an application.
`UpdateReplicationJobResult`	`updateReplicationJob(UpdateReplicationJobRequest request)` Updates the specified settings for the specified replication job.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSServerMigration
    
    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.
    
    Specified by:
    
    setEndpoint in interface AWSServerMigration
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AWSServerMigration
    
    An alternative to AWSServerMigration.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.
    
    Specified by:
    
    setRegion in interface AWSServerMigration
    
    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
```
public CreateAppResult createApp(CreateAppRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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
    
    Returns:
    
    Result of the CreateApp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createReplicationJob
```
public CreateReplicationJobResult createReplicationJob(CreateReplicationJobRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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).
    
    Specified by:
    
    createReplicationJob in interface AWSServerMigration
    
    Returns:
    
    Result of the CreateReplicationJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteApp
```
public DeleteAppResult deleteApp(DeleteAppRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.
    
    Specified by:
    
    deleteApp in interface AWSServerMigration
    
    Returns:
    
    Result of the DeleteApp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAppLaunchConfiguration
```
public DeleteAppLaunchConfigurationResult deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Deletes existing launch configuration for an application.
    
    Specified by:
    
    deleteAppLaunchConfiguration in interface AWSServerMigration
    
    Returns:
    
    Result of the DeleteAppLaunchConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAppReplicationConfiguration
```
public DeleteAppReplicationConfigurationResult deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Deletes existing replication configuration for an application.
    
    Specified by:
    
    deleteAppReplicationConfiguration in interface AWSServerMigration
    
    Returns:
    
    Result of the DeleteAppReplicationConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReplicationJob
```
public DeleteReplicationJobResult deleteReplicationJob(DeleteReplicationJobRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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.
    
    Specified by:
    
    deleteReplicationJob in interface AWSServerMigration
    
    Returns:
    
    Result of the DeleteReplicationJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteServerCatalog
```
public DeleteServerCatalogResult deleteServerCatalog(DeleteServerCatalogRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Deletes all servers from your server catalog.
    
    Specified by:
    
    deleteServerCatalog in interface AWSServerMigration
    
    Returns:
    
    Result of the DeleteServerCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateConnector
```
public DisassociateConnectorResult disassociateConnector(DisassociateConnectorRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Disassociates the specified connector from AWS SMS.
    
    After you disassociate a connector, it is no longer available to support replication jobs.
    
    Specified by:
    
    disassociateConnector in interface AWSServerMigration
    
    Returns:
    
    Result of the DisassociateConnector operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - generateChangeSet
```
public GenerateChangeSetResult generateChangeSet(GenerateChangeSetRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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
    
    Returns:
    
    Result of the GenerateChangeSet operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - generateTemplate
```
public GenerateTemplateResult generateTemplate(GenerateTemplateRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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.
    
    Specified by:
    
    generateTemplate in interface AWSServerMigration
    
    Returns:
    
    Result of the GenerateTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getApp
```
public GetAppResult getApp(GetAppRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Retrieve information about an application.
    
    Specified by:
    
    getApp in interface AWSServerMigration
    
    Returns:
    
    Result of the GetApp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAppLaunchConfiguration
```
public GetAppLaunchConfigurationResult getAppLaunchConfiguration(GetAppLaunchConfigurationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Retrieves the application launch configuration associated with an application.
    
    Specified by:
    
    getAppLaunchConfiguration in interface AWSServerMigration
    
    Returns:
    
    Result of the GetAppLaunchConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAppReplicationConfiguration
```
public GetAppReplicationConfigurationResult getAppReplicationConfiguration(GetAppReplicationConfigurationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Retrieves an application replication configuration associatd with an application.
    
    Specified by:
    
    getAppReplicationConfiguration in interface AWSServerMigration
    
    Returns:
    
    Result of the GetAppReplicationConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getConnectors
```
public GetConnectorsResult getConnectors(GetConnectorsRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Describes the connectors registered with the AWS SMS.
    
    Specified by:
    
    getConnectors in interface AWSServerMigration
    
    Returns:
    
    Result of the GetConnectors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getReplicationJobs
```
public GetReplicationJobsResult getReplicationJobs(GetReplicationJobsRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Describes the specified replication job or all of your replication jobs.
    
    Specified by:
    
    getReplicationJobs in interface AWSServerMigration
    
    Returns:
    
    Result of the GetReplicationJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getReplicationRuns
```
public GetReplicationRunsResult getReplicationRuns(GetReplicationRunsRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Describes the replication runs for the specified replication job.
    
    Specified by:
    
    getReplicationRuns in interface AWSServerMigration
    
    Returns:
    
    Result of the GetReplicationRuns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getServers
```
public GetServersResult getServers(GetServersRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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
    
    Returns:
    
    Result of the GetServers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importServerCatalog
```
public ImportServerCatalogResult importServerCatalog(ImportServerCatalogRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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.
    
    Specified by:
    
    importServerCatalog in interface AWSServerMigration
    
    Returns:
    
    Result of the ImportServerCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - launchApp
```
public LaunchAppResult launchApp(LaunchAppRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Launches an application stack.
    
    Specified by:
    
    launchApp in interface AWSServerMigration
    
    Returns:
    
    Result of the LaunchApp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listApps
```
public ListAppsResult listApps(ListAppsRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Returns a list of summaries for all applications.
    
    Specified by:
    
    listApps in interface AWSServerMigration
    
    Returns:
    
    Result of the ListApps operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putAppLaunchConfiguration
```
public PutAppLaunchConfigurationResult putAppLaunchConfiguration(PutAppLaunchConfigurationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Creates a launch configuration for an application.
    
    Specified by:
    
    putAppLaunchConfiguration in interface AWSServerMigration
    
    Returns:
    
    Result of the PutAppLaunchConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putAppReplicationConfiguration
```
public PutAppReplicationConfigurationResult putAppReplicationConfiguration(PutAppReplicationConfigurationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Creates or updates a replication configuration for an application.
    
    Specified by:
    
    putAppReplicationConfiguration in interface AWSServerMigration
    
    Returns:
    
    Result of the PutAppReplicationConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startAppReplication
```
public StartAppReplicationResult startAppReplication(StartAppReplicationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Starts replicating an application.
    
    Specified by:
    
    startAppReplication in interface AWSServerMigration
    
    Returns:
    
    Result of the StartAppReplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startOnDemandReplicationRun
```
public StartOnDemandReplicationRunResult startOnDemandReplicationRun(StartOnDemandReplicationRunRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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.
    
    Specified by:
    
    startOnDemandReplicationRun in interface AWSServerMigration
    
    Returns:
    
    Result of the StartOnDemandReplicationRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopAppReplication
```
public StopAppReplicationResult stopAppReplication(StopAppReplicationRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Stops replicating an application.
    
    Specified by:
    
    stopAppReplication in interface AWSServerMigration
    
    Returns:
    
    Result of the StopAppReplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - terminateApp
```
public TerminateAppResult terminateApp(TerminateAppRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Terminates the stack for an application.
    
    Specified by:
    
    terminateApp in interface AWSServerMigration
    
    Returns:
    
    Result of the TerminateApp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApp
```
public UpdateAppResult updateApp(UpdateAppRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Updates an application.
    
    Specified by:
    
    updateApp in interface AWSServerMigration
    
    Returns:
    
    Result of the UpdateApp operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateReplicationJob
```
public UpdateReplicationJobResult updateReplicationJob(UpdateReplicationJobRequest request)
```
    Description copied from interface: AWSServerMigration
    
    Updates the specified settings for the specified replication job.
    
    Specified by:
    
    updateReplicationJob in interface AWSServerMigration
    
    Returns:
    
    Result of the UpdateReplicationJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSServerMigration
    
    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.
    
    Specified by:
    
    shutdown in interface AWSServerMigration
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSServerMigration
    
    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.
    
    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.

Did this page help you?

Class AbstractAWSServerMigration

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createApp

createReplicationJob

deleteApp

deleteAppLaunchConfiguration

deleteAppReplicationConfiguration

deleteReplicationJob

deleteServerCatalog

disassociateConnector

generateChangeSet

generateTemplate

getApp

getAppLaunchConfiguration

getAppReplicationConfiguration

getConnectors

getReplicationJobs

getReplicationRuns

getServers

importServerCatalog

launchApp

listApps

putAppLaunchConfiguration

putAppReplicationConfiguration

startAppReplication

startOnDemandReplicationRun

stopAppReplication

terminateApp

updateApp

updateReplicationJob

shutdown

getCachedResponseMetadata