Amazon Web Services, Inc.

AWS Server Migration Service

Product update We recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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: Server Migration Service product page Server Migration Service User Guide

Endpoints 35

  • POSTCreateApp/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.CreateAppCreates an application. An application consists of one or more server groups. Each server group contain one or more servers.
  • POSTCreateReplicationJob/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.CreateReplicationJobCreates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run…
  • POSTDeleteApp/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.DeleteAppDeletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for…
  • POSTDeleteAppLaunchConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.DeleteAppLaunchConfigurationDeletes the launch configuration for the specified application.
  • POSTDeleteAppReplicationConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.DeleteAppReplicationConfigurationDeletes the replication configuration for the specified application.
  • POSTDeleteAppValidationConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.DeleteAppValidationConfigurationDeletes the validation configuration for the specified application.
  • POSTDeleteReplicationJob/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.DeleteReplicationJob<p>Deletes the specified replication job.</p> <p>After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the…
  • POSTDeleteServerCatalog/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.DeleteServerCatalogDeletes all servers from your server catalog.
  • POSTDisassociateConnector/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.DisassociateConnector<p>Disassociates the specified connector from Server Migration Service.</p> <p>After you disassociate a connector, it is no longer available to support…
  • POSTGenerateChangeSet/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GenerateChangeSetGenerates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
  • POSTGenerateTemplate/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GenerateTemplateGenerates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
  • POSTGetApp/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetAppRetrieve information about the specified application.
  • POSTGetAppLaunchConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetAppLaunchConfigurationRetrieves the application launch configuration associated with the specified application.
  • POSTGetAppReplicationConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetAppReplicationConfigurationRetrieves the application replication configuration associated with the specified application.
  • POSTGetAppValidationConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetAppValidationConfigurationRetrieves information about a configuration for validating an application.
  • POSTGetAppValidationOutput/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetAppValidationOutputRetrieves output from validating an application.
  • POSTGetConnectors/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetConnectors?maxResults=string&nextToken=stringDescribes the connectors registered with the Server Migration Service.
  • POSTGetReplicationJobs/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetReplicationJobs?maxResults=string&nextToken=stringDescribes the specified replication job or all of your replication jobs.
  • POSTGetReplicationRuns/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetReplicationRuns?maxResults=string&nextToken=stringDescribes the replication runs for the specified replication job.
  • POSTGetServers/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.GetServers?maxResults=string&nextToken=string<p>Describes the servers in your server catalog.</p> <p>Before you can describe your servers, you must import them using <a>ImportServerCatalog</a>.</p>
  • POSTImportAppCatalog/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.ImportAppCatalogAllows application import from Migration Hub.
  • POSTImportServerCatalog/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.ImportServerCatalog<p>Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.</p> <p>This call returns immediately,…
  • POSTLaunchApp/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.LaunchAppLaunches the specified application as a stack in CloudFormation.
  • POSTListApps/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.ListAppsRetrieves summaries for all applications.
  • POSTNotifyAppValidationOutput/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.NotifyAppValidationOutputProvides information to Server Migration Service about whether application validation is successful.
  • POSTPutAppLaunchConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.PutAppLaunchConfigurationCreates or updates the launch configuration for the specified application.
  • POSTPutAppReplicationConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.PutAppReplicationConfigurationCreates or updates the replication configuration for the specified application.
  • POSTPutAppValidationConfiguration/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.PutAppValidationConfigurationCreates or updates a validation configuration for the specified application.
  • POSTStartAppReplication/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.StartAppReplicationStarts replicating the specified application by creating replication jobs for each server in the application.
  • POSTStartOnDemandAppReplication/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.StartOnDemandAppReplicationStarts an on-demand replication run for the specified application.
  • POSTStartOnDemandReplicationRun/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.StartOnDemandReplicationRun<p>Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the…
  • POSTStopAppReplication/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.StopAppReplicationStops replicating the specified application by deleting the replication job for each server in the application.
  • POSTTerminateApp/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.TerminateAppTerminates the stack for the specified application.
  • POSTUpdateApp/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.UpdateAppUpdates the specified application.
  • POSTUpdateReplicationJob/#X-Amz-Target=AWSServerMigrationService_V2016_10_24.UpdateReplicationJobUpdates the specified settings for the specified replication job.

API details

Base URL
http://sms.{region}.amazonaws.com
https://sms.{region}.amazonaws.com
http://sms.{region}.amazonaws.com.cn
https://sms.{region}.amazonaws.com.cn
Authentication
An API key in the Authorization header
Operations
35 operations on 35 pathsPOST 35
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2016-10-24
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the AWS Server Migration Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Server Migration Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “CreateApp” (POST /#X-Amz-Target=AWSServerMigrationService_V2016_10_24.CreateApp), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Server Migration Service?

Product update We recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift… It is listed under Developer tools and has 35 endpoints.

Who publishes the AWS Server Migration Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Server Migration Service?

Its description lists 4 base URLs: http://sms.{region}.amazonaws.com, https://sms.{region}.amazonaws.com, http://sms.{region}.amazonaws.com.cn, https://sms.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the AWS Server Migration Service?

With an API key in the Authorization header.

How many endpoints does the AWS Server Migration Service have?

35 operations on 35 paths (35 POST).

Is forking the AWS Server Migration Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.