sms/aws.sdk.kotlin.services.sms/SmsClient

SmsClient

interface SmsClient : SdkClient

Deprecated

No longer recommended for use. See AWS API documentation for more details.

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:

Properties

Link copied to clipboard
abstract override val config: SmsClient.Config

SmsClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createApp(input: CreateAppRequest = CreateAppRequest { }): CreateAppResponse

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

Link copied to clipboard
abstract suspend fun createReplicationJob(input: CreateReplicationJobRequest): CreateReplicationJobResponse

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

Link copied to clipboard
abstract suspend fun deleteApp(input: DeleteAppRequest = DeleteAppRequest { }): DeleteAppResponse

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.

Link copied to clipboard
abstract suspend fun deleteAppLaunchConfiguration(input: DeleteAppLaunchConfigurationRequest = DeleteAppLaunchConfigurationRequest { }): DeleteAppLaunchConfigurationResponse

Deletes the launch configuration for the specified application.

Link copied to clipboard
abstract suspend fun deleteAppReplicationConfiguration(input: DeleteAppReplicationConfigurationRequest = DeleteAppReplicationConfigurationRequest { }): DeleteAppReplicationConfigurationResponse

Deletes the replication configuration for the specified application.

Link copied to clipboard
abstract suspend fun deleteAppValidationConfiguration(input: DeleteAppValidationConfigurationRequest): DeleteAppValidationConfigurationResponse

Deletes the validation configuration for the specified application.

Link copied to clipboard
abstract suspend fun deleteReplicationJob(input: DeleteReplicationJobRequest): DeleteReplicationJobResponse

Deletes the specified replication job.

Link copied to clipboard
abstract suspend fun deleteServerCatalog(input: DeleteServerCatalogRequest = DeleteServerCatalogRequest { }): DeleteServerCatalogResponse

Deletes all servers from your server catalog.

Link copied to clipboard
abstract suspend fun disassociateConnector(input: DisassociateConnectorRequest): DisassociateConnectorResponse

Disassociates the specified connector from Server Migration Service.

Link copied to clipboard
abstract suspend fun generateChangeSet(input: GenerateChangeSetRequest = GenerateChangeSetRequest { }): GenerateChangeSetResponse

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.

Link copied to clipboard
abstract suspend fun generateTemplate(input: GenerateTemplateRequest = GenerateTemplateRequest { }): GenerateTemplateResponse

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.

Link copied to clipboard
abstract suspend fun getApp(input: GetAppRequest = GetAppRequest { }): GetAppResponse

Retrieve information about the specified application.

Link copied to clipboard
abstract suspend fun getAppLaunchConfiguration(input: GetAppLaunchConfigurationRequest = GetAppLaunchConfigurationRequest { }): GetAppLaunchConfigurationResponse

Retrieves the application launch configuration associated with the specified application.

Link copied to clipboard
abstract suspend fun getAppReplicationConfiguration(input: GetAppReplicationConfigurationRequest = GetAppReplicationConfigurationRequest { }): GetAppReplicationConfigurationResponse

Retrieves the application replication configuration associated with the specified application.

Link copied to clipboard
abstract suspend fun getAppValidationConfiguration(input: GetAppValidationConfigurationRequest): GetAppValidationConfigurationResponse

Retrieves information about a configuration for validating an application.

Link copied to clipboard
abstract suspend fun getAppValidationOutput(input: GetAppValidationOutputRequest): GetAppValidationOutputResponse

Retrieves output from validating an application.

Link copied to clipboard
abstract suspend fun getConnectors(input: GetConnectorsRequest = GetConnectorsRequest { }): GetConnectorsResponse

Describes the connectors registered with the Server Migration Service.

Link copied to clipboard
abstract suspend fun getReplicationJobs(input: GetReplicationJobsRequest = GetReplicationJobsRequest { }): GetReplicationJobsResponse

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

Link copied to clipboard
abstract suspend fun getReplicationRuns(input: GetReplicationRunsRequest): GetReplicationRunsResponse

Describes the replication runs for the specified replication job.

Link copied to clipboard
abstract suspend fun getServers(input: GetServersRequest = GetServersRequest { }): GetServersResponse

Describes the servers in your server catalog.

Link copied to clipboard
abstract suspend fun importAppCatalog(input: ImportAppCatalogRequest = ImportAppCatalogRequest { }): ImportAppCatalogResponse

Allows application import from Migration Hub.

Link copied to clipboard
abstract suspend fun importServerCatalog(input: ImportServerCatalogRequest = ImportServerCatalogRequest { }): ImportServerCatalogResponse

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

Link copied to clipboard
abstract suspend fun launchApp(input: LaunchAppRequest = LaunchAppRequest { }): LaunchAppResponse

Launches the specified application as a stack in CloudFormation.

Link copied to clipboard
abstract suspend fun listApps(input: ListAppsRequest = ListAppsRequest { }): ListAppsResponse

Retrieves summaries for all applications.

Link copied to clipboard
abstract suspend fun notifyAppValidationOutput(input: NotifyAppValidationOutputRequest): NotifyAppValidationOutputResponse

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

Link copied to clipboard
abstract suspend fun putAppLaunchConfiguration(input: PutAppLaunchConfigurationRequest = PutAppLaunchConfigurationRequest { }): PutAppLaunchConfigurationResponse

Creates or updates the launch configuration for the specified application.

Link copied to clipboard
abstract suspend fun putAppReplicationConfiguration(input: PutAppReplicationConfigurationRequest = PutAppReplicationConfigurationRequest { }): PutAppReplicationConfigurationResponse

Creates or updates the replication configuration for the specified application.

Link copied to clipboard
abstract suspend fun putAppValidationConfiguration(input: PutAppValidationConfigurationRequest): PutAppValidationConfigurationResponse

Creates or updates a validation configuration for the specified application.

Link copied to clipboard
abstract suspend fun startAppReplication(input: StartAppReplicationRequest = StartAppReplicationRequest { }): StartAppReplicationResponse

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

Link copied to clipboard
abstract suspend fun startOnDemandAppReplication(input: StartOnDemandAppReplicationRequest): StartOnDemandAppReplicationResponse

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

Link copied to clipboard
abstract suspend fun startOnDemandReplicationRun(input: StartOnDemandReplicationRunRequest): StartOnDemandReplicationRunResponse

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.

Link copied to clipboard
abstract suspend fun stopAppReplication(input: StopAppReplicationRequest = StopAppReplicationRequest { }): StopAppReplicationResponse

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

Link copied to clipboard
abstract suspend fun terminateApp(input: TerminateAppRequest = TerminateAppRequest { }): TerminateAppResponse

Terminates the stack for the specified application.

Link copied to clipboard
abstract suspend fun updateApp(input: UpdateAppRequest = UpdateAppRequest { }): UpdateAppResponse

Updates the specified application.

Link copied to clipboard
abstract suspend fun updateReplicationJob(input: UpdateReplicationJobRequest): UpdateReplicationJobResponse

Updates the specified settings for the specified replication job.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun SmsClient.createApp(crossinline block: CreateAppRequest.Builder.() -> Unit): CreateAppResponse

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

Link copied to clipboard
inline suspend fun SmsClient.createReplicationJob(crossinline block: CreateReplicationJobRequest.Builder.() -> Unit): CreateReplicationJobResponse

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

Link copied to clipboard
inline suspend fun SmsClient.deleteApp(crossinline block: DeleteAppRequest.Builder.() -> Unit): DeleteAppResponse

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.

Link copied to clipboard
inline suspend fun SmsClient.deleteAppLaunchConfiguration(crossinline block: DeleteAppLaunchConfigurationRequest.Builder.() -> Unit): DeleteAppLaunchConfigurationResponse

Deletes the launch configuration for the specified application.

Link copied to clipboard
inline suspend fun SmsClient.deleteAppReplicationConfiguration(crossinline block: DeleteAppReplicationConfigurationRequest.Builder.() -> Unit): DeleteAppReplicationConfigurationResponse

Deletes the replication configuration for the specified application.

Link copied to clipboard
inline suspend fun SmsClient.deleteAppValidationConfiguration(crossinline block: DeleteAppValidationConfigurationRequest.Builder.() -> Unit): DeleteAppValidationConfigurationResponse

Deletes the validation configuration for the specified application.

Link copied to clipboard
inline suspend fun SmsClient.deleteReplicationJob(crossinline block: DeleteReplicationJobRequest.Builder.() -> Unit): DeleteReplicationJobResponse

Deletes the specified replication job.

Link copied to clipboard
inline suspend fun SmsClient.deleteServerCatalog(crossinline block: DeleteServerCatalogRequest.Builder.() -> Unit): DeleteServerCatalogResponse

Deletes all servers from your server catalog.

Link copied to clipboard
inline suspend fun SmsClient.disassociateConnector(crossinline block: DisassociateConnectorRequest.Builder.() -> Unit): DisassociateConnectorResponse

Disassociates the specified connector from Server Migration Service.

Link copied to clipboard
inline suspend fun SmsClient.generateChangeSet(crossinline block: GenerateChangeSetRequest.Builder.() -> Unit): GenerateChangeSetResponse

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.

Link copied to clipboard
inline suspend fun SmsClient.generateTemplate(crossinline block: GenerateTemplateRequest.Builder.() -> Unit): GenerateTemplateResponse

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.

Link copied to clipboard
inline suspend fun SmsClient.getApp(crossinline block: GetAppRequest.Builder.() -> Unit): GetAppResponse

Retrieve information about the specified application.

Link copied to clipboard
inline suspend fun SmsClient.getAppLaunchConfiguration(crossinline block: GetAppLaunchConfigurationRequest.Builder.() -> Unit): GetAppLaunchConfigurationResponse

Retrieves the application launch configuration associated with the specified application.

Link copied to clipboard
inline suspend fun SmsClient.getAppReplicationConfiguration(crossinline block: GetAppReplicationConfigurationRequest.Builder.() -> Unit): GetAppReplicationConfigurationResponse

Retrieves the application replication configuration associated with the specified application.

Link copied to clipboard
inline suspend fun SmsClient.getAppValidationConfiguration(crossinline block: GetAppValidationConfigurationRequest.Builder.() -> Unit): GetAppValidationConfigurationResponse

Retrieves information about a configuration for validating an application.

Link copied to clipboard
inline suspend fun SmsClient.getAppValidationOutput(crossinline block: GetAppValidationOutputRequest.Builder.() -> Unit): GetAppValidationOutputResponse

Retrieves output from validating an application.

Link copied to clipboard
inline suspend fun SmsClient.getConnectors(crossinline block: GetConnectorsRequest.Builder.() -> Unit): GetConnectorsResponse

Describes the connectors registered with the Server Migration Service.

Link copied to clipboard
Link copied to clipboard
inline suspend fun SmsClient.getReplicationJobs(crossinline block: GetReplicationJobsRequest.Builder.() -> Unit): GetReplicationJobsResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun SmsClient.getReplicationRuns(crossinline block: GetReplicationRunsRequest.Builder.() -> Unit): GetReplicationRunsResponse

Describes the replication runs for the specified replication job.

Link copied to clipboard
Link copied to clipboard
inline suspend fun SmsClient.getServers(crossinline block: GetServersRequest.Builder.() -> Unit): GetServersResponse

Describes the servers in your server catalog.

Link copied to clipboard
fun SmsClient.getServersPaginated(initialRequest: GetServersRequest = GetServersRequest { }): Flow<GetServersResponse>
fun SmsClient.getServersPaginated(block: GetServersRequest.Builder.() -> Unit): Flow<GetServersResponse>

Paginate over GetServersResponse results.

Link copied to clipboard
inline suspend fun SmsClient.importAppCatalog(crossinline block: ImportAppCatalogRequest.Builder.() -> Unit): ImportAppCatalogResponse

Allows application import from Migration Hub.

Link copied to clipboard
inline suspend fun SmsClient.importServerCatalog(crossinline block: ImportServerCatalogRequest.Builder.() -> Unit): ImportServerCatalogResponse

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

Link copied to clipboard
inline suspend fun SmsClient.launchApp(crossinline block: LaunchAppRequest.Builder.() -> Unit): LaunchAppResponse

Launches the specified application as a stack in CloudFormation.

Link copied to clipboard
inline suspend fun SmsClient.listApps(crossinline block: ListAppsRequest.Builder.() -> Unit): ListAppsResponse

Retrieves summaries for all applications.

Link copied to clipboard
inline suspend fun SmsClient.notifyAppValidationOutput(crossinline block: NotifyAppValidationOutputRequest.Builder.() -> Unit): NotifyAppValidationOutputResponse

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

Link copied to clipboard
inline suspend fun SmsClient.putAppLaunchConfiguration(crossinline block: PutAppLaunchConfigurationRequest.Builder.() -> Unit): PutAppLaunchConfigurationResponse

Creates or updates the launch configuration for the specified application.

Link copied to clipboard
inline suspend fun SmsClient.putAppReplicationConfiguration(crossinline block: PutAppReplicationConfigurationRequest.Builder.() -> Unit): PutAppReplicationConfigurationResponse

Creates or updates the replication configuration for the specified application.

Link copied to clipboard
inline suspend fun SmsClient.putAppValidationConfiguration(crossinline block: PutAppValidationConfigurationRequest.Builder.() -> Unit): PutAppValidationConfigurationResponse

Creates or updates a validation configuration for the specified application.

Link copied to clipboard
inline suspend fun SmsClient.startAppReplication(crossinline block: StartAppReplicationRequest.Builder.() -> Unit): StartAppReplicationResponse

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

Link copied to clipboard
inline suspend fun SmsClient.startOnDemandAppReplication(crossinline block: StartOnDemandAppReplicationRequest.Builder.() -> Unit): StartOnDemandAppReplicationResponse

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

Link copied to clipboard
inline suspend fun SmsClient.startOnDemandReplicationRun(crossinline block: StartOnDemandReplicationRunRequest.Builder.() -> Unit): StartOnDemandReplicationRunResponse

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.

Link copied to clipboard
inline suspend fun SmsClient.stopAppReplication(crossinline block: StopAppReplicationRequest.Builder.() -> Unit): StopAppReplicationResponse

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

Link copied to clipboard
inline suspend fun SmsClient.terminateApp(crossinline block: TerminateAppRequest.Builder.() -> Unit): TerminateAppResponse

Terminates the stack for the specified application.

Link copied to clipboard
inline suspend fun SmsClient.updateApp(crossinline block: UpdateAppRequest.Builder.() -> Unit): UpdateAppResponse

Updates the specified application.

Link copied to clipboard
inline suspend fun SmsClient.updateReplicationJob(crossinline block: UpdateReplicationJobRequest.Builder.() -> Unit): UpdateReplicationJobResponse

Updates the specified settings for the specified replication job.

Link copied to clipboard
fun SmsClient.withConfig(block: SmsClient.Config.Builder.() -> Unit): SmsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.