Interface SmsClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SmsClient extends AwsClient
Service client for accessing SMS. This can be created using the staticbuilder()method.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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SmsClientBuilderbuilder()Create a builder that can be used to configure and create aSmsClient.static SmsClientcreate()Create aSmsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAppResponsecreateApp(Consumer<CreateAppRequest.Builder> createAppRequest)Creates an application.default CreateAppResponsecreateApp(CreateAppRequest createAppRequest)Creates an application.default CreateReplicationJobResponsecreateReplicationJob(Consumer<CreateReplicationJobRequest.Builder> createReplicationJobRequest)Creates a replication job.default CreateReplicationJobResponsecreateReplicationJob(CreateReplicationJobRequest createReplicationJobRequest)Creates a replication job.default DeleteAppResponsedeleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)Deletes the specified application.default DeleteAppResponsedeleteApp(DeleteAppRequest deleteAppRequest)Deletes the specified application.default DeleteAppLaunchConfigurationResponsedeleteAppLaunchConfiguration(Consumer<DeleteAppLaunchConfigurationRequest.Builder> deleteAppLaunchConfigurationRequest)Deletes the launch configuration for the specified application.default DeleteAppLaunchConfigurationResponsedeleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest)Deletes the launch configuration for the specified application.default DeleteAppReplicationConfigurationResponsedeleteAppReplicationConfiguration(Consumer<DeleteAppReplicationConfigurationRequest.Builder> deleteAppReplicationConfigurationRequest)Deletes the replication configuration for the specified application.default DeleteAppReplicationConfigurationResponsedeleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest)Deletes the replication configuration for the specified application.default DeleteAppValidationConfigurationResponsedeleteAppValidationConfiguration(Consumer<DeleteAppValidationConfigurationRequest.Builder> deleteAppValidationConfigurationRequest)Deletes the validation configuration for the specified application.default DeleteAppValidationConfigurationResponsedeleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest deleteAppValidationConfigurationRequest)Deletes the validation configuration for the specified application.default DeleteReplicationJobResponsedeleteReplicationJob(Consumer<DeleteReplicationJobRequest.Builder> deleteReplicationJobRequest)Deletes the specified replication job.default DeleteReplicationJobResponsedeleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest)Deletes the specified replication job.default DeleteServerCatalogResponsedeleteServerCatalog()Deletes all servers from your server catalog.default DeleteServerCatalogResponsedeleteServerCatalog(Consumer<DeleteServerCatalogRequest.Builder> deleteServerCatalogRequest)Deletes all servers from your server catalog.default DeleteServerCatalogResponsedeleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest)Deletes all servers from your server catalog.default DisassociateConnectorResponsedisassociateConnector(Consumer<DisassociateConnectorRequest.Builder> disassociateConnectorRequest)Disassociates the specified connector from Server Migration Service.default DisassociateConnectorResponsedisassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest)Disassociates the specified connector from Server Migration Service.default GenerateChangeSetResponsegenerateChangeSet(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.default GenerateChangeSetResponsegenerateChangeSet(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.default GenerateTemplateResponsegenerateTemplate(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.default GenerateTemplateResponsegenerateTemplate(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 GetAppResponsegetApp()Retrieve information about the specified application.default GetAppResponsegetApp(Consumer<GetAppRequest.Builder> getAppRequest)Retrieve information about the specified application.default GetAppResponsegetApp(GetAppRequest getAppRequest)Retrieve information about the specified application.default GetAppLaunchConfigurationResponsegetAppLaunchConfiguration()Retrieves the application launch configuration associated with the specified application.default GetAppLaunchConfigurationResponsegetAppLaunchConfiguration(Consumer<GetAppLaunchConfigurationRequest.Builder> getAppLaunchConfigurationRequest)Retrieves the application launch configuration associated with the specified application.default GetAppLaunchConfigurationResponsegetAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest)Retrieves the application launch configuration associated with the specified application.default GetAppReplicationConfigurationResponsegetAppReplicationConfiguration()Retrieves the application replication configuration associated with the specified application.default GetAppReplicationConfigurationResponsegetAppReplicationConfiguration(Consumer<GetAppReplicationConfigurationRequest.Builder> getAppReplicationConfigurationRequest)Retrieves the application replication configuration associated with the specified application.default GetAppReplicationConfigurationResponsegetAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest)Retrieves the application replication configuration associated with the specified application.default GetAppValidationConfigurationResponsegetAppValidationConfiguration(Consumer<GetAppValidationConfigurationRequest.Builder> getAppValidationConfigurationRequest)Retrieves information about a configuration for validating an application.default GetAppValidationConfigurationResponsegetAppValidationConfiguration(GetAppValidationConfigurationRequest getAppValidationConfigurationRequest)Retrieves information about a configuration for validating an application.default GetAppValidationOutputResponsegetAppValidationOutput(Consumer<GetAppValidationOutputRequest.Builder> getAppValidationOutputRequest)Retrieves output from validating an application.default GetAppValidationOutputResponsegetAppValidationOutput(GetAppValidationOutputRequest getAppValidationOutputRequest)Retrieves output from validating an application.default GetConnectorsResponsegetConnectors()Describes the connectors registered with the Server Migration Service.default GetConnectorsResponsegetConnectors(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest)Describes the connectors registered with the Server Migration Service.default GetConnectorsResponsegetConnectors(GetConnectorsRequest getConnectorsRequest)Describes the connectors registered with the Server Migration Service.default GetConnectorsIterablegetConnectorsPaginator()This is a variant ofgetConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)operation.default GetConnectorsIterablegetConnectorsPaginator(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest)This is a variant ofgetConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)operation.default GetConnectorsIterablegetConnectorsPaginator(GetConnectorsRequest getConnectorsRequest)This is a variant ofgetConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)operation.default GetReplicationJobsResponsegetReplicationJobs()Describes the specified replication job or all of your replication jobs.default GetReplicationJobsResponsegetReplicationJobs(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest)Describes the specified replication job or all of your replication jobs.default GetReplicationJobsResponsegetReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest)Describes the specified replication job or all of your replication jobs.default GetReplicationJobsIterablegetReplicationJobsPaginator()This is a variant ofgetReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)operation.default GetReplicationJobsIterablegetReplicationJobsPaginator(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest)This is a variant ofgetReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)operation.default GetReplicationJobsIterablegetReplicationJobsPaginator(GetReplicationJobsRequest getReplicationJobsRequest)This is a variant ofgetReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)operation.default GetReplicationRunsResponsegetReplicationRuns(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest)Describes the replication runs for the specified replication job.default GetReplicationRunsResponsegetReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest)Describes the replication runs for the specified replication job.default GetReplicationRunsIterablegetReplicationRunsPaginator(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest)This is a variant ofgetReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)operation.default GetReplicationRunsIterablegetReplicationRunsPaginator(GetReplicationRunsRequest getReplicationRunsRequest)This is a variant ofgetReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)operation.default GetServersResponsegetServers()Describes the servers in your server catalog.default GetServersResponsegetServers(Consumer<GetServersRequest.Builder> getServersRequest)Describes the servers in your server catalog.default GetServersResponsegetServers(GetServersRequest getServersRequest)Describes the servers in your server catalog.default GetServersIterablegetServersPaginator()This is a variant ofgetServers(software.amazon.awssdk.services.sms.model.GetServersRequest)operation.default GetServersIterablegetServersPaginator(Consumer<GetServersRequest.Builder> getServersRequest)This is a variant ofgetServers(software.amazon.awssdk.services.sms.model.GetServersRequest)operation.default GetServersIterablegetServersPaginator(GetServersRequest getServersRequest)This is a variant ofgetServers(software.amazon.awssdk.services.sms.model.GetServersRequest)operation.default ImportAppCatalogResponseimportAppCatalog(Consumer<ImportAppCatalogRequest.Builder> importAppCatalogRequest)Allows application import from Migration Hub.default ImportAppCatalogResponseimportAppCatalog(ImportAppCatalogRequest importAppCatalogRequest)Allows application import from Migration Hub.default ImportServerCatalogResponseimportServerCatalog()Gathers a complete list of on-premises servers.default ImportServerCatalogResponseimportServerCatalog(Consumer<ImportServerCatalogRequest.Builder> importServerCatalogRequest)Gathers a complete list of on-premises servers.default ImportServerCatalogResponseimportServerCatalog(ImportServerCatalogRequest importServerCatalogRequest)Gathers a complete list of on-premises servers.default LaunchAppResponselaunchApp(Consumer<LaunchAppRequest.Builder> launchAppRequest)Launches the specified application as a stack in CloudFormation.default LaunchAppResponselaunchApp(LaunchAppRequest launchAppRequest)Launches the specified application as a stack in CloudFormation.default ListAppsResponselistApps()Retrieves summaries for all applications.default ListAppsResponselistApps(Consumer<ListAppsRequest.Builder> listAppsRequest)Retrieves summaries for all applications.default ListAppsResponselistApps(ListAppsRequest listAppsRequest)Retrieves summaries for all applications.default NotifyAppValidationOutputResponsenotifyAppValidationOutput(Consumer<NotifyAppValidationOutputRequest.Builder> notifyAppValidationOutputRequest)Provides information to Server Migration Service about whether application validation is successful.default NotifyAppValidationOutputResponsenotifyAppValidationOutput(NotifyAppValidationOutputRequest notifyAppValidationOutputRequest)Provides information to Server Migration Service about whether application validation is successful.default PutAppLaunchConfigurationResponseputAppLaunchConfiguration(Consumer<PutAppLaunchConfigurationRequest.Builder> putAppLaunchConfigurationRequest)Creates or updates the launch configuration for the specified application.default PutAppLaunchConfigurationResponseputAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest)Creates or updates the launch configuration for the specified application.default PutAppReplicationConfigurationResponseputAppReplicationConfiguration(Consumer<PutAppReplicationConfigurationRequest.Builder> putAppReplicationConfigurationRequest)Creates or updates the replication configuration for the specified application.default PutAppReplicationConfigurationResponseputAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest)Creates or updates the replication configuration for the specified application.default PutAppValidationConfigurationResponseputAppValidationConfiguration(Consumer<PutAppValidationConfigurationRequest.Builder> putAppValidationConfigurationRequest)Creates or updates a validation configuration for the specified application.default PutAppValidationConfigurationResponseputAppValidationConfiguration(PutAppValidationConfigurationRequest putAppValidationConfigurationRequest)Creates or updates a validation configuration for the specified application.default SmsServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartAppReplicationResponsestartAppReplication(Consumer<StartAppReplicationRequest.Builder> startAppReplicationRequest)Starts replicating the specified application by creating replication jobs for each server in the application.default StartAppReplicationResponsestartAppReplication(StartAppReplicationRequest startAppReplicationRequest)Starts replicating the specified application by creating replication jobs for each server in the application.default StartOnDemandAppReplicationResponsestartOnDemandAppReplication(Consumer<StartOnDemandAppReplicationRequest.Builder> startOnDemandAppReplicationRequest)Starts an on-demand replication run for the specified application.default StartOnDemandAppReplicationResponsestartOnDemandAppReplication(StartOnDemandAppReplicationRequest startOnDemandAppReplicationRequest)Starts an on-demand replication run for the specified application.default StartOnDemandReplicationRunResponsestartOnDemandReplicationRun(Consumer<StartOnDemandReplicationRunRequest.Builder> startOnDemandReplicationRunRequest)Starts an on-demand replication run for the specified replication job.default StartOnDemandReplicationRunResponsestartOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest)Starts an on-demand replication run for the specified replication job.default StopAppReplicationResponsestopAppReplication(Consumer<StopAppReplicationRequest.Builder> stopAppReplicationRequest)Stops replicating the specified application by deleting the replication job for each server in the application.default StopAppReplicationResponsestopAppReplication(StopAppReplicationRequest stopAppReplicationRequest)Stops replicating the specified application by deleting the replication job for each server in the application.default TerminateAppResponseterminateApp(Consumer<TerminateAppRequest.Builder> terminateAppRequest)Terminates the stack for the specified application.default TerminateAppResponseterminateApp(TerminateAppRequest terminateAppRequest)Terminates the stack for the specified application.default UpdateAppResponseupdateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest)Updates the specified application.default UpdateAppResponseupdateApp(UpdateAppRequest updateAppRequest)Updates the specified application.default UpdateReplicationJobResponseupdateReplicationJob(Consumer<UpdateReplicationJobRequest.Builder> updateReplicationJobRequest)Updates the specified settings for the specified replication job.default UpdateReplicationJobResponseupdateReplicationJob(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createApp
default CreateAppResponse createApp(CreateAppRequest createAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
- Parameters:
createAppRequest-- Returns:
- Result of the CreateApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createApp
default CreateAppResponse createApp(Consumer<CreateAppRequest.Builder> createAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaCreateAppRequest.builder()- Parameters:
createAppRequest- AConsumerthat will call methods onCreateAppRequest.Builderto create a request.- Returns:
- Result of the CreateApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createReplicationJob
default CreateReplicationJobResponse createReplicationJob(CreateReplicationJobRequest createReplicationJobRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ServerCannotBeReplicatedException, ReplicationJobAlreadyExistsException, NoConnectorsAvailableException, InternalErrorException, TemporarilyUnavailableException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the CreateReplicationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createReplicationJob
default CreateReplicationJobResponse createReplicationJob(Consumer<CreateReplicationJobRequest.Builder> createReplicationJobRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ServerCannotBeReplicatedException, ReplicationJobAlreadyExistsException, NoConnectorsAvailableException, InternalErrorException, TemporarilyUnavailableException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaCreateReplicationJobRequest.builder()- Parameters:
createReplicationJobRequest- AConsumerthat will call methods onCreateReplicationJobRequest.Builderto create a request.- Returns:
- Result of the CreateReplicationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApp
default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the DeleteApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteApp
default DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaDeleteAppRequest.builder()- Parameters:
deleteAppRequest- AConsumerthat will call methods onDeleteAppRequest.Builderto create a request.- Returns:
- Result of the DeleteApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAppLaunchConfiguration
default DeleteAppLaunchConfigurationResponse deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes the launch configuration for the specified application.
- Parameters:
deleteAppLaunchConfigurationRequest-- Returns:
- Result of the DeleteAppLaunchConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAppLaunchConfiguration
default DeleteAppLaunchConfigurationResponse deleteAppLaunchConfiguration(Consumer<DeleteAppLaunchConfigurationRequest.Builder> deleteAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes the launch configuration for the specified application.
This is a convenience which creates an instance of the
DeleteAppLaunchConfigurationRequest.Builderavoiding the need to create one manually viaDeleteAppLaunchConfigurationRequest.builder()- Parameters:
deleteAppLaunchConfigurationRequest- AConsumerthat will call methods onDeleteAppLaunchConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteAppLaunchConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAppReplicationConfiguration
default DeleteAppReplicationConfigurationResponse deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes the replication configuration for the specified application.
- Parameters:
deleteAppReplicationConfigurationRequest-- Returns:
- Result of the DeleteAppReplicationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAppReplicationConfiguration
default DeleteAppReplicationConfigurationResponse deleteAppReplicationConfiguration(Consumer<DeleteAppReplicationConfigurationRequest.Builder> deleteAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes the replication configuration for the specified application.
This is a convenience which creates an instance of the
DeleteAppReplicationConfigurationRequest.Builderavoiding the need to create one manually viaDeleteAppReplicationConfigurationRequest.builder()- Parameters:
deleteAppReplicationConfigurationRequest- AConsumerthat will call methods onDeleteAppReplicationConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteAppReplicationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAppValidationConfiguration
default DeleteAppValidationConfigurationResponse deleteAppValidationConfiguration(DeleteAppValidationConfigurationRequest deleteAppValidationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes the validation configuration for the specified application.
- Parameters:
deleteAppValidationConfigurationRequest-- Returns:
- Result of the DeleteAppValidationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAppValidationConfiguration
default DeleteAppValidationConfigurationResponse deleteAppValidationConfiguration(Consumer<DeleteAppValidationConfigurationRequest.Builder> deleteAppValidationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes the validation configuration for the specified application.
This is a convenience which creates an instance of the
DeleteAppValidationConfigurationRequest.Builderavoiding the need to create one manually viaDeleteAppValidationConfigurationRequest.builder()- Parameters:
deleteAppValidationConfigurationRequest- AConsumerthat will call methods onDeleteAppValidationConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteAppValidationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteReplicationJob
default DeleteReplicationJobResponse deleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ReplicationJobNotFoundException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the DeleteReplicationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteReplicationJob
default DeleteReplicationJobResponse deleteReplicationJob(Consumer<DeleteReplicationJobRequest.Builder> deleteReplicationJobRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ReplicationJobNotFoundException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaDeleteReplicationJobRequest.builder()- Parameters:
deleteReplicationJobRequest- AConsumerthat will call methods onDeleteReplicationJobRequest.Builderto create a request.- Returns:
- Result of the DeleteReplicationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServerCatalog
default DeleteServerCatalogResponse deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest) throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, AwsServiceException, SdkClientException, SmsException
Deletes all servers from your server catalog.
- Parameters:
deleteServerCatalogRequest-- Returns:
- Result of the DeleteServerCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServerCatalog
default DeleteServerCatalogResponse deleteServerCatalog(Consumer<DeleteServerCatalogRequest.Builder> deleteServerCatalogRequest) throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, AwsServiceException, SdkClientException, SmsException
Deletes all servers from your server catalog.
This is a convenience which creates an instance of the
DeleteServerCatalogRequest.Builderavoiding the need to create one manually viaDeleteServerCatalogRequest.builder()- Parameters:
deleteServerCatalogRequest- AConsumerthat will call methods onDeleteServerCatalogRequest.Builderto create a request.- Returns:
- Result of the DeleteServerCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServerCatalog
default DeleteServerCatalogResponse deleteServerCatalog() throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, AwsServiceException, SdkClientException, SmsException
Deletes all servers from your server catalog.
- Returns:
- Result of the DeleteServerCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
deleteServerCatalog(DeleteServerCatalogRequest), AWS API Documentation
-
disassociateConnector
default DisassociateConnectorResponse disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest) throws MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the DisassociateConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateConnector
default DisassociateConnectorResponse disassociateConnector(Consumer<DisassociateConnectorRequest.Builder> disassociateConnectorRequest) throws MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaDisassociateConnectorRequest.builder()- Parameters:
disassociateConnectorRequest- AConsumerthat will call methods onDisassociateConnectorRequest.Builderto create a request.- Returns:
- Result of the DisassociateConnector operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
generateChangeSet
default GenerateChangeSetResponse generateChangeSet(GenerateChangeSetRequest generateChangeSetRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the GenerateChangeSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
generateChangeSet
default GenerateChangeSetResponse generateChangeSet(Consumer<GenerateChangeSetRequest.Builder> generateChangeSetRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaGenerateChangeSetRequest.builder()- Parameters:
generateChangeSetRequest- AConsumerthat will call methods onGenerateChangeSetRequest.Builderto create a request.- Returns:
- Result of the GenerateChangeSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
generateTemplate
default GenerateTemplateResponse generateTemplate(GenerateTemplateRequest generateTemplateRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the GenerateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
generateTemplate
default GenerateTemplateResponse generateTemplate(Consumer<GenerateTemplateRequest.Builder> generateTemplateRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaGenerateTemplateRequest.builder()- Parameters:
generateTemplateRequest- AConsumerthat will call methods onGenerateTemplateRequest.Builderto create a request.- Returns:
- Result of the GenerateTemplate operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getApp
default GetAppResponse getApp(GetAppRequest getAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieve information about the specified application.
- Parameters:
getAppRequest-- Returns:
- Result of the GetApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getApp
default GetAppResponse getApp(Consumer<GetAppRequest.Builder> getAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieve information about the specified application.
This is a convenience which creates an instance of the
GetAppRequest.Builderavoiding the need to create one manually viaGetAppRequest.builder()- Parameters:
getAppRequest- AConsumerthat will call methods onGetAppRequest.Builderto create a request.- Returns:
- Result of the GetApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getApp
default GetAppResponse getApp() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieve information about the specified application.
- Returns:
- Result of the GetApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getApp(GetAppRequest), AWS API Documentation
-
getAppLaunchConfiguration
default GetAppLaunchConfigurationResponse getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application launch configuration associated with the specified application.
- Parameters:
getAppLaunchConfigurationRequest-- Returns:
- Result of the GetAppLaunchConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAppLaunchConfiguration
default GetAppLaunchConfigurationResponse getAppLaunchConfiguration(Consumer<GetAppLaunchConfigurationRequest.Builder> getAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application launch configuration associated with the specified application.
This is a convenience which creates an instance of the
GetAppLaunchConfigurationRequest.Builderavoiding the need to create one manually viaGetAppLaunchConfigurationRequest.builder()- Parameters:
getAppLaunchConfigurationRequest- AConsumerthat will call methods onGetAppLaunchConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetAppLaunchConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAppLaunchConfiguration
default GetAppLaunchConfigurationResponse getAppLaunchConfiguration() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application launch configuration associated with the specified application.
- Returns:
- Result of the GetAppLaunchConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getAppLaunchConfiguration(GetAppLaunchConfigurationRequest), AWS API Documentation
-
getAppReplicationConfiguration
default GetAppReplicationConfigurationResponse getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application replication configuration associated with the specified application.
- Parameters:
getAppReplicationConfigurationRequest-- Returns:
- Result of the GetAppReplicationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAppReplicationConfiguration
default GetAppReplicationConfigurationResponse getAppReplicationConfiguration(Consumer<GetAppReplicationConfigurationRequest.Builder> getAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application replication configuration associated with the specified application.
This is a convenience which creates an instance of the
GetAppReplicationConfigurationRequest.Builderavoiding the need to create one manually viaGetAppReplicationConfigurationRequest.builder()- Parameters:
getAppReplicationConfigurationRequest- AConsumerthat will call methods onGetAppReplicationConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetAppReplicationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAppReplicationConfiguration
default GetAppReplicationConfigurationResponse getAppReplicationConfiguration() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application replication configuration associated with the specified application.
- Returns:
- Result of the GetAppReplicationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getAppReplicationConfiguration(GetAppReplicationConfigurationRequest), AWS API Documentation
-
getAppValidationConfiguration
default GetAppValidationConfigurationResponse getAppValidationConfiguration(GetAppValidationConfigurationRequest getAppValidationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves information about a configuration for validating an application.
- Parameters:
getAppValidationConfigurationRequest-- Returns:
- Result of the GetAppValidationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAppValidationConfiguration
default GetAppValidationConfigurationResponse getAppValidationConfiguration(Consumer<GetAppValidationConfigurationRequest.Builder> getAppValidationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves information about a configuration for validating an application.
This is a convenience which creates an instance of the
GetAppValidationConfigurationRequest.Builderavoiding the need to create one manually viaGetAppValidationConfigurationRequest.builder()- Parameters:
getAppValidationConfigurationRequest- AConsumerthat will call methods onGetAppValidationConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetAppValidationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAppValidationOutput
default GetAppValidationOutputResponse getAppValidationOutput(GetAppValidationOutputRequest getAppValidationOutputRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves output from validating an application.
- Parameters:
getAppValidationOutputRequest-- Returns:
- Result of the GetAppValidationOutput operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAppValidationOutput
default GetAppValidationOutputResponse getAppValidationOutput(Consumer<GetAppValidationOutputRequest.Builder> getAppValidationOutputRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves output from validating an application.
This is a convenience which creates an instance of the
GetAppValidationOutputRequest.Builderavoiding the need to create one manually viaGetAppValidationOutputRequest.builder()- Parameters:
getAppValidationOutputRequest- AConsumerthat will call methods onGetAppValidationOutputRequest.Builderto create a request.- Returns:
- Result of the GetAppValidationOutput operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConnectors
default GetConnectorsResponse getConnectors(GetConnectorsRequest getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the Server Migration Service.
- Parameters:
getConnectorsRequest-- Returns:
- Result of the GetConnectors operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConnectors
default GetConnectorsResponse getConnectors(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the Server Migration Service.
This is a convenience which creates an instance of the
GetConnectorsRequest.Builderavoiding the need to create one manually viaGetConnectorsRequest.builder()- Parameters:
getConnectorsRequest- AConsumerthat will call methods onGetConnectorsRequest.Builderto create a request.- Returns:
- Result of the GetConnectors operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConnectors
default GetConnectorsResponse getConnectors() throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the Server Migration Service.
- Returns:
- Result of the GetConnectors operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getConnectors(GetConnectorsRequest), AWS API Documentation
-
getConnectorsPaginator
default GetConnectorsIterable getConnectorsPaginator() throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetConnectorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
getConnectorsPaginator(GetConnectorsRequest), AWS API Documentation
-
getConnectorsPaginator
default GetConnectorsIterable getConnectorsPaginator(GetConnectorsRequest getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetConnectorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getConnectorsPaginator
default GetConnectorsIterable getConnectorsPaginator(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetConnectorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetConnectorsRequest.builder()- Parameters:
getConnectorsRequest- AConsumerthat will call methods onGetConnectorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationJobs
default GetReplicationJobsResponse getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the specified replication job or all of your replication jobs.
- Parameters:
getReplicationJobsRequest-- Returns:
- Result of the GetReplicationJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationJobs
default GetReplicationJobsResponse getReplicationJobs(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the specified replication job or all of your replication jobs.
This is a convenience which creates an instance of the
GetReplicationJobsRequest.Builderavoiding the need to create one manually viaGetReplicationJobsRequest.builder()- Parameters:
getReplicationJobsRequest- AConsumerthat will call methods onGetReplicationJobsRequest.Builderto create a request.- Returns:
- Result of the GetReplicationJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationJobs
default GetReplicationJobsResponse getReplicationJobs() throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the specified replication job or all of your replication jobs.
- Returns:
- Result of the GetReplicationJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getReplicationJobs(GetReplicationJobsRequest), AWS API Documentation
-
getReplicationJobsPaginator
default GetReplicationJobsIterable getReplicationJobsPaginator() throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client .getReplicationJobsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
getReplicationJobsPaginator(GetReplicationJobsRequest), AWS API Documentation
-
getReplicationJobsPaginator
default GetReplicationJobsIterable getReplicationJobsPaginator(GetReplicationJobsRequest getReplicationJobsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client .getReplicationJobsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationJobsPaginator
default GetReplicationJobsIterable getReplicationJobsPaginator(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client .getReplicationJobsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetReplicationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetReplicationJobsRequest.builder()- Parameters:
getReplicationJobsRequest- AConsumerthat will call methods onGetReplicationJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationRuns
default GetReplicationRunsResponse getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the replication runs for the specified replication job.
- Parameters:
getReplicationRunsRequest-- Returns:
- Result of the GetReplicationRuns operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationRuns
default GetReplicationRunsResponse getReplicationRuns(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the replication runs for the specified replication job.
This is a convenience which creates an instance of the
GetReplicationRunsRequest.Builderavoiding the need to create one manually viaGetReplicationRunsRequest.builder()- Parameters:
getReplicationRunsRequest- AConsumerthat will call methods onGetReplicationRunsRequest.Builderto create a request.- Returns:
- Result of the GetReplicationRuns operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationRunsPaginator
default GetReplicationRunsIterable getReplicationRunsPaginator(GetReplicationRunsRequest getReplicationRunsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client .getReplicationRunsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetReplicationRunsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getReplicationRunsPaginator
default GetReplicationRunsIterable getReplicationRunsPaginator(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client .getReplicationRunsPaginator(request); for (software.amazon.awssdk.services.sms.model.GetReplicationRunsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetReplicationRunsRequest.builder()- Parameters:
getReplicationRunsRequest- AConsumerthat will call methods onGetReplicationRunsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServers
default GetServersResponse getServers(GetServersRequest getServersRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, AwsServiceException, SdkClientException, SmsException
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
- Parameters:
getServersRequest-- Returns:
- Result of the GetServers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServers
default GetServersResponse getServers(Consumer<GetServersRequest.Builder> getServersRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaGetServersRequest.builder()- Parameters:
getServersRequest- AConsumerthat will call methods onGetServersRequest.Builderto create a request.- Returns:
- Result of the GetServers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServers
default GetServersResponse getServers() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, AwsServiceException, SdkClientException, SmsException
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
- Returns:
- Result of the GetServers operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getServers(GetServersRequest), AWS API Documentation
-
getServersPaginator
default GetServersIterable getServersPaginator() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); for (software.amazon.awssdk.services.sms.model.GetServersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
getServersPaginator(GetServersRequest), AWS API Documentation
-
getServersPaginator
default GetServersIterable getServersPaginator(GetServersRequest getServersRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); for (software.amazon.awssdk.services.sms.model.GetServersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServersPaginator
default GetServersIterable getServersPaginator(Consumer<GetServersRequest.Builder> getServersRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, AwsServiceException, SdkClientException, SmsException
This is a variant of
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); for (software.amazon.awssdk.services.sms.model.GetServersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetServersRequest.builder()- Parameters:
getServersRequest- AConsumerthat will call methods onGetServersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importAppCatalog
default ImportAppCatalogResponse importAppCatalog(ImportAppCatalogRequest importAppCatalogRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Allows application import from Migration Hub.
- Parameters:
importAppCatalogRequest-- Returns:
- Result of the ImportAppCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importAppCatalog
default ImportAppCatalogResponse importAppCatalog(Consumer<ImportAppCatalogRequest.Builder> importAppCatalogRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Allows application import from Migration Hub.
This is a convenience which creates an instance of the
ImportAppCatalogRequest.Builderavoiding the need to create one manually viaImportAppCatalogRequest.builder()- Parameters:
importAppCatalogRequest- AConsumerthat will call methods onImportAppCatalogRequest.Builderto create a request.- Returns:
- Result of the ImportAppCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importServerCatalog
default ImportServerCatalogResponse importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest) throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, NoConnectorsAvailableException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the ImportServerCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importServerCatalog
default ImportServerCatalogResponse importServerCatalog(Consumer<ImportServerCatalogRequest.Builder> importServerCatalogRequest) throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, NoConnectorsAvailableException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaImportServerCatalogRequest.builder()- Parameters:
importServerCatalogRequest- AConsumerthat will call methods onImportServerCatalogRequest.Builderto create a request.- Returns:
- Result of the ImportServerCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
importServerCatalog
default ImportServerCatalogResponse importServerCatalog() throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, NoConnectorsAvailableException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the ImportServerCatalog operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
importServerCatalog(ImportServerCatalogRequest), AWS API Documentation
-
launchApp
default LaunchAppResponse launchApp(LaunchAppRequest launchAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Launches the specified application as a stack in CloudFormation.
- Parameters:
launchAppRequest-- Returns:
- Result of the LaunchApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
launchApp
default LaunchAppResponse launchApp(Consumer<LaunchAppRequest.Builder> launchAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Launches the specified application as a stack in CloudFormation.
This is a convenience which creates an instance of the
LaunchAppRequest.Builderavoiding the need to create one manually viaLaunchAppRequest.builder()- Parameters:
launchAppRequest- AConsumerthat will call methods onLaunchAppRequest.Builderto create a request.- Returns:
- Result of the LaunchApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps(ListAppsRequest listAppsRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves summaries for all applications.
- Parameters:
listAppsRequest-- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps(Consumer<ListAppsRequest.Builder> listAppsRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves summaries for all applications.
This is a convenience which creates an instance of the
ListAppsRequest.Builderavoiding the need to create one manually viaListAppsRequest.builder()- Parameters:
listAppsRequest- AConsumerthat will call methods onListAppsRequest.Builderto create a request.- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApps
default ListAppsResponse listApps() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves summaries for all applications.
- Returns:
- Result of the ListApps operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listApps(ListAppsRequest), AWS API Documentation
-
notifyAppValidationOutput
default NotifyAppValidationOutputResponse notifyAppValidationOutput(NotifyAppValidationOutputRequest notifyAppValidationOutputRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Provides information to Server Migration Service about whether application validation is successful.
- Parameters:
notifyAppValidationOutputRequest-- Returns:
- Result of the NotifyAppValidationOutput operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyAppValidationOutput
default NotifyAppValidationOutputResponse notifyAppValidationOutput(Consumer<NotifyAppValidationOutputRequest.Builder> notifyAppValidationOutputRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Provides information to Server Migration Service about whether application validation is successful.
This is a convenience which creates an instance of the
NotifyAppValidationOutputRequest.Builderavoiding the need to create one manually viaNotifyAppValidationOutputRequest.builder()- Parameters:
notifyAppValidationOutputRequest- AConsumerthat will call methods onNotifyAppValidationOutputRequest.Builderto create a request.- Returns:
- Result of the NotifyAppValidationOutput operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAppLaunchConfiguration
default PutAppLaunchConfigurationResponse putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates the launch configuration for the specified application.
- Parameters:
putAppLaunchConfigurationRequest-- Returns:
- Result of the PutAppLaunchConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAppLaunchConfiguration
default PutAppLaunchConfigurationResponse putAppLaunchConfiguration(Consumer<PutAppLaunchConfigurationRequest.Builder> putAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates the launch configuration for the specified application.
This is a convenience which creates an instance of the
PutAppLaunchConfigurationRequest.Builderavoiding the need to create one manually viaPutAppLaunchConfigurationRequest.builder()- Parameters:
putAppLaunchConfigurationRequest- AConsumerthat will call methods onPutAppLaunchConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutAppLaunchConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAppReplicationConfiguration
default PutAppReplicationConfigurationResponse putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates the replication configuration for the specified application.
- Parameters:
putAppReplicationConfigurationRequest-- Returns:
- Result of the PutAppReplicationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAppReplicationConfiguration
default PutAppReplicationConfigurationResponse putAppReplicationConfiguration(Consumer<PutAppReplicationConfigurationRequest.Builder> putAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates the replication configuration for the specified application.
This is a convenience which creates an instance of the
PutAppReplicationConfigurationRequest.Builderavoiding the need to create one manually viaPutAppReplicationConfigurationRequest.builder()- Parameters:
putAppReplicationConfigurationRequest- AConsumerthat will call methods onPutAppReplicationConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutAppReplicationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAppValidationConfiguration
default PutAppValidationConfigurationResponse putAppValidationConfiguration(PutAppValidationConfigurationRequest putAppValidationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates a validation configuration for the specified application.
- Parameters:
putAppValidationConfigurationRequest-- Returns:
- Result of the PutAppValidationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putAppValidationConfiguration
default PutAppValidationConfigurationResponse putAppValidationConfiguration(Consumer<PutAppValidationConfigurationRequest.Builder> putAppValidationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates a validation configuration for the specified application.
This is a convenience which creates an instance of the
PutAppValidationConfigurationRequest.Builderavoiding the need to create one manually viaPutAppValidationConfigurationRequest.builder()- Parameters:
putAppValidationConfigurationRequest- AConsumerthat will call methods onPutAppValidationConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutAppValidationConfiguration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startAppReplication
default StartAppReplicationResponse startAppReplication(StartAppReplicationRequest startAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Starts replicating the specified application by creating replication jobs for each server in the application.
- Parameters:
startAppReplicationRequest-- Returns:
- Result of the StartAppReplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startAppReplication
default StartAppReplicationResponse startAppReplication(Consumer<StartAppReplicationRequest.Builder> startAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaStartAppReplicationRequest.builder()- Parameters:
startAppReplicationRequest- AConsumerthat will call methods onStartAppReplicationRequest.Builderto create a request.- Returns:
- Result of the StartAppReplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startOnDemandAppReplication
default StartOnDemandAppReplicationResponse startOnDemandAppReplication(StartOnDemandAppReplicationRequest startOnDemandAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Starts an on-demand replication run for the specified application.
- Parameters:
startOnDemandAppReplicationRequest-- Returns:
- Result of the StartOnDemandAppReplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startOnDemandAppReplication
default StartOnDemandAppReplicationResponse startOnDemandAppReplication(Consumer<StartOnDemandAppReplicationRequest.Builder> startOnDemandAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Starts an on-demand replication run for the specified application.
This is a convenience which creates an instance of the
StartOnDemandAppReplicationRequest.Builderavoiding the need to create one manually viaStartOnDemandAppReplicationRequest.builder()- Parameters:
startOnDemandAppReplicationRequest- AConsumerthat will call methods onStartOnDemandAppReplicationRequest.Builderto create a request.- Returns:
- Result of the StartOnDemandAppReplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startOnDemandReplicationRun
default StartOnDemandReplicationRunResponse startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ReplicationRunLimitExceededException, DryRunOperationException, AwsServiceException, SdkClientException, SmsException
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:
- Result of the StartOnDemandReplicationRun operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startOnDemandReplicationRun
default StartOnDemandReplicationRunResponse startOnDemandReplicationRun(Consumer<StartOnDemandReplicationRunRequest.Builder> startOnDemandReplicationRunRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ReplicationRunLimitExceededException, DryRunOperationException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaStartOnDemandReplicationRunRequest.builder()- Parameters:
startOnDemandReplicationRunRequest- AConsumerthat will call methods onStartOnDemandReplicationRunRequest.Builderto create a request.- Returns:
- Result of the StartOnDemandReplicationRun operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopAppReplication
default StopAppReplicationResponse stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Stops replicating the specified application by deleting the replication job for each server in the application.
- Parameters:
stopAppReplicationRequest-- Returns:
- Result of the StopAppReplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopAppReplication
default StopAppReplicationResponse stopAppReplication(Consumer<StopAppReplicationRequest.Builder> stopAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
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.Builderavoiding the need to create one manually viaStopAppReplicationRequest.builder()- Parameters:
stopAppReplicationRequest- AConsumerthat will call methods onStopAppReplicationRequest.Builderto create a request.- Returns:
- Result of the StopAppReplication operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
terminateApp
default TerminateAppResponse terminateApp(TerminateAppRequest terminateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Terminates the stack for the specified application.
- Parameters:
terminateAppRequest-- Returns:
- Result of the TerminateApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
terminateApp
default TerminateAppResponse terminateApp(Consumer<TerminateAppRequest.Builder> terminateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Terminates the stack for the specified application.
This is a convenience which creates an instance of the
TerminateAppRequest.Builderavoiding the need to create one manually viaTerminateAppRequest.builder()- Parameters:
terminateAppRequest- AConsumerthat will call methods onTerminateAppRequest.Builderto create a request.- Returns:
- Result of the TerminateApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateApp
default UpdateAppResponse updateApp(UpdateAppRequest updateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Updates the specified application.
- Parameters:
updateAppRequest-- Returns:
- Result of the UpdateApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateApp
default UpdateAppResponse updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Updates the specified application.
This is a convenience which creates an instance of the
UpdateAppRequest.Builderavoiding the need to create one manually viaUpdateAppRequest.builder()- Parameters:
updateAppRequest- AConsumerthat will call methods onUpdateAppRequest.Builderto create a request.- Returns:
- Result of the UpdateApp operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateReplicationJob
default UpdateReplicationJobResponse updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest) throws InvalidParameterException, MissingRequiredParameterException, OperationNotPermittedException, UnauthorizedOperationException, ServerCannotBeReplicatedException, ReplicationJobNotFoundException, InternalErrorException, TemporarilyUnavailableException, AwsServiceException, SdkClientException, SmsException
Updates the specified settings for the specified replication job.
- Parameters:
updateReplicationJobRequest-- Returns:
- Result of the UpdateReplicationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateReplicationJob
default UpdateReplicationJobResponse updateReplicationJob(Consumer<UpdateReplicationJobRequest.Builder> updateReplicationJobRequest) throws InvalidParameterException, MissingRequiredParameterException, OperationNotPermittedException, UnauthorizedOperationException, ServerCannotBeReplicatedException, ReplicationJobNotFoundException, InternalErrorException, TemporarilyUnavailableException, AwsServiceException, SdkClientException, SmsException
Updates the specified settings for the specified replication job.
This is a convenience which creates an instance of the
UpdateReplicationJobRequest.Builderavoiding the need to create one manually viaUpdateReplicationJobRequest.builder()- Parameters:
updateReplicationJobRequest- AConsumerthat will call methods onUpdateReplicationJobRequest.Builderto create a request.- Returns:
- Result of the UpdateReplicationJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static SmsClient create()
Create aSmsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SmsClientBuilder builder()
Create a builder that can be used to configure and create aSmsClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SmsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-