Implementation for accessing ServerMigrationService
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:
Inheritance Hierarchy
Amazon.Runtime.AmazonServiceClient
Amazon.ServerMigrationService.AmazonServerMigrationServiceClient
Namespace: Amazon.ServerMigrationService
Assembly: AWSSDK.ServerMigrationService.dll
Version: 3.x.y.z
Syntax
public class AmazonServerMigrationServiceClient : AmazonServiceClient IAmazonServerMigrationService, IAmazonService, IDisposable
The AmazonServerMigrationServiceClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonServerMigrationServiceClient() |
Constructs AmazonServerMigrationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonServerMigrationServiceClient(RegionEndpoint) |
Constructs AmazonServerMigrationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonServerMigrationServiceClient(AmazonServerMigrationServiceConfig) |
Constructs AmazonServerMigrationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonServerMigrationServiceClient(AWSCredentials) |
Constructs AmazonServerMigrationServiceClient with AWS Credentials |
|
|
AmazonServerMigrationServiceClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonServerMigrationServiceClient with AWS Credentials |
|
|
AmazonServerMigrationServiceClient(AWSCredentials, AmazonServerMigrationServiceConfig) |
Constructs AmazonServerMigrationServiceClient with AWS Credentials and an AmazonServerMigrationServiceClient Configuration object. |
|
|
AmazonServerMigrationServiceClient(string, string) |
Constructs AmazonServerMigrationServiceClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonServerMigrationServiceClient(string, string, RegionEndpoint) |
Constructs AmazonServerMigrationServiceClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonServerMigrationServiceClient(string, string, AmazonServerMigrationServiceConfig) |
Constructs AmazonServerMigrationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonServerMigrationServiceClient Configuration object. |
|
|
AmazonServerMigrationServiceClient(string, string, string) |
Constructs AmazonServerMigrationServiceClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonServerMigrationServiceClient(string, string, string, RegionEndpoint) |
Constructs AmazonServerMigrationServiceClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonServerMigrationServiceClient(string, string, string, AmazonServerMigrationServiceConfig) |
Constructs AmazonServerMigrationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonServerMigrationServiceClient Configuration object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
Paginators | Amazon.ServerMigrationService.Model.IServerMigrationServicePaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
CreateApp(CreateAppRequest) |
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers. |
|
|
CreateAppAsync(CreateAppRequest, CancellationToken) |
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers. |
|
|
CreateReplicationJob(CreateReplicationJobRequest) |
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). |
|
|
CreateReplicationJobAsync(CreateReplicationJobRequest, CancellationToken) |
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(DeleteAppRequest) |
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. |
|
|
DeleteAppAsync(DeleteAppRequest, CancellationToken) |
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(DeleteAppLaunchConfigurationRequest) |
Deletes the launch configuration for the specified application. |
|
|
DeleteAppLaunchConfigurationAsync(DeleteAppLaunchConfigurationRequest, CancellationToken) |
Deletes the launch configuration for the specified application. |
|
|
DeleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest) |
Deletes the replication configuration for the specified application. |
|
|
DeleteAppReplicationConfigurationAsync(DeleteAppReplicationConfigurationRequest, CancellationToken) |
Deletes the replication configuration for the specified application. |
|
|
DeleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest) |
Deletes the validation configuration for the specified application. |
|
|
DeleteAppValidationConfigurationAsync(DeleteAppValidationConfigurationRequest, CancellationToken) |
Deletes the validation configuration for the specified application. |
|
|
DeleteReplicationJob(DeleteReplicationJobRequest) |
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. |
|
|
DeleteReplicationJobAsync(DeleteReplicationJobRequest, CancellationToken) |
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. |
|
|
DeleteServerCatalog(DeleteServerCatalogRequest) |
Deletes all servers from your server catalog. |
|
|
DeleteServerCatalogAsync(DeleteServerCatalogRequest, CancellationToken) |
Deletes all servers from your server catalog. |
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
DisassociateConnector(DisassociateConnectorRequest) |
Disassociates the specified connector from Server Migration Service. After you disassociate a connector, it is no longer available to support replication jobs. |
|
|
DisassociateConnectorAsync(DisassociateConnectorRequest, CancellationToken) |
Disassociates the specified connector from Server Migration Service. After you disassociate a connector, it is no longer available to support replication jobs. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GenerateChangeSet(GenerateChangeSetRequest) |
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. |
|
|
GenerateChangeSetAsync(GenerateChangeSetRequest, CancellationToken) |
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(GenerateTemplateRequest) |
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. |
|
|
GenerateTemplateAsync(GenerateTemplateRequest, CancellationToken) |
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(GetAppRequest) |
Retrieve information about the specified application. |
|
|
GetAppAsync(GetAppRequest, CancellationToken) |
Retrieve information about the specified application. |
|
|
GetAppLaunchConfiguration(GetAppLaunchConfigurationRequest) |
Retrieves the application launch configuration associated with the specified application. |
|
|
GetAppLaunchConfigurationAsync(GetAppLaunchConfigurationRequest, CancellationToken) |
Retrieves the application launch configuration associated with the specified application. |
|
|
GetAppReplicationConfiguration(GetAppReplicationConfigurationRequest) |
Retrieves the application replication configuration associated with the specified application. |
|
|
GetAppReplicationConfigurationAsync(GetAppReplicationConfigurationRequest, CancellationToken) |
Retrieves the application replication configuration associated with the specified application. |
|
|
GetAppValidationConfiguration(GetAppValidationConfigurationRequest) |
Retrieves information about a configuration for validating an application. |
|
|
GetAppValidationConfigurationAsync(GetAppValidationConfigurationRequest, CancellationToken) |
Retrieves information about a configuration for validating an application. |
|
|
GetAppValidationOutput(GetAppValidationOutputRequest) |
Retrieves output from validating an application. |
|
|
GetAppValidationOutputAsync(GetAppValidationOutputRequest, CancellationToken) |
Retrieves output from validating an application. |
|
|
GetConnectors(GetConnectorsRequest) |
Describes the connectors registered with the Server Migration Service. |
|
|
GetConnectorsAsync(GetConnectorsRequest, CancellationToken) |
Describes the connectors registered with the Server Migration Service. |
|
|
GetReplicationJobs(GetReplicationJobsRequest) |
Describes the specified replication job or all of your replication jobs. |
|
|
GetReplicationJobsAsync(GetReplicationJobsRequest, CancellationToken) |
Describes the specified replication job or all of your replication jobs. |
|
|
GetReplicationRuns(GetReplicationRunsRequest) |
Describes the replication runs for the specified replication job. |
|
|
GetReplicationRunsAsync(GetReplicationRunsRequest, CancellationToken) |
Describes the replication runs for the specified replication job. |
|
|
GetServers(GetServersRequest) |
Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog. |
|
|
GetServersAsync(GetServersRequest, CancellationToken) |
Describes the servers in your server catalog. Before you can describe your servers, you must import them using ImportServerCatalog. |
|
|
ImportAppCatalog(ImportAppCatalogRequest) |
Allows application import from Migration Hub. |
|
|
ImportAppCatalogAsync(ImportAppCatalogRequest, CancellationToken) |
Allows application import from Migration Hub. |
|
|
ImportServerCatalog(ImportServerCatalogRequest) |
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. |
|
|
ImportServerCatalogAsync(ImportServerCatalogRequest, CancellationToken) |
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. |
|
|
LaunchApp(LaunchAppRequest) |
Launches the specified application as a stack in CloudFormation. |
|
|
LaunchAppAsync(LaunchAppRequest, CancellationToken) |
Launches the specified application as a stack in CloudFormation. |
|
|
ListApps(ListAppsRequest) |
Retrieves summaries for all applications. |
|
|
ListAppsAsync(ListAppsRequest, CancellationToken) |
Retrieves summaries for all applications. |
|
|
NotifyAppValidationOutput(NotifyAppValidationOutputRequest) |
Provides information to Server Migration Service about whether application validation is successful. |
|
|
NotifyAppValidationOutputAsync(NotifyAppValidationOutputRequest, CancellationToken) |
Provides information to Server Migration Service about whether application validation is successful. |
|
|
PutAppLaunchConfiguration(PutAppLaunchConfigurationRequest) |
Creates or updates the launch configuration for the specified application. |
|
|
PutAppLaunchConfigurationAsync(PutAppLaunchConfigurationRequest, CancellationToken) |
Creates or updates the launch configuration for the specified application. |
|
|
PutAppReplicationConfiguration(PutAppReplicationConfigurationRequest) |
Creates or updates the replication configuration for the specified application. |
|
|
PutAppReplicationConfigurationAsync(PutAppReplicationConfigurationRequest, CancellationToken) |
Creates or updates the replication configuration for the specified application. |
|
|
PutAppValidationConfiguration(PutAppValidationConfigurationRequest) |
Creates or updates a validation configuration for the specified application. |
|
|
PutAppValidationConfigurationAsync(PutAppValidationConfigurationRequest, CancellationToken) |
Creates or updates a validation configuration for the specified application. |
|
|
StartAppReplication(StartAppReplicationRequest) |
Starts replicating the specified application by creating replication jobs for each server in the application. |
|
|
StartAppReplicationAsync(StartAppReplicationRequest, CancellationToken) |
Starts replicating the specified application by creating replication jobs for each server in the application. |
|
|
StartOnDemandAppReplication(StartOnDemandAppReplicationRequest) |
Starts an on-demand replication run for the specified application. |
|
|
StartOnDemandAppReplicationAsync(StartOnDemandAppReplicationRequest, CancellationToken) |
Starts an on-demand replication run for the specified application. |
|
|
StartOnDemandReplicationRun(StartOnDemandReplicationRunRequest) |
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. |
|
|
StartOnDemandReplicationRunAsync(StartOnDemandReplicationRunRequest, CancellationToken) |
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. |
|
|
StopAppReplication(StopAppReplicationRequest) |
Stops replicating the specified application by deleting the replication job for each server in the application. |
|
|
StopAppReplicationAsync(StopAppReplicationRequest, CancellationToken) |
Stops replicating the specified application by deleting the replication job for each server in the application. |
|
|
TerminateApp(TerminateAppRequest) |
Terminates the stack for the specified application. |
|
|
TerminateAppAsync(TerminateAppRequest, CancellationToken) |
Terminates the stack for the specified application. |
|
|
UpdateApp(UpdateAppRequest) |
Updates the specified application. |
|
|
UpdateAppAsync(UpdateAppRequest, CancellationToken) |
Updates the specified application. |
|
|
UpdateReplicationJob(UpdateReplicationJobRequest) |
Updates the specified settings for the specified replication job. |
|
|
UpdateReplicationJobAsync(UpdateReplicationJobRequest, CancellationToken) |
Updates the specified settings for the specified replication job. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5