SmsClient Class

Member Function Documentation

SmsClient::SmsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a SmsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

SmsClient::SmsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads SmsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateReplicationJobResponse *SmsClient::createReplicationJob(const CreateReplicationJobRequest &request)

Sends request to the SmsClient service, and returns a pointer to an CreateReplicationJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteReplicationJobResponse *SmsClient::deleteReplicationJob(const DeleteReplicationJobRequest &request)

Sends request to the SmsClient service, and returns a pointer to an DeleteReplicationJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteServerCatalogResponse *SmsClient::deleteServerCatalog(const DeleteServerCatalogRequest &request)

Sends request to the SmsClient service, and returns a pointer to an DeleteServerCatalogResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be

[slot] DisassociateConnectorResponse *SmsClient::disassociateConnector(const DisassociateConnectorRequest &request)

Sends request to the SmsClient service, and returns a pointer to an DisassociateConnectorResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable

[slot] GetConnectorsResponse *SmsClient::getConnectors(const GetConnectorsRequest &request)

Sends request to the SmsClient service, and returns a pointer to an GetConnectorsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

[slot] GetReplicationJobsResponse *SmsClient::getReplicationJobs(const GetReplicationJobsRequest &request)

Sends request to the SmsClient service, and returns a pointer to an GetReplicationJobsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list,

[slot] GetReplicationRunsResponse *SmsClient::getReplicationRuns(const GetReplicationRunsRequest &request)

Sends request to the SmsClient service, and returns a pointer to an GetReplicationRunsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated

[slot] GetServersResponse *SmsClient::getServers(const GetServersRequest &request)

Sends request to the SmsClient service, and returns a pointer to an GetServersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ImportServerCatalogResponse *SmsClient::importServerCatalog(const ImportServerCatalogRequest &request)

Sends request to the SmsClient service, and returns a pointer to an ImportServerCatalogResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] StartOnDemandReplicationRunResponse *SmsClient::startOnDemandReplicationRun(const StartOnDemandReplicationRunRequest &request)

Sends request to the SmsClient service, and returns a pointer to an StartOnDemandReplicationRunResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateReplicationJobResponse *SmsClient::updateReplicationJob(const UpdateReplicationJobRequest &request)

Sends request to the SmsClient service, and returns a pointer to an UpdateReplicationJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using