SMS
public struct SMS
Client object for interacting with AWS SMS service.
AWS Server Migration Service AWS Server Migration Service (AWS SMS) makes it easier and faster for you to migrate your on-premises workloads to AWS. To learn more about AWS SMS, see the following resources: AWS Server Migration Service product page AWS Server Migration Service User Guide
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the SMS client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
Declaration
Swift
public func createApp(_ input: CreateAppRequest) -> EventLoopFuture<CreateAppResponse>
-
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).
Declaration
Swift
public func createReplicationJob(_ input: CreateReplicationJobRequest) -> EventLoopFuture<CreateReplicationJobResponse>
-
Deletes the specified application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.
Declaration
Swift
public func deleteApp(_ input: DeleteAppRequest) -> EventLoopFuture<DeleteAppResponse>
-
Deletes the launch configuration for the specified application.
Declaration
Swift
public func deleteAppLaunchConfiguration(_ input: DeleteAppLaunchConfigurationRequest) -> EventLoopFuture<DeleteAppLaunchConfigurationResponse>
-
Deletes the replication configuration for the specified application.
Declaration
Swift
public func deleteAppReplicationConfiguration(_ input: DeleteAppReplicationConfigurationRequest) -> EventLoopFuture<DeleteAppReplicationConfigurationResponse>
-
Deletes the validation configuration for the specified application.
Declaration
Swift
public func deleteAppValidationConfiguration(_ input: DeleteAppValidationConfigurationRequest) -> EventLoopFuture<DeleteAppValidationConfigurationResponse>
-
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.
Declaration
Swift
public func deleteReplicationJob(_ input: DeleteReplicationJobRequest) -> EventLoopFuture<DeleteReplicationJobResponse>
-
Deletes all servers from your server catalog.
Declaration
Swift
public func deleteServerCatalog(_ input: DeleteServerCatalogRequest) -> EventLoopFuture<DeleteServerCatalogResponse>
-
Disassociates the specified connector from AWS SMS. After you disassociate a connector, it is no longer available to support replication jobs.
Declaration
Swift
public func disassociateConnector(_ input: DisassociateConnectorRequest) -> EventLoopFuture<DisassociateConnectorResponse>
-
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.
Declaration
Swift
public func generateChangeSet(_ input: GenerateChangeSetRequest) -> EventLoopFuture<GenerateChangeSetResponse>
-
Generates an AWS CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
Declaration
Swift
public func generateTemplate(_ input: GenerateTemplateRequest) -> EventLoopFuture<GenerateTemplateResponse>
-
Retrieve information about the specified application.
Declaration
Swift
public func getApp(_ input: GetAppRequest) -> EventLoopFuture<GetAppResponse>
-
Retrieves the application launch configuration associated with the specified application.
Declaration
Swift
public func getAppLaunchConfiguration(_ input: GetAppLaunchConfigurationRequest) -> EventLoopFuture<GetAppLaunchConfigurationResponse>
-
Retrieves the application replication configuration associated with the specified application.
Declaration
Swift
public func getAppReplicationConfiguration(_ input: GetAppReplicationConfigurationRequest) -> EventLoopFuture<GetAppReplicationConfigurationResponse>
-
Retrieves information about a configuration for validating an application.
Declaration
Swift
public func getAppValidationConfiguration(_ input: GetAppValidationConfigurationRequest) -> EventLoopFuture<GetAppValidationConfigurationResponse>
-
Retrieves output from validating an application.
Declaration
Swift
public func getAppValidationOutput(_ input: GetAppValidationOutputRequest) -> EventLoopFuture<GetAppValidationOutputResponse>
-
Describes the connectors registered with the AWS SMS.
Declaration
Swift
public func getConnectors(_ input: GetConnectorsRequest) -> EventLoopFuture<GetConnectorsResponse>
-
Describes the specified replication job or all of your replication jobs.
Declaration
Swift
public func getReplicationJobs(_ input: GetReplicationJobsRequest) -> EventLoopFuture<GetReplicationJobsResponse>
-
Describes the replication runs for the specified replication job.
Declaration
Swift
public func getReplicationRuns(_ input: GetReplicationRunsRequest) -> EventLoopFuture<GetReplicationRunsResponse>
-
Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog.
Declaration
Swift
public func getServers(_ input: GetServersRequest) -> EventLoopFuture<GetServersResponse>
-
Allows application import from AWS Migration Hub.
Declaration
Swift
public func importAppCatalog(_ input: ImportAppCatalogRequest) -> EventLoopFuture<ImportAppCatalogResponse>
-
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.
Declaration
Swift
public func importServerCatalog(_ input: ImportServerCatalogRequest) -> EventLoopFuture<ImportServerCatalogResponse>
-
Launches the specified application as a stack in AWS CloudFormation.
Declaration
Swift
public func launchApp(_ input: LaunchAppRequest) -> EventLoopFuture<LaunchAppResponse>
-
Retrieves summaries for all applications.
Declaration
Swift
public func listApps(_ input: ListAppsRequest) -> EventLoopFuture<ListAppsResponse>
-
Provides information to AWS SMS about whether application validation is successful.
Declaration
Swift
public func notifyAppValidationOutput(_ input: NotifyAppValidationOutputRequest) -> EventLoopFuture<NotifyAppValidationOutputResponse>
-
Creates or updates the launch configuration for the specified application.
Declaration
Swift
public func putAppLaunchConfiguration(_ input: PutAppLaunchConfigurationRequest) -> EventLoopFuture<PutAppLaunchConfigurationResponse>
-
Creates or updates the replication configuration for the specified application.
Declaration
Swift
public func putAppReplicationConfiguration(_ input: PutAppReplicationConfigurationRequest) -> EventLoopFuture<PutAppReplicationConfigurationResponse>
-
Creates or updates a validation configuration for the specified application.
Declaration
Swift
public func putAppValidationConfiguration(_ input: PutAppValidationConfigurationRequest) -> EventLoopFuture<PutAppValidationConfigurationResponse>
-
Starts replicating the specified application by creating replication jobs for each server in the application.
Declaration
Swift
public func startAppReplication(_ input: StartAppReplicationRequest) -> EventLoopFuture<StartAppReplicationResponse>
-
Starts an on-demand replication run for the specified application.
Declaration
Swift
public func startOnDemandAppReplication(_ input: StartOnDemandAppReplicationRequest) -> EventLoopFuture<StartOnDemandAppReplicationResponse>
-
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.
Declaration
Swift
public func startOnDemandReplicationRun(_ input: StartOnDemandReplicationRunRequest) -> EventLoopFuture<StartOnDemandReplicationRunResponse>
-
Stops replicating the specified application by deleting the replication job for each server in the application.
Declaration
Swift
public func stopAppReplication(_ input: StopAppReplicationRequest) -> EventLoopFuture<StopAppReplicationResponse>
-
Terminates the stack for the specified application.
Declaration
Swift
public func terminateApp(_ input: TerminateAppRequest) -> EventLoopFuture<TerminateAppResponse>
-
Updates the specified application.
Declaration
Swift
public func updateApp(_ input: UpdateAppRequest) -> EventLoopFuture<UpdateAppResponse>
-
Updates the specified settings for the specified replication job.
Declaration
Swift
public func updateReplicationJob(_ input: UpdateReplicationJobRequest) -> EventLoopFuture<UpdateReplicationJobResponse>
-
Describes the connectors registered with the AWS SMS.
Declaration
Swift
public func getConnectorsPaginator(_ input: GetConnectorsRequest, onPage: @escaping (GetConnectorsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Describes the specified replication job or all of your replication jobs.
Declaration
Swift
public func getReplicationJobsPaginator(_ input: GetReplicationJobsRequest, onPage: @escaping (GetReplicationJobsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Describes the replication runs for the specified replication job.
Declaration
Swift
public func getReplicationRunsPaginator(_ input: GetReplicationRunsRequest, onPage: @escaping (GetReplicationRunsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog.
Declaration
Swift
public func getServersPaginator(_ input: GetServersRequest, onPage: @escaping (GetServersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct GetConnectorsRequest : AWSShape
extension SMS.GetConnectorsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetReplicationJobsRequest : AWSShape
extension SMS.GetReplicationJobsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetReplicationRunsRequest : AWSShape
extension SMS.GetReplicationRunsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetServersRequest : AWSShape
extension SMS.GetServersRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AppLaunchConfigurationStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AppLaunchStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AppReplicationConfigurationStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AppReplicationStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AppStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AppValidationStrategy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ConnectorCapability : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ConnectorStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum LicenseType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum OutputFormat : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReplicationJobState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReplicationRunState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReplicationRunType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ScriptType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ServerCatalogStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ServerType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ServerValidationStrategy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ValidationStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum VmManagerType : String, CustomStringConvertible, Codable