Interface SmsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The
asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the
SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such
as credentials retrieval and endpoint discovery as part of the async API call.
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SmsAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSmsAsyncClient
.static SmsAsyncClient
create()
Create aSmsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAppResponse> createApp
(Consumer<CreateAppRequest.Builder> createAppRequest) Creates an application.default CompletableFuture
<CreateAppResponse> createApp
(CreateAppRequest createAppRequest) Creates an application.createReplicationJob
(Consumer<CreateReplicationJobRequest.Builder> createReplicationJobRequest) Creates a replication job.createReplicationJob
(CreateReplicationJobRequest createReplicationJobRequest) Creates a replication job.default CompletableFuture
<DeleteAppResponse> deleteApp
(Consumer<DeleteAppRequest.Builder> deleteAppRequest) Deletes the specified application.default CompletableFuture
<DeleteAppResponse> deleteApp
(DeleteAppRequest deleteAppRequest) Deletes the specified application.deleteAppLaunchConfiguration
(Consumer<DeleteAppLaunchConfigurationRequest.Builder> deleteAppLaunchConfigurationRequest) Deletes the launch configuration for the specified application.deleteAppLaunchConfiguration
(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest) Deletes the launch configuration for the specified application.deleteAppReplicationConfiguration
(Consumer<DeleteAppReplicationConfigurationRequest.Builder> deleteAppReplicationConfigurationRequest) Deletes the replication configuration for the specified application.deleteAppReplicationConfiguration
(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest) Deletes the replication configuration for the specified application.deleteAppValidationConfiguration
(Consumer<DeleteAppValidationConfigurationRequest.Builder> deleteAppValidationConfigurationRequest) Deletes the validation configuration for the specified application.deleteAppValidationConfiguration
(DeleteAppValidationConfigurationRequest deleteAppValidationConfigurationRequest) Deletes the validation configuration for the specified application.deleteReplicationJob
(Consumer<DeleteReplicationJobRequest.Builder> deleteReplicationJobRequest) Deletes the specified replication job.deleteReplicationJob
(DeleteReplicationJobRequest deleteReplicationJobRequest) Deletes the specified replication job.Deletes all servers from your server catalog.deleteServerCatalog
(Consumer<DeleteServerCatalogRequest.Builder> deleteServerCatalogRequest) Deletes all servers from your server catalog.deleteServerCatalog
(DeleteServerCatalogRequest deleteServerCatalogRequest) Deletes all servers from your server catalog.disassociateConnector
(Consumer<DisassociateConnectorRequest.Builder> disassociateConnectorRequest) Disassociates the specified connector from Server Migration Service.disassociateConnector
(DisassociateConnectorRequest disassociateConnectorRequest) Disassociates the specified connector from Server Migration Service.generateChangeSet
(Consumer<GenerateChangeSetRequest.Builder> 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.generateChangeSet
(GenerateChangeSetRequest 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.generateTemplate
(Consumer<GenerateTemplateRequest.Builder> 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.generateTemplate
(GenerateTemplateRequest 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.default CompletableFuture
<GetAppResponse> getApp()
Retrieve information about the specified application.default CompletableFuture
<GetAppResponse> getApp
(Consumer<GetAppRequest.Builder> getAppRequest) Retrieve information about the specified application.default CompletableFuture
<GetAppResponse> getApp
(GetAppRequest getAppRequest) Retrieve information about the specified application.Retrieves the application launch configuration associated with the specified application.getAppLaunchConfiguration
(Consumer<GetAppLaunchConfigurationRequest.Builder> getAppLaunchConfigurationRequest) Retrieves the application launch configuration associated with the specified application.getAppLaunchConfiguration
(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest) Retrieves the application launch configuration associated with the specified application.Retrieves the application replication configuration associated with the specified application.getAppReplicationConfiguration
(Consumer<GetAppReplicationConfigurationRequest.Builder> getAppReplicationConfigurationRequest) Retrieves the application replication configuration associated with the specified application.getAppReplicationConfiguration
(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest) Retrieves the application replication configuration associated with the specified application.getAppValidationConfiguration
(Consumer<GetAppValidationConfigurationRequest.Builder> getAppValidationConfigurationRequest) Retrieves information about a configuration for validating an application.getAppValidationConfiguration
(GetAppValidationConfigurationRequest getAppValidationConfigurationRequest) Retrieves information about a configuration for validating an application.getAppValidationOutput
(Consumer<GetAppValidationOutputRequest.Builder> getAppValidationOutputRequest) Retrieves output from validating an application.getAppValidationOutput
(GetAppValidationOutputRequest getAppValidationOutputRequest) Retrieves output from validating an application.default CompletableFuture
<GetConnectorsResponse> Describes the connectors registered with the Server Migration Service.default CompletableFuture
<GetConnectorsResponse> getConnectors
(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) Describes the connectors registered with the Server Migration Service.default CompletableFuture
<GetConnectorsResponse> getConnectors
(GetConnectorsRequest getConnectorsRequest) Describes the connectors registered with the Server Migration Service.default GetConnectorsPublisher
This is a variant ofgetConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.default GetConnectorsPublisher
getConnectorsPaginator
(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) This is a variant ofgetConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.default GetConnectorsPublisher
getConnectorsPaginator
(GetConnectorsRequest getConnectorsRequest) This is a variant ofgetConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.Describes the specified replication job or all of your replication jobs.getReplicationJobs
(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest) Describes the specified replication job or all of your replication jobs.getReplicationJobs
(GetReplicationJobsRequest getReplicationJobsRequest) Describes the specified replication job or all of your replication jobs.default GetReplicationJobsPublisher
This is a variant ofgetReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.default GetReplicationJobsPublisher
getReplicationJobsPaginator
(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest) This is a variant ofgetReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.default GetReplicationJobsPublisher
getReplicationJobsPaginator
(GetReplicationJobsRequest getReplicationJobsRequest) This is a variant ofgetReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.getReplicationRuns
(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest) Describes the replication runs for the specified replication job.getReplicationRuns
(GetReplicationRunsRequest getReplicationRunsRequest) Describes the replication runs for the specified replication job.default GetReplicationRunsPublisher
getReplicationRunsPaginator
(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest) This is a variant ofgetReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation.default GetReplicationRunsPublisher
getReplicationRunsPaginator
(GetReplicationRunsRequest getReplicationRunsRequest) This is a variant ofgetReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation.default CompletableFuture
<GetServersResponse> Describes the servers in your server catalog.default CompletableFuture
<GetServersResponse> getServers
(Consumer<GetServersRequest.Builder> getServersRequest) Describes the servers in your server catalog.default CompletableFuture
<GetServersResponse> getServers
(GetServersRequest getServersRequest) Describes the servers in your server catalog.default GetServersPublisher
This is a variant ofgetServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.default GetServersPublisher
getServersPaginator
(Consumer<GetServersRequest.Builder> getServersRequest) This is a variant ofgetServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.default GetServersPublisher
getServersPaginator
(GetServersRequest getServersRequest) This is a variant ofgetServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.importAppCatalog
(Consumer<ImportAppCatalogRequest.Builder> importAppCatalogRequest) Allows application import from Migration Hub.importAppCatalog
(ImportAppCatalogRequest importAppCatalogRequest) Allows application import from Migration Hub.Gathers a complete list of on-premises servers.importServerCatalog
(Consumer<ImportServerCatalogRequest.Builder> importServerCatalogRequest) Gathers a complete list of on-premises servers.importServerCatalog
(ImportServerCatalogRequest importServerCatalogRequest) Gathers a complete list of on-premises servers.default CompletableFuture
<LaunchAppResponse> launchApp
(Consumer<LaunchAppRequest.Builder> launchAppRequest) Launches the specified application as a stack in CloudFormation.default CompletableFuture
<LaunchAppResponse> launchApp
(LaunchAppRequest launchAppRequest) Launches the specified application as a stack in CloudFormation.default CompletableFuture
<ListAppsResponse> listApps()
Retrieves summaries for all applications.default CompletableFuture
<ListAppsResponse> listApps
(Consumer<ListAppsRequest.Builder> listAppsRequest) Retrieves summaries for all applications.default CompletableFuture
<ListAppsResponse> listApps
(ListAppsRequest listAppsRequest) Retrieves summaries for all applications.notifyAppValidationOutput
(Consumer<NotifyAppValidationOutputRequest.Builder> notifyAppValidationOutputRequest) Provides information to Server Migration Service about whether application validation is successful.notifyAppValidationOutput
(NotifyAppValidationOutputRequest notifyAppValidationOutputRequest) Provides information to Server Migration Service about whether application validation is successful.putAppLaunchConfiguration
(Consumer<PutAppLaunchConfigurationRequest.Builder> putAppLaunchConfigurationRequest) Creates or updates the launch configuration for the specified application.putAppLaunchConfiguration
(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest) Creates or updates the launch configuration for the specified application.putAppReplicationConfiguration
(Consumer<PutAppReplicationConfigurationRequest.Builder> putAppReplicationConfigurationRequest) Creates or updates the replication configuration for the specified application.putAppReplicationConfiguration
(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest) Creates or updates the replication configuration for the specified application.putAppValidationConfiguration
(Consumer<PutAppValidationConfigurationRequest.Builder> putAppValidationConfigurationRequest) Creates or updates a validation configuration for the specified application.putAppValidationConfiguration
(PutAppValidationConfigurationRequest putAppValidationConfigurationRequest) Creates or updates a validation configuration for the specified application.default SmsServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartAppReplication
(Consumer<StartAppReplicationRequest.Builder> startAppReplicationRequest) Starts replicating the specified application by creating replication jobs for each server in the application.startAppReplication
(StartAppReplicationRequest startAppReplicationRequest) Starts replicating the specified application by creating replication jobs for each server in the application.startOnDemandAppReplication
(Consumer<StartOnDemandAppReplicationRequest.Builder> startOnDemandAppReplicationRequest) Starts an on-demand replication run for the specified application.startOnDemandAppReplication
(StartOnDemandAppReplicationRequest startOnDemandAppReplicationRequest) Starts an on-demand replication run for the specified application.startOnDemandReplicationRun
(Consumer<StartOnDemandReplicationRunRequest.Builder> startOnDemandReplicationRunRequest) Starts an on-demand replication run for the specified replication job.startOnDemandReplicationRun
(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest) Starts an on-demand replication run for the specified replication job.stopAppReplication
(Consumer<StopAppReplicationRequest.Builder> stopAppReplicationRequest) Stops replicating the specified application by deleting the replication job for each server in the application.stopAppReplication
(StopAppReplicationRequest stopAppReplicationRequest) Stops replicating the specified application by deleting the replication job for each server in the application.default CompletableFuture
<TerminateAppResponse> terminateApp
(Consumer<TerminateAppRequest.Builder> terminateAppRequest) Terminates the stack for the specified application.default CompletableFuture
<TerminateAppResponse> terminateApp
(TerminateAppRequest terminateAppRequest) Terminates the stack for the specified application.default CompletableFuture
<UpdateAppResponse> updateApp
(Consumer<UpdateAppRequest.Builder> updateAppRequest) Updates the specified application.default CompletableFuture
<UpdateAppResponse> updateApp
(UpdateAppRequest updateAppRequest) Updates the specified application.updateReplicationJob
(Consumer<UpdateReplicationJobRequest.Builder> updateReplicationJobRequest) Updates the specified settings for the specified replication job.updateReplicationJob
(UpdateReplicationJobRequest updateReplicationJobRequest) Updates the specified settings for the specified replication job.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createApp
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
- Parameters:
createAppRequest
-- Returns:
- A Java Future containing the result of the CreateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApp
default CompletableFuture<CreateAppResponse> createApp(Consumer<CreateAppRequest.Builder> createAppRequest) Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
This is a convenience which creates an instance of the
CreateAppRequest.Builder
avoiding the need to create one manually viaCreateAppRequest.builder()
- Parameters:
createAppRequest
- AConsumer
that will call methods onCreateAppRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReplicationJob
default CompletableFuture<CreateReplicationJobResponse> createReplicationJob(CreateReplicationJobRequest 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).
- Parameters:
createReplicationJobRequest
-- Returns:
- A Java Future containing the result of the CreateReplicationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- ServerCannotBeReplicatedException The specified server cannot be replicated.
- ReplicationJobAlreadyExistsException The specified replication job already exists.
- NoConnectorsAvailableException There are no connectors available.
- InternalErrorException An internal error occurred.
- TemporarilyUnavailableException The service is temporarily unavailable.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createReplicationJob
default CompletableFuture<CreateReplicationJobResponse> createReplicationJob(Consumer<CreateReplicationJobRequest.Builder> 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).
This is a convenience which creates an instance of the
CreateReplicationJobRequest.Builder
avoiding the need to create one manually viaCreateReplicationJobRequest.builder()
- Parameters:
createReplicationJobRequest
- AConsumer
that will call methods onCreateReplicationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateReplicationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- ServerCannotBeReplicatedException The specified server cannot be replicated.
- ReplicationJobAlreadyExistsException The specified replication job already exists.
- NoConnectorsAvailableException There are no connectors available.
- InternalErrorException An internal error occurred.
- TemporarilyUnavailableException The service is temporarily unavailable.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApp
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.
- Parameters:
deleteAppRequest
-- Returns:
- A Java Future containing the result of the DeleteApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApp
default CompletableFuture<DeleteAppResponse> deleteApp(Consumer<DeleteAppRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteAppRequest.Builder
avoiding the need to create one manually viaDeleteAppRequest.builder()
- Parameters:
deleteAppRequest
- AConsumer
that will call methods onDeleteAppRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppLaunchConfiguration
default CompletableFuture<DeleteAppLaunchConfigurationResponse> deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest) Deletes the launch configuration for the specified application.
- Parameters:
deleteAppLaunchConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteAppLaunchConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppLaunchConfiguration
default CompletableFuture<DeleteAppLaunchConfigurationResponse> deleteAppLaunchConfiguration(Consumer<DeleteAppLaunchConfigurationRequest.Builder> deleteAppLaunchConfigurationRequest) Deletes the launch configuration for the specified application.
This is a convenience which creates an instance of the
DeleteAppLaunchConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteAppLaunchConfigurationRequest.builder()
- Parameters:
deleteAppLaunchConfigurationRequest
- AConsumer
that will call methods onDeleteAppLaunchConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppLaunchConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppReplicationConfiguration
default CompletableFuture<DeleteAppReplicationConfigurationResponse> deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest) Deletes the replication configuration for the specified application.
- Parameters:
deleteAppReplicationConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteAppReplicationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppReplicationConfiguration
default CompletableFuture<DeleteAppReplicationConfigurationResponse> deleteAppReplicationConfiguration(Consumer<DeleteAppReplicationConfigurationRequest.Builder> deleteAppReplicationConfigurationRequest) Deletes the replication configuration for the specified application.
This is a convenience which creates an instance of the
DeleteAppReplicationConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteAppReplicationConfigurationRequest.builder()
- Parameters:
deleteAppReplicationConfigurationRequest
- AConsumer
that will call methods onDeleteAppReplicationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppReplicationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppValidationConfiguration
default CompletableFuture<DeleteAppValidationConfigurationResponse> deleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest deleteAppValidationConfigurationRequest) Deletes the validation configuration for the specified application.
- Parameters:
deleteAppValidationConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteAppValidationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAppValidationConfiguration
default CompletableFuture<DeleteAppValidationConfigurationResponse> deleteAppValidationConfiguration(Consumer<DeleteAppValidationConfigurationRequest.Builder> deleteAppValidationConfigurationRequest) Deletes the validation configuration for the specified application.
This is a convenience which creates an instance of the
DeleteAppValidationConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteAppValidationConfigurationRequest.builder()
- Parameters:
deleteAppValidationConfigurationRequest
- AConsumer
that will call methods onDeleteAppValidationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAppValidationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReplicationJob
default CompletableFuture<DeleteReplicationJobResponse> deleteReplicationJob(DeleteReplicationJobRequest 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.
- Parameters:
deleteReplicationJobRequest
-- Returns:
- A Java Future containing the result of the DeleteReplicationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- ReplicationJobNotFoundException The specified replication job does not exist.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReplicationJob
default CompletableFuture<DeleteReplicationJobResponse> deleteReplicationJob(Consumer<DeleteReplicationJobRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteReplicationJobRequest.Builder
avoiding the need to create one manually viaDeleteReplicationJobRequest.builder()
- Parameters:
deleteReplicationJobRequest
- AConsumer
that will call methods onDeleteReplicationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteReplicationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- ReplicationJobNotFoundException The specified replication job does not exist.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteServerCatalog
default CompletableFuture<DeleteServerCatalogResponse> deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest) Deletes all servers from your server catalog.
- Parameters:
deleteServerCatalogRequest
-- Returns:
- A Java Future containing the result of the DeleteServerCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteServerCatalog
default CompletableFuture<DeleteServerCatalogResponse> deleteServerCatalog(Consumer<DeleteServerCatalogRequest.Builder> deleteServerCatalogRequest) Deletes all servers from your server catalog.
This is a convenience which creates an instance of the
DeleteServerCatalogRequest.Builder
avoiding the need to create one manually viaDeleteServerCatalogRequest.builder()
- Parameters:
deleteServerCatalogRequest
- AConsumer
that will call methods onDeleteServerCatalogRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteServerCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteServerCatalog
Deletes all servers from your server catalog.
- Returns:
- A Java Future containing the result of the DeleteServerCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateConnector
default CompletableFuture<DisassociateConnectorResponse> disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest) Disassociates the specified connector from Server Migration Service.
After you disassociate a connector, it is no longer available to support replication jobs.
- Parameters:
disassociateConnectorRequest
-- Returns:
- A Java Future containing the result of the DisassociateConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateConnector
default CompletableFuture<DisassociateConnectorResponse> disassociateConnector(Consumer<DisassociateConnectorRequest.Builder> disassociateConnectorRequest) Disassociates the specified connector from Server Migration Service.
After you disassociate a connector, it is no longer available to support replication jobs.
This is a convenience which creates an instance of the
DisassociateConnectorRequest.Builder
avoiding the need to create one manually viaDisassociateConnectorRequest.builder()
- Parameters:
disassociateConnectorRequest
- AConsumer
that will call methods onDisassociateConnectorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateConnector operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateChangeSet
default CompletableFuture<GenerateChangeSetResponse> generateChangeSet(GenerateChangeSetRequest 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.
- Parameters:
generateChangeSetRequest
-- Returns:
- A Java Future containing the result of the GenerateChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateChangeSet
default CompletableFuture<GenerateChangeSetResponse> generateChangeSet(Consumer<GenerateChangeSetRequest.Builder> 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.
This is a convenience which creates an instance of the
GenerateChangeSetRequest.Builder
avoiding the need to create one manually viaGenerateChangeSetRequest.builder()
- Parameters:
generateChangeSetRequest
- AConsumer
that will call methods onGenerateChangeSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GenerateChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateTemplate
default CompletableFuture<GenerateTemplateResponse> generateTemplate(GenerateTemplateRequest 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.
- Parameters:
generateTemplateRequest
-- Returns:
- A Java Future containing the result of the GenerateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateTemplate
default CompletableFuture<GenerateTemplateResponse> generateTemplate(Consumer<GenerateTemplateRequest.Builder> 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.
This is a convenience which creates an instance of the
GenerateTemplateRequest.Builder
avoiding the need to create one manually viaGenerateTemplateRequest.builder()
- Parameters:
generateTemplateRequest
- AConsumer
that will call methods onGenerateTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GenerateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApp
Retrieve information about the specified application.
- Parameters:
getAppRequest
-- Returns:
- A Java Future containing the result of the GetApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApp
Retrieve information about the specified application.
This is a convenience which creates an instance of the
GetAppRequest.Builder
avoiding the need to create one manually viaGetAppRequest.builder()
- Parameters:
getAppRequest
- AConsumer
that will call methods onGetAppRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApp
Retrieve information about the specified application.
- Returns:
- A Java Future containing the result of the GetApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppLaunchConfiguration
default CompletableFuture<GetAppLaunchConfigurationResponse> getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest) Retrieves the application launch configuration associated with the specified application.
- Parameters:
getAppLaunchConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetAppLaunchConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppLaunchConfiguration
default CompletableFuture<GetAppLaunchConfigurationResponse> getAppLaunchConfiguration(Consumer<GetAppLaunchConfigurationRequest.Builder> getAppLaunchConfigurationRequest) Retrieves the application launch configuration associated with the specified application.
This is a convenience which creates an instance of the
GetAppLaunchConfigurationRequest.Builder
avoiding the need to create one manually viaGetAppLaunchConfigurationRequest.builder()
- Parameters:
getAppLaunchConfigurationRequest
- AConsumer
that will call methods onGetAppLaunchConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAppLaunchConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppLaunchConfiguration
Retrieves the application launch configuration associated with the specified application.
- Returns:
- A Java Future containing the result of the GetAppLaunchConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppReplicationConfiguration
default CompletableFuture<GetAppReplicationConfigurationResponse> getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest) Retrieves the application replication configuration associated with the specified application.
- Parameters:
getAppReplicationConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetAppReplicationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppReplicationConfiguration
default CompletableFuture<GetAppReplicationConfigurationResponse> getAppReplicationConfiguration(Consumer<GetAppReplicationConfigurationRequest.Builder> getAppReplicationConfigurationRequest) Retrieves the application replication configuration associated with the specified application.
This is a convenience which creates an instance of the
GetAppReplicationConfigurationRequest.Builder
avoiding the need to create one manually viaGetAppReplicationConfigurationRequest.builder()
- Parameters:
getAppReplicationConfigurationRequest
- AConsumer
that will call methods onGetAppReplicationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAppReplicationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppReplicationConfiguration
Retrieves the application replication configuration associated with the specified application.
- Returns:
- A Java Future containing the result of the GetAppReplicationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppValidationConfiguration
default CompletableFuture<GetAppValidationConfigurationResponse> getAppValidationConfiguration(GetAppValidationConfigurationRequest getAppValidationConfigurationRequest) Retrieves information about a configuration for validating an application.
- Parameters:
getAppValidationConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetAppValidationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppValidationConfiguration
default CompletableFuture<GetAppValidationConfigurationResponse> getAppValidationConfiguration(Consumer<GetAppValidationConfigurationRequest.Builder> getAppValidationConfigurationRequest) Retrieves information about a configuration for validating an application.
This is a convenience which creates an instance of the
GetAppValidationConfigurationRequest.Builder
avoiding the need to create one manually viaGetAppValidationConfigurationRequest.builder()
- Parameters:
getAppValidationConfigurationRequest
- AConsumer
that will call methods onGetAppValidationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAppValidationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppValidationOutput
default CompletableFuture<GetAppValidationOutputResponse> getAppValidationOutput(GetAppValidationOutputRequest getAppValidationOutputRequest) Retrieves output from validating an application.
- Parameters:
getAppValidationOutputRequest
-- Returns:
- A Java Future containing the result of the GetAppValidationOutput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAppValidationOutput
default CompletableFuture<GetAppValidationOutputResponse> getAppValidationOutput(Consumer<GetAppValidationOutputRequest.Builder> getAppValidationOutputRequest) Retrieves output from validating an application.
This is a convenience which creates an instance of the
GetAppValidationOutputRequest.Builder
avoiding the need to create one manually viaGetAppValidationOutputRequest.builder()
- Parameters:
getAppValidationOutputRequest
- AConsumer
that will call methods onGetAppValidationOutputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAppValidationOutput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectors
default CompletableFuture<GetConnectorsResponse> getConnectors(GetConnectorsRequest getConnectorsRequest) Describes the connectors registered with the Server Migration Service.
- Parameters:
getConnectorsRequest
-- Returns:
- A Java Future containing the result of the GetConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectors
default CompletableFuture<GetConnectorsResponse> getConnectors(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) Describes the connectors registered with the Server Migration Service.
This is a convenience which creates an instance of the
GetConnectorsRequest.Builder
avoiding the need to create one manually viaGetConnectorsRequest.builder()
- Parameters:
getConnectorsRequest
- AConsumer
that will call methods onGetConnectorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectors
Describes the connectors registered with the Server Migration Service.
- Returns:
- A Java Future containing the result of the GetConnectors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectorsPaginator
This is a variant of
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetConnectorsPublisher publisher = client.getConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetConnectorsPublisher publisher = client.getConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetConnectorsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectorsPaginator
This is a variant of
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetConnectorsPublisher publisher = client.getConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetConnectorsPublisher publisher = client.getConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetConnectorsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.- Parameters:
getConnectorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConnectorsPaginator
default GetConnectorsPublisher getConnectorsPaginator(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) This is a variant of
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetConnectorsPublisher publisher = client.getConnectorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetConnectorsPublisher publisher = client.getConnectorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetConnectorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetConnectorsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.
This is a convenience which creates an instance of the
GetConnectorsRequest.Builder
avoiding the need to create one manually viaGetConnectorsRequest.builder()
- Parameters:
getConnectorsRequest
- AConsumer
that will call methods onGetConnectorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationJobs
default CompletableFuture<GetReplicationJobsResponse> getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest) Describes the specified replication job or all of your replication jobs.
- Parameters:
getReplicationJobsRequest
-- Returns:
- A Java Future containing the result of the GetReplicationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationJobs
default CompletableFuture<GetReplicationJobsResponse> getReplicationJobs(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest) Describes the specified replication job or all of your replication jobs.
This is a convenience which creates an instance of the
GetReplicationJobsRequest.Builder
avoiding the need to create one manually viaGetReplicationJobsRequest.builder()
- Parameters:
getReplicationJobsRequest
- AConsumer
that will call methods onGetReplicationJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReplicationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationJobs
Describes the specified replication job or all of your replication jobs.
- Returns:
- A Java Future containing the result of the GetReplicationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationJobsPaginator
This is a variant of
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsPublisher publisher = client.getReplicationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsPublisher publisher = client.getReplicationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationJobsPaginator
default GetReplicationJobsPublisher getReplicationJobsPaginator(GetReplicationJobsRequest getReplicationJobsRequest) This is a variant of
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsPublisher publisher = client.getReplicationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsPublisher publisher = client.getReplicationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.- Parameters:
getReplicationJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationJobsPaginator
default GetReplicationJobsPublisher getReplicationJobsPaginator(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest) This is a variant of
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsPublisher publisher = client.getReplicationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsPublisher publisher = client.getReplicationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.
This is a convenience which creates an instance of the
GetReplicationJobsRequest.Builder
avoiding the need to create one manually viaGetReplicationJobsRequest.builder()
- Parameters:
getReplicationJobsRequest
- AConsumer
that will call methods onGetReplicationJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationRuns
default CompletableFuture<GetReplicationRunsResponse> getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest) Describes the replication runs for the specified replication job.
- Parameters:
getReplicationRunsRequest
-- Returns:
- A Java Future containing the result of the GetReplicationRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationRuns
default CompletableFuture<GetReplicationRunsResponse> getReplicationRuns(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest) Describes the replication runs for the specified replication job.
This is a convenience which creates an instance of the
GetReplicationRunsRequest.Builder
avoiding the need to create one manually viaGetReplicationRunsRequest.builder()
- Parameters:
getReplicationRunsRequest
- AConsumer
that will call methods onGetReplicationRunsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetReplicationRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationRunsPaginator
default GetReplicationRunsPublisher getReplicationRunsPaginator(GetReplicationRunsRequest getReplicationRunsRequest) This is a variant of
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetReplicationRunsPublisher publisher = client.getReplicationRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetReplicationRunsPublisher publisher = client.getReplicationRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetReplicationRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetReplicationRunsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation.- Parameters:
getReplicationRunsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReplicationRunsPaginator
default GetReplicationRunsPublisher getReplicationRunsPaginator(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest) This is a variant of
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetReplicationRunsPublisher publisher = client.getReplicationRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetReplicationRunsPublisher publisher = client.getReplicationRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetReplicationRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetReplicationRunsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation.
This is a convenience which creates an instance of the
GetReplicationRunsRequest.Builder
avoiding the need to create one manually viaGetReplicationRunsRequest.builder()
- Parameters:
getReplicationRunsRequest
- AConsumer
that will call methods onGetReplicationRunsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServers
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
- Parameters:
getServersRequest
-- Returns:
- A Java Future containing the result of the GetServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServers
default CompletableFuture<GetServersResponse> getServers(Consumer<GetServersRequest.Builder> getServersRequest) Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
This is a convenience which creates an instance of the
GetServersRequest.Builder
avoiding the need to create one manually viaGetServersRequest.builder()
- Parameters:
getServersRequest
- AConsumer
that will call methods onGetServersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServers
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
- Returns:
- A Java Future containing the result of the GetServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServersPaginator
This is a variant of
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetServersPublisher publisher = client.getServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetServersPublisher publisher = client.getServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetServersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServersPaginator
This is a variant of
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetServersPublisher publisher = client.getServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetServersPublisher publisher = client.getServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetServersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.- Parameters:
getServersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServersPaginator
default GetServersPublisher getServersPaginator(Consumer<GetServersRequest.Builder> getServersRequest) This is a variant of
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.sms.paginators.GetServersPublisher publisher = client.getServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sms.paginators.GetServersPublisher publisher = client.getServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sms.model.GetServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sms.model.GetServersResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.
This is a convenience which creates an instance of the
GetServersRequest.Builder
avoiding the need to create one manually viaGetServersRequest.builder()
- Parameters:
getServersRequest
- AConsumer
that will call methods onGetServersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importAppCatalog
default CompletableFuture<ImportAppCatalogResponse> importAppCatalog(ImportAppCatalogRequest importAppCatalogRequest) Allows application import from Migration Hub.
- Parameters:
importAppCatalogRequest
-- Returns:
- A Java Future containing the result of the ImportAppCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importAppCatalog
default CompletableFuture<ImportAppCatalogResponse> importAppCatalog(Consumer<ImportAppCatalogRequest.Builder> importAppCatalogRequest) Allows application import from Migration Hub.
This is a convenience which creates an instance of the
ImportAppCatalogRequest.Builder
avoiding the need to create one manually viaImportAppCatalogRequest.builder()
- Parameters:
importAppCatalogRequest
- AConsumer
that will call methods onImportAppCatalogRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportAppCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importServerCatalog
default CompletableFuture<ImportServerCatalogResponse> importServerCatalog(ImportServerCatalogRequest 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.
- Parameters:
importServerCatalogRequest
-- Returns:
- A Java Future containing the result of the ImportServerCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- NoConnectorsAvailableException There are no connectors available.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importServerCatalog
default CompletableFuture<ImportServerCatalogResponse> importServerCatalog(Consumer<ImportServerCatalogRequest.Builder> 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.
This is a convenience which creates an instance of the
ImportServerCatalogRequest.Builder
avoiding the need to create one manually viaImportServerCatalogRequest.builder()
- Parameters:
importServerCatalogRequest
- AConsumer
that will call methods onImportServerCatalogRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportServerCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- NoConnectorsAvailableException There are no connectors available.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importServerCatalog
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.
- Returns:
- A Java Future containing the result of the ImportServerCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- NoConnectorsAvailableException There are no connectors available.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
launchApp
Launches the specified application as a stack in CloudFormation.
- Parameters:
launchAppRequest
-- Returns:
- A Java Future containing the result of the LaunchApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
launchApp
default CompletableFuture<LaunchAppResponse> launchApp(Consumer<LaunchAppRequest.Builder> launchAppRequest) Launches the specified application as a stack in CloudFormation.
This is a convenience which creates an instance of the
LaunchAppRequest.Builder
avoiding the need to create one manually viaLaunchAppRequest.builder()
- Parameters:
launchAppRequest
- AConsumer
that will call methods onLaunchAppRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the LaunchApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApps
Retrieves summaries for all applications.
- Parameters:
listAppsRequest
-- Returns:
- A Java Future containing the result of the ListApps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApps
default CompletableFuture<ListAppsResponse> listApps(Consumer<ListAppsRequest.Builder> listAppsRequest) Retrieves summaries for all applications.
This is a convenience which creates an instance of the
ListAppsRequest.Builder
avoiding the need to create one manually viaListAppsRequest.builder()
- Parameters:
listAppsRequest
- AConsumer
that will call methods onListAppsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApps
Retrieves summaries for all applications.
- Returns:
- A Java Future containing the result of the ListApps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
notifyAppValidationOutput
default CompletableFuture<NotifyAppValidationOutputResponse> notifyAppValidationOutput(NotifyAppValidationOutputRequest notifyAppValidationOutputRequest) Provides information to Server Migration Service about whether application validation is successful.
- Parameters:
notifyAppValidationOutputRequest
-- Returns:
- A Java Future containing the result of the NotifyAppValidationOutput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
notifyAppValidationOutput
default CompletableFuture<NotifyAppValidationOutputResponse> notifyAppValidationOutput(Consumer<NotifyAppValidationOutputRequest.Builder> notifyAppValidationOutputRequest) Provides information to Server Migration Service about whether application validation is successful.
This is a convenience which creates an instance of the
NotifyAppValidationOutputRequest.Builder
avoiding the need to create one manually viaNotifyAppValidationOutputRequest.builder()
- Parameters:
notifyAppValidationOutputRequest
- AConsumer
that will call methods onNotifyAppValidationOutputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the NotifyAppValidationOutput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppLaunchConfiguration
default CompletableFuture<PutAppLaunchConfigurationResponse> putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest) Creates or updates the launch configuration for the specified application.
- Parameters:
putAppLaunchConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutAppLaunchConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppLaunchConfiguration
default CompletableFuture<PutAppLaunchConfigurationResponse> putAppLaunchConfiguration(Consumer<PutAppLaunchConfigurationRequest.Builder> putAppLaunchConfigurationRequest) Creates or updates the launch configuration for the specified application.
This is a convenience which creates an instance of the
PutAppLaunchConfigurationRequest.Builder
avoiding the need to create one manually viaPutAppLaunchConfigurationRequest.builder()
- Parameters:
putAppLaunchConfigurationRequest
- AConsumer
that will call methods onPutAppLaunchConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAppLaunchConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppReplicationConfiguration
default CompletableFuture<PutAppReplicationConfigurationResponse> putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest) Creates or updates the replication configuration for the specified application.
- Parameters:
putAppReplicationConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutAppReplicationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppReplicationConfiguration
default CompletableFuture<PutAppReplicationConfigurationResponse> putAppReplicationConfiguration(Consumer<PutAppReplicationConfigurationRequest.Builder> putAppReplicationConfigurationRequest) Creates or updates the replication configuration for the specified application.
This is a convenience which creates an instance of the
PutAppReplicationConfigurationRequest.Builder
avoiding the need to create one manually viaPutAppReplicationConfigurationRequest.builder()
- Parameters:
putAppReplicationConfigurationRequest
- AConsumer
that will call methods onPutAppReplicationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAppReplicationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppValidationConfiguration
default CompletableFuture<PutAppValidationConfigurationResponse> putAppValidationConfiguration(PutAppValidationConfigurationRequest putAppValidationConfigurationRequest) Creates or updates a validation configuration for the specified application.
- Parameters:
putAppValidationConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutAppValidationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAppValidationConfiguration
default CompletableFuture<PutAppValidationConfigurationResponse> putAppValidationConfiguration(Consumer<PutAppValidationConfigurationRequest.Builder> putAppValidationConfigurationRequest) Creates or updates a validation configuration for the specified application.
This is a convenience which creates an instance of the
PutAppValidationConfigurationRequest.Builder
avoiding the need to create one manually viaPutAppValidationConfigurationRequest.builder()
- Parameters:
putAppValidationConfigurationRequest
- AConsumer
that will call methods onPutAppValidationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAppValidationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAppReplication
default CompletableFuture<StartAppReplicationResponse> startAppReplication(StartAppReplicationRequest startAppReplicationRequest) Starts replicating the specified application by creating replication jobs for each server in the application.
- Parameters:
startAppReplicationRequest
-- Returns:
- A Java Future containing the result of the StartAppReplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startAppReplication
default CompletableFuture<StartAppReplicationResponse> startAppReplication(Consumer<StartAppReplicationRequest.Builder> startAppReplicationRequest) Starts replicating the specified application by creating replication jobs for each server in the application.
This is a convenience which creates an instance of the
StartAppReplicationRequest.Builder
avoiding the need to create one manually viaStartAppReplicationRequest.builder()
- Parameters:
startAppReplicationRequest
- AConsumer
that will call methods onStartAppReplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartAppReplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startOnDemandAppReplication
default CompletableFuture<StartOnDemandAppReplicationResponse> startOnDemandAppReplication(StartOnDemandAppReplicationRequest startOnDemandAppReplicationRequest) Starts an on-demand replication run for the specified application.
- Parameters:
startOnDemandAppReplicationRequest
-- Returns:
- A Java Future containing the result of the StartOnDemandAppReplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startOnDemandAppReplication
default CompletableFuture<StartOnDemandAppReplicationResponse> startOnDemandAppReplication(Consumer<StartOnDemandAppReplicationRequest.Builder> startOnDemandAppReplicationRequest) Starts an on-demand replication run for the specified application.
This is a convenience which creates an instance of the
StartOnDemandAppReplicationRequest.Builder
avoiding the need to create one manually viaStartOnDemandAppReplicationRequest.builder()
- Parameters:
startOnDemandAppReplicationRequest
- AConsumer
that will call methods onStartOnDemandAppReplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartOnDemandAppReplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startOnDemandReplicationRun
default CompletableFuture<StartOnDemandReplicationRunResponse> startOnDemandReplicationRun(StartOnDemandReplicationRunRequest 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.
- Parameters:
startOnDemandReplicationRunRequest
-- Returns:
- A Java Future containing the result of the StartOnDemandReplicationRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- ReplicationRunLimitExceededException You have exceeded the number of on-demand replication runs you can request in a 24-hour period.
- DryRunOperationException The user has the required permissions, so the request would have succeeded, but a dry run was performed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startOnDemandReplicationRun
default CompletableFuture<StartOnDemandReplicationRunResponse> startOnDemandReplicationRun(Consumer<StartOnDemandReplicationRunRequest.Builder> 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.
This is a convenience which creates an instance of the
StartOnDemandReplicationRunRequest.Builder
avoiding the need to create one manually viaStartOnDemandReplicationRunRequest.builder()
- Parameters:
startOnDemandReplicationRunRequest
- AConsumer
that will call methods onStartOnDemandReplicationRunRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartOnDemandReplicationRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- OperationNotPermittedException This operation is not allowed.
- ReplicationRunLimitExceededException You have exceeded the number of on-demand replication runs you can request in a 24-hour period.
- DryRunOperationException The user has the required permissions, so the request would have succeeded, but a dry run was performed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopAppReplication
default CompletableFuture<StopAppReplicationResponse> stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest) Stops replicating the specified application by deleting the replication job for each server in the application.
- Parameters:
stopAppReplicationRequest
-- Returns:
- A Java Future containing the result of the StopAppReplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopAppReplication
default CompletableFuture<StopAppReplicationResponse> stopAppReplication(Consumer<StopAppReplicationRequest.Builder> stopAppReplicationRequest) Stops replicating the specified application by deleting the replication job for each server in the application.
This is a convenience which creates an instance of the
StopAppReplicationRequest.Builder
avoiding the need to create one manually viaStopAppReplicationRequest.builder()
- Parameters:
stopAppReplicationRequest
- AConsumer
that will call methods onStopAppReplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopAppReplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
terminateApp
default CompletableFuture<TerminateAppResponse> terminateApp(TerminateAppRequest terminateAppRequest) Terminates the stack for the specified application.
- Parameters:
terminateAppRequest
-- Returns:
- A Java Future containing the result of the TerminateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
terminateApp
default CompletableFuture<TerminateAppResponse> terminateApp(Consumer<TerminateAppRequest.Builder> terminateAppRequest) Terminates the stack for the specified application.
This is a convenience which creates an instance of the
TerminateAppRequest.Builder
avoiding the need to create one manually viaTerminateAppRequest.builder()
- Parameters:
terminateAppRequest
- AConsumer
that will call methods onTerminateAppRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TerminateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApp
Updates the specified application.
- Parameters:
updateAppRequest
-- Returns:
- A Java Future containing the result of the UpdateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApp
default CompletableFuture<UpdateAppResponse> updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest) Updates the specified application.
This is a convenience which creates an instance of the
UpdateAppRequest.Builder
avoiding the need to create one manually viaUpdateAppRequest.builder()
- Parameters:
updateAppRequest
- AConsumer
that will call methods onUpdateAppRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- InternalErrorException An internal error occurred.
- OperationNotPermittedException This operation is not allowed.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReplicationJob
default CompletableFuture<UpdateReplicationJobResponse> updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest) Updates the specified settings for the specified replication job.
- Parameters:
updateReplicationJobRequest
-- Returns:
- A Java Future containing the result of the UpdateReplicationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- OperationNotPermittedException This operation is not allowed.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- ServerCannotBeReplicatedException The specified server cannot be replicated.
- ReplicationJobNotFoundException The specified replication job does not exist.
- InternalErrorException An internal error occurred.
- TemporarilyUnavailableException The service is temporarily unavailable.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateReplicationJob
default CompletableFuture<UpdateReplicationJobResponse> updateReplicationJob(Consumer<UpdateReplicationJobRequest.Builder> updateReplicationJobRequest) Updates the specified settings for the specified replication job.
This is a convenience which creates an instance of the
UpdateReplicationJobRequest.Builder
avoiding the need to create one manually viaUpdateReplicationJobRequest.builder()
- Parameters:
updateReplicationJobRequest
- AConsumer
that will call methods onUpdateReplicationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateReplicationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException A specified parameter is not valid.
- MissingRequiredParameterException A required parameter is missing.
- OperationNotPermittedException This operation is not allowed.
- UnauthorizedOperationException You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
- ServerCannotBeReplicatedException The specified server cannot be replicated.
- ReplicationJobNotFoundException The specified replication job does not exist.
- InternalErrorException An internal error occurred.
- TemporarilyUnavailableException The service is temporarily unavailable.
- SdkException 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSmsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSmsAsyncClient
.
-