AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing ServerMigrationService Amazon Server Migration Service automates the process of migrating servers to EC2.

Inheritance Hierarchy

Amazon.ServerMigrationService.IAmazonServerMigrationService

Namespace: Amazon.ServerMigrationService
Assembly: AWSSDK.ServerMigrationService.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonServerMigrationService
         IAmazonService, IDisposable

The IAmazonServerMigrationService type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateReplicationJob(CreateReplicationJobRequest)

The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI.

Public Method CreateReplicationJobAsync(CreateReplicationJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateReplicationJob operation.

Public Method DeleteReplicationJob(DeleteReplicationJobRequest)

The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service.

Public Method DeleteReplicationJobAsync(DeleteReplicationJobRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteReplicationJob operation.

Public Method DeleteServerCatalog(DeleteServerCatalogRequest)

The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service.

Public Method DeleteServerCatalogAsync(DeleteServerCatalogRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteServerCatalog operation.

Public Method DisassociateConnector(DisassociateConnectorRequest)

The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs.

Public Method DisassociateConnectorAsync(DisassociateConnectorRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateConnector operation.

Public Method GetConnectors(GetConnectorsRequest)

The GetConnectors API returns a list of connectors that are registered with the Server Migration Service.

Public Method GetConnectorsAsync(GetConnectorsRequest, CancellationToken)

Initiates the asynchronous execution of the GetConnectors operation.

Public Method GetReplicationJobs(GetReplicationJobsRequest)

The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs.

Public Method GetReplicationJobsAsync(GetReplicationJobsRequest, CancellationToken)

Initiates the asynchronous execution of the GetReplicationJobs operation.

Public Method GetReplicationRuns(GetReplicationRunsRequest)

The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob.

Public Method GetReplicationRunsAsync(GetReplicationRunsRequest, CancellationToken)

Initiates the asynchronous execution of the GetReplicationRuns operation.

Public Method GetServers(GetServersRequest)

The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog.

Public Method GetServersAsync(GetServersRequest, CancellationToken)

Initiates the asynchronous execution of the GetServers operation.

Public Method ImportServerCatalog(ImportServerCatalogRequest)

The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of the servers.

Public Method ImportServerCatalogAsync(ImportServerCatalogRequest, CancellationToken)

Initiates the asynchronous execution of the ImportServerCatalog operation.

Public Method StartOnDemandReplicationRun(StartOnDemandReplicationRunRequest)

The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 24-hour period.

Public Method StartOnDemandReplicationRunAsync(StartOnDemandReplicationRunRequest, CancellationToken)

Initiates the asynchronous execution of the StartOnDemandReplicationRun operation.

Public Method UpdateReplicationJob(UpdateReplicationJobRequest)

The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun.

Public Method UpdateReplicationJobAsync(UpdateReplicationJobRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateReplicationJob operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms