- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SMSClient
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:
Installation
npm install @aws-sdk/client-sms
yarn add @aws-sdk/client-sms
pnpm add @aws-sdk/client-sms
SMSClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateAppCommand | Creates an application. An application consists of one or more server groups. Each server group contain one or more servers. |
CreateReplicationJobCommand | 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). |
DeleteAppCommand | 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. |
DeleteAppLaunchConfigurationCommand | Deletes the launch configuration for the specified application. |
DeleteAppReplicationConfigurationCommand | Deletes the replication configuration for the specified application. |
DeleteAppValidationConfigurationCommand | Deletes the validation configuration for the specified application. |
DeleteReplicationJobCommand | Deletes the specified replication job. After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted. |
DeleteServerCatalogCommand | Deletes all servers from your server catalog. |
DisassociateConnectorCommand | Disassociates the specified connector from Server Migration Service. After you disassociate a connector, it is no longer available to support replication jobs. |
GenerateChangeSetCommand | 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. |
GenerateTemplateCommand | 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. |
GetAppCommand | Retrieve information about the specified application. |
GetAppLaunchConfigurationCommand | Retrieves the application launch configuration associated with the specified application. |
GetAppReplicationConfigurationCommand | Retrieves the application replication configuration associated with the specified application. |
GetAppValidationConfigurationCommand | Retrieves information about a configuration for validating an application. |
GetAppValidationOutputCommand | Retrieves output from validating an application. |
GetConnectorsCommand | Describes the connectors registered with the Server Migration Service. |
GetReplicationJobsCommand | Describes the specified replication job or all of your replication jobs. |
GetReplicationRunsCommand | Describes the replication runs for the specified replication job. |
GetServersCommand | Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog. |
ImportAppCatalogCommand | Allows application import from Migration Hub. |
ImportServerCatalogCommand | 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. |
LaunchAppCommand | Launches the specified application as a stack in CloudFormation. |
ListAppsCommand | Retrieves summaries for all applications. |
NotifyAppValidationOutputCommand | Provides information to Server Migration Service about whether application validation is successful. |
PutAppLaunchConfigurationCommand | Creates or updates the launch configuration for the specified application. |
PutAppReplicationConfigurationCommand | Creates or updates the replication configuration for the specified application. |
PutAppValidationConfigurationCommand | Creates or updates a validation configuration for the specified application. |
StartAppReplicationCommand | Starts replicating the specified application by creating replication jobs for each server in the application. |
StartOnDemandAppReplicationCommand | Starts an on-demand replication run for the specified application. |
StartOnDemandReplicationRunCommand | 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. |
StopAppReplicationCommand | Stops replicating the specified application by deleting the replication job for each server in the application. |
TerminateAppCommand | Terminates the stack for the specified application. |
UpdateAppCommand | Updates the specified application. |
UpdateReplicationJobCommand | Updates the specified settings for the specified replication job. |
SMSClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SMSClientConfig