Expand description
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:
If you’re using the service, you’re probably looking for ServerMigrationServiceClient and ServerMigrationService.
Structs§
- AppSummary
Information about the application.
- Connector
Represents a connector.
- Create
AppRequest - Create
AppResponse - Create
Replication JobRequest - Create
Replication JobResponse - Delete
AppLaunch Configuration Request - Delete
AppLaunch Configuration Response - Delete
AppReplication Configuration Request - Delete
AppReplication Configuration Response - Delete
AppRequest - Delete
AppResponse - Delete
Replication JobRequest - Delete
Replication JobResponse - Delete
Server Catalog Request - Delete
Server Catalog Response - Disassociate
Connector Request - Disassociate
Connector Response - Generate
Change SetRequest - Generate
Change SetResponse - Generate
Template Request - Generate
Template Response - GetApp
Launch Configuration Request - GetApp
Launch Configuration Response - GetApp
Replication Configuration Request - GetApp
Replication Configuration Response - GetApp
Request - GetApp
Response - GetConnectors
Request - GetConnectors
Response - GetReplication
Jobs Request - GetReplication
Jobs Response - GetReplication
Runs Request - GetReplication
Runs Response - GetServers
Request - GetServers
Response - Import
Server Catalog Request - Import
Server Catalog Response - Launch
AppRequest - Launch
AppResponse - Launch
Details Details about the latest launch of an application.
- List
Apps Request - List
Apps Response - PutApp
Launch Configuration Request - PutApp
Launch Configuration Response - PutApp
Replication Configuration Request - PutApp
Replication Configuration Response - Replication
Job Represents a replication job.
- Replication
Run Represents a replication run.
- Replication
RunStage Details Details of the current stage of a replication run.
- S3Location
Location of the Amazon S3 object in the customer's account.
- Server
Represents a server.
- Server
Group A logical grouping of servers.
- Server
Group Launch Configuration Launch configuration for a server group.
- Server
Group Replication Configuration Replication configuration for a server group.
- Server
Launch Configuration Launch configuration for a server.
- Server
Migration Service Client - A client for the SMS API.
- Server
Replication Configuration Replication configuration of a server.
- Server
Replication Parameters Replication parameters for replicating a server.
- Start
AppReplication Request - Start
AppReplication Response - Start
OnDemand Replication RunRequest - Start
OnDemand Replication RunResponse - Stop
AppReplication Request - Stop
AppReplication Response - Tag
A label that can be assigned to an application.
- Terminate
AppRequest - Terminate
AppResponse - Update
AppRequest - Update
AppResponse - Update
Replication JobRequest - Update
Replication JobResponse - User
Data A script that runs on first launch of an Amazon EC2 instance. Used for configuring the server during launch.
- VmServer
Represents a VM server.
- VmServer
Address Represents a VM server location.
Enums§
- Create
AppError - Errors returned by CreateApp
- Create
Replication JobError - Errors returned by CreateReplicationJob
- Delete
AppError - Errors returned by DeleteApp
- Delete
AppLaunch Configuration Error - Errors returned by DeleteAppLaunchConfiguration
- Delete
AppReplication Configuration Error - Errors returned by DeleteAppReplicationConfiguration
- Delete
Replication JobError - Errors returned by DeleteReplicationJob
- Delete
Server Catalog Error - Errors returned by DeleteServerCatalog
- Disassociate
Connector Error - Errors returned by DisassociateConnector
- Generate
Change SetError - Errors returned by GenerateChangeSet
- Generate
Template Error - Errors returned by GenerateTemplate
- GetApp
Error - Errors returned by GetApp
- GetApp
Launch Configuration Error - Errors returned by GetAppLaunchConfiguration
- GetApp
Replication Configuration Error - Errors returned by GetAppReplicationConfiguration
- GetConnectors
Error - Errors returned by GetConnectors
- GetReplication
Jobs Error - Errors returned by GetReplicationJobs
- GetReplication
Runs Error - Errors returned by GetReplicationRuns
- GetServers
Error - Errors returned by GetServers
- Import
Server Catalog Error - Errors returned by ImportServerCatalog
- Launch
AppError - Errors returned by LaunchApp
- List
Apps Error - Errors returned by ListApps
- PutApp
Launch Configuration Error - Errors returned by PutAppLaunchConfiguration
- PutApp
Replication Configuration Error - Errors returned by PutAppReplicationConfiguration
- Start
AppReplication Error - Errors returned by StartAppReplication
- Start
OnDemand Replication RunError - Errors returned by StartOnDemandReplicationRun
- Stop
AppReplication Error - Errors returned by StopAppReplication
- Terminate
AppError - Errors returned by TerminateApp
- Update
AppError - Errors returned by UpdateApp
- Update
Replication JobError - Errors returned by UpdateReplicationJob
Traits§
- Server
Migration Service - Trait representing the capabilities of the SMS API. SMS clients implement this trait.