sms/aws.sdk.kotlin.services.sms

Package-level declarations

Types

SmsClient

interface ~~SmsClient~~ : SdkClient

Product update

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createApp

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.

createReplicationJob

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

deleteApp

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.

deleteAppLaunchConfiguration

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

Deletes the launch configuration for the specified application.

deleteAppReplicationConfiguration

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

Deletes the replication configuration for the specified application.

deleteAppValidationConfiguration

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

Deletes the validation configuration for the specified application.

deleteReplicationJob

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

Deletes the specified replication job.

deleteServerCatalog

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

Deletes all servers from your server catalog.

disassociateConnector

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

Disassociates the specified connector from Server Migration Service.

generateChangeSet

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.

generateTemplate

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.

getApp

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

Retrieve information about the specified application.

getAppLaunchConfiguration

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

Retrieves the application launch configuration associated with the specified application.

getAppReplicationConfiguration

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

Retrieves the application replication configuration associated with the specified application.

getAppValidationConfiguration

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

Retrieves information about a configuration for validating an application.

getAppValidationOutput

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

Retrieves output from validating an application.

getConnectors

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

Describes the connectors registered with the Server Migration Service.

getReplicationJobs

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

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

getReplicationRuns

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

Describes the replication runs for the specified replication job.

getServers

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

Describes the servers in your server catalog.

importAppCatalog

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

Allows application import from Migration Hub.

importServerCatalog

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.

launchApp

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

Launches the specified application as a stack in CloudFormation.

listApps

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

Retrieves summaries for all applications.

notifyAppValidationOutput

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

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

putAppLaunchConfiguration

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

Creates or updates the launch configuration for the specified application.

putAppReplicationConfiguration

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

Creates or updates the replication configuration for the specified application.

putAppValidationConfiguration

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

Creates or updates a validation configuration for the specified application.

startAppReplication

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.

startOnDemandAppReplication

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

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

startOnDemandReplicationRun

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.

stopAppReplication

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.

terminateApp

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

Terminates the stack for the specified application.

updateApp

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

Updates the specified application.

updateReplicationJob

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

Updates the specified settings for the specified replication job.

withConfig

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.