Package software.amazon.awssdk.services.sms

Interface SMSClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface SMSClient
extends AutoCloseable

Service client for accessing SMS. This can be created using the static builder() method. Amazon Server Migration Service automates the process of migrating servers to EC2.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SMSClientBuilder	builder()	Create a builder that can be used to configure and create a SMSClient.
static SMSClient	create()	Create a SMSClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateReplicationJobResponse	createReplicationJob(CreateReplicationJobRequest createReplicationJobRequest)	The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS.
default DeleteReplicationJobResponse	deleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest)	The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns.
default DeleteServerCatalogResponse	deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest)	The DeleteServerCatalog API clears all servers from your server catalog.
default DisassociateConnectorResponse	disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest)	The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs.
default GetConnectorsResponse	getConnectors(GetConnectorsRequest getConnectorsRequest)	The GetConnectors API returns a list of connectors that are registered with the Server Migration Service.
default GetReplicationJobsResponse	getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest)	The GetReplicationJobs API will return all of your ReplicationJobs and their details.
default GetReplicationRunsResponse	getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest)	The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob.
default GetServersResponse	getServers(GetServersRequest getServersRequest)	The GetServers API returns a list of all servers in your server catalog.
default ImportServerCatalogResponse	importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest)	The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises.
static ServiceMetadata	serviceMetadata()
default StartOnDemandReplicationRunResponse	startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest)	The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency).
default UpdateReplicationJobResponse	updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest)	The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static SMSClient create()

Create a SMSClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SMSClientBuilder builder()

Create a builder that can be used to configure and create a SMSClient.

createReplicationJob

default CreateReplicationJobResponse createReplicationJob(CreateReplicationJobRequest createReplicationJobRequest)
                                                   throws InvalidParameterException,
                                                          MissingRequiredParameterException,
                                                          UnauthorizedOperationException,
                                                          OperationNotPermittedException,
                                                          ServerCannotBeReplicatedException,
                                                          ReplicationJobAlreadyExistsException,
                                                          NoConnectorsAvailableException,
                                                          InternalErrorException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          SMSException

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.

Parameters:

createReplicationJobRequest -

Returns:

Result of the CreateReplicationJob operation returned by the service.

Throws:

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

UnauthorizedOperationException - This user does not have permissions to perform this operation.

OperationNotPermittedException - The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

ServerCannotBeReplicatedException - The provided server cannot be replicated.

ReplicationJobAlreadyExistsException - An active Replication Job already exists for the specified server.

NoConnectorsAvailableException - No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.

InternalErrorException - An internal error has occured.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteReplicationJob

default DeleteReplicationJobResponse deleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest)
                                                   throws InvalidParameterException,
                                                          MissingRequiredParameterException,
                                                          UnauthorizedOperationException,
                                                          OperationNotPermittedException,
                                                          ReplicationJobNotFoundException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          SMSException

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.

Parameters:

deleteReplicationJobRequest -

Returns:

Result of the DeleteReplicationJob operation returned by the service.

Throws:

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

UnauthorizedOperationException - This user does not have permissions to perform this operation.

OperationNotPermittedException - The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

ReplicationJobNotFoundException - The specified Replication Job cannot be found.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteServerCatalog

default DeleteServerCatalogResponse deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest)
                                                 throws UnauthorizedOperationException,
                                                        OperationNotPermittedException,
                                                        InvalidParameterException,
                                                        MissingRequiredParameterException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        SMSException

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.

Parameters:

deleteServerCatalogRequest -

Returns:

Result of the DeleteServerCatalog operation returned by the service.

Throws:

UnauthorizedOperationException - This user does not have permissions to perform this operation.

OperationNotPermittedException - The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

disassociateConnector

default DisassociateConnectorResponse disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest)
                                                     throws MissingRequiredParameterException,
                                                            UnauthorizedOperationException,
                                                            OperationNotPermittedException,
                                                            InvalidParameterException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            SMSException

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

Parameters:

disassociateConnectorRequest -

Returns:

Result of the DisassociateConnector operation returned by the service.

Throws:

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

UnauthorizedOperationException - This user does not have permissions to perform this operation.

OperationNotPermittedException - The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getConnectors

default GetConnectorsResponse getConnectors(GetConnectorsRequest getConnectorsRequest)
                                     throws UnauthorizedOperationException,
                                            SdkBaseException,
                                            SdkClientException,
                                            SMSException

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

Parameters:

getConnectorsRequest -

Returns:

Result of the GetConnectors operation returned by the service.

Throws:

UnauthorizedOperationException - This user does not have permissions to perform this operation.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getReplicationJobs

default GetReplicationJobsResponse getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest)
                                               throws InvalidParameterException,
                                                      MissingRequiredParameterException,
                                                      UnauthorizedOperationException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      SMSException

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.

Parameters:

getReplicationJobsRequest -

Returns:

Result of the GetReplicationJobs operation returned by the service.

Throws:

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

UnauthorizedOperationException - This user does not have permissions to perform this operation.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getReplicationRuns

default GetReplicationRunsResponse getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest)
                                               throws InvalidParameterException,
                                                      MissingRequiredParameterException,
                                                      UnauthorizedOperationException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      SMSException

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.

Parameters:

getReplicationRunsRequest -

Returns:

Result of the GetReplicationRuns operation returned by the service.

Throws:

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

UnauthorizedOperationException - This user does not have permissions to perform this operation.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getServers

default GetServersResponse getServers(GetServersRequest getServersRequest)
                               throws UnauthorizedOperationException,
                                      SdkBaseException,
                                      SdkClientException,
                                      SMSException

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

Parameters:

getServersRequest -

Returns:

Result of the GetServers operation returned by the service.

Throws:

UnauthorizedOperationException - This user does not have permissions to perform this operation.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

importServerCatalog

default ImportServerCatalogResponse importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest)
                                                 throws UnauthorizedOperationException,
                                                        OperationNotPermittedException,
                                                        InvalidParameterException,
                                                        MissingRequiredParameterException,
                                                        NoConnectorsAvailableException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        SMSException

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.

Parameters:

importServerCatalogRequest -

Returns:

Result of the ImportServerCatalog operation returned by the service.

Throws:

UnauthorizedOperationException - This user does not have permissions to perform this operation.

OperationNotPermittedException - The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

NoConnectorsAvailableException - No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

startOnDemandReplicationRun

default StartOnDemandReplicationRunResponse startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest)
                                                                 throws InvalidParameterException,
                                                                        MissingRequiredParameterException,
                                                                        UnauthorizedOperationException,
                                                                        OperationNotPermittedException,
                                                                        ReplicationRunLimitExceededException,
                                                                        SdkBaseException,
                                                                        SdkClientException,
                                                                        SMSException

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.

Parameters:

startOnDemandReplicationRunRequest -

Returns:

Result of the StartOnDemandReplicationRun operation returned by the service.

Throws:

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

UnauthorizedOperationException - This user does not have permissions to perform this operation.

OperationNotPermittedException - The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

ReplicationRunLimitExceededException - This user has exceeded the maximum allowed Replication Run limit.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateReplicationJob

default UpdateReplicationJobResponse updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest)
                                                   throws InvalidParameterException,
                                                          MissingRequiredParameterException,
                                                          OperationNotPermittedException,
                                                          UnauthorizedOperationException,
                                                          ServerCannotBeReplicatedException,
                                                          ReplicationJobNotFoundException,
                                                          InternalErrorException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          SMSException

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.

Parameters:

updateReplicationJobRequest -

Returns:

Result of the UpdateReplicationJob operation returned by the service.

Throws:

InvalidParameterException - A parameter specified in the request is not valid, is unsupported, or cannot be used.

MissingRequiredParameterException - The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

OperationNotPermittedException - The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

UnauthorizedOperationException - This user does not have permissions to perform this operation.

ServerCannotBeReplicatedException - The provided server cannot be replicated.

ReplicationJobNotFoundException - The specified Replication Job cannot be found.

InternalErrorException - An internal error has occured.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

SMSException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()