@Generated(value="software.amazon.awssdk:codegen") public interface SmsClient extends SdkClient
builder()
method.
This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
To learn more about the Server Migration Service, see the following resources:
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static SmsClientBuilder |
builder()
Create a builder that can be used to configure and create a
SmsClient . |
static SmsClient |
create()
Create a
SmsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateAppResponse |
createApp(Consumer<CreateAppRequest.Builder> createAppRequest)
Creates an application.
|
default CreateAppResponse |
createApp(CreateAppRequest createAppRequest)
Creates an application.
|
default CreateReplicationJobResponse |
createReplicationJob(Consumer<CreateReplicationJobRequest.Builder> createReplicationJobRequest)
Creates a replication job.
|
default CreateReplicationJobResponse |
createReplicationJob(CreateReplicationJobRequest createReplicationJobRequest)
Creates a replication job.
|
default DeleteAppResponse |
deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)
Deletes an existing application.
|
default DeleteAppResponse |
deleteApp(DeleteAppRequest deleteAppRequest)
Deletes an existing application.
|
default DeleteAppLaunchConfigurationResponse |
deleteAppLaunchConfiguration(Consumer<DeleteAppLaunchConfigurationRequest.Builder> deleteAppLaunchConfigurationRequest)
Deletes existing launch configuration for an application.
|
default DeleteAppLaunchConfigurationResponse |
deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest)
Deletes existing launch configuration for an application.
|
default DeleteAppReplicationConfigurationResponse |
deleteAppReplicationConfiguration(Consumer<DeleteAppReplicationConfigurationRequest.Builder> deleteAppReplicationConfigurationRequest)
Deletes existing replication configuration for an application.
|
default DeleteAppReplicationConfigurationResponse |
deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest)
Deletes existing replication configuration for an application.
|
default DeleteReplicationJobResponse |
deleteReplicationJob(Consumer<DeleteReplicationJobRequest.Builder> deleteReplicationJobRequest)
Deletes the specified replication job.
|
default DeleteReplicationJobResponse |
deleteReplicationJob(DeleteReplicationJobRequest deleteReplicationJobRequest)
Deletes the specified replication job.
|
default DeleteServerCatalogResponse |
deleteServerCatalog()
Deletes all servers from your server catalog.
|
default DeleteServerCatalogResponse |
deleteServerCatalog(Consumer<DeleteServerCatalogRequest.Builder> deleteServerCatalogRequest)
Deletes all servers from your server catalog.
|
default DeleteServerCatalogResponse |
deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest)
Deletes all servers from your server catalog.
|
default DisassociateConnectorResponse |
disassociateConnector(Consumer<DisassociateConnectorRequest.Builder> disassociateConnectorRequest)
Disassociates the specified connector from AWS SMS.
|
default DisassociateConnectorResponse |
disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest)
Disassociates the specified connector from AWS SMS.
|
default GenerateChangeSetResponse |
generateChangeSet(Consumer<GenerateChangeSetRequest.Builder> generateChangeSetRequest)
Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the
customer’s Amazon S3 bucket.
|
default GenerateChangeSetResponse |
generateChangeSet(GenerateChangeSetRequest generateChangeSetRequest)
Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the
customer’s Amazon S3 bucket.
|
default GenerateTemplateResponse |
generateTemplate(Consumer<GenerateTemplateRequest.Builder> generateTemplateRequest)
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon
S3 object in the customer’s Amazon S3 bucket.
|
default GenerateTemplateResponse |
generateTemplate(GenerateTemplateRequest generateTemplateRequest)
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon
S3 object in the customer’s Amazon S3 bucket.
|
default GetAppResponse |
getApp()
Retrieve information about an application.
|
default GetAppResponse |
getApp(Consumer<GetAppRequest.Builder> getAppRequest)
Retrieve information about an application.
|
default GetAppResponse |
getApp(GetAppRequest getAppRequest)
Retrieve information about an application.
|
default GetAppLaunchConfigurationResponse |
getAppLaunchConfiguration()
Retrieves the application launch configuration associated with an application.
|
default GetAppLaunchConfigurationResponse |
getAppLaunchConfiguration(Consumer<GetAppLaunchConfigurationRequest.Builder> getAppLaunchConfigurationRequest)
Retrieves the application launch configuration associated with an application.
|
default GetAppLaunchConfigurationResponse |
getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest)
Retrieves the application launch configuration associated with an application.
|
default GetAppReplicationConfigurationResponse |
getAppReplicationConfiguration()
Retrieves an application replication configuration associatd with an application.
|
default GetAppReplicationConfigurationResponse |
getAppReplicationConfiguration(Consumer<GetAppReplicationConfigurationRequest.Builder> getAppReplicationConfigurationRequest)
Retrieves an application replication configuration associatd with an application.
|
default GetAppReplicationConfigurationResponse |
getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest)
Retrieves an application replication configuration associatd with an application.
|
default GetConnectorsResponse |
getConnectors()
Describes the connectors registered with the AWS SMS.
|
default GetConnectorsResponse |
getConnectors(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest)
Describes the connectors registered with the AWS SMS.
|
default GetConnectorsResponse |
getConnectors(GetConnectorsRequest getConnectorsRequest)
Describes the connectors registered with the AWS SMS.
|
default GetConnectorsIterable |
getConnectorsPaginator()
Describes the connectors registered with the AWS SMS.
|
default GetConnectorsIterable |
getConnectorsPaginator(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest)
Describes the connectors registered with the AWS SMS.
|
default GetConnectorsIterable |
getConnectorsPaginator(GetConnectorsRequest getConnectorsRequest)
Describes the connectors registered with the AWS SMS.
|
default GetReplicationJobsResponse |
getReplicationJobs()
Describes the specified replication job or all of your replication jobs.
|
default GetReplicationJobsResponse |
getReplicationJobs(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest)
Describes the specified replication job or all of your replication jobs.
|
default GetReplicationJobsResponse |
getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest)
Describes the specified replication job or all of your replication jobs.
|
default GetReplicationJobsIterable |
getReplicationJobsPaginator()
Describes the specified replication job or all of your replication jobs.
|
default GetReplicationJobsIterable |
getReplicationJobsPaginator(Consumer<GetReplicationJobsRequest.Builder> getReplicationJobsRequest)
Describes the specified replication job or all of your replication jobs.
|
default GetReplicationJobsIterable |
getReplicationJobsPaginator(GetReplicationJobsRequest getReplicationJobsRequest)
Describes the specified replication job or all of your replication jobs.
|
default GetReplicationRunsResponse |
getReplicationRuns(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest)
Describes the replication runs for the specified replication job.
|
default GetReplicationRunsResponse |
getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest)
Describes the replication runs for the specified replication job.
|
default GetReplicationRunsIterable |
getReplicationRunsPaginator(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest)
Describes the replication runs for the specified replication job.
|
default GetReplicationRunsIterable |
getReplicationRunsPaginator(GetReplicationRunsRequest getReplicationRunsRequest)
Describes the replication runs for the specified replication job.
|
default GetServersResponse |
getServers()
Describes the servers in your server catalog.
|
default GetServersResponse |
getServers(Consumer<GetServersRequest.Builder> getServersRequest)
Describes the servers in your server catalog.
|
default GetServersResponse |
getServers(GetServersRequest getServersRequest)
Describes the servers in your server catalog.
|
default GetServersIterable |
getServersPaginator()
Describes the servers in your server catalog.
|
default GetServersIterable |
getServersPaginator(Consumer<GetServersRequest.Builder> getServersRequest)
Describes the servers in your server catalog.
|
default GetServersIterable |
getServersPaginator(GetServersRequest getServersRequest)
Describes the servers in your server catalog.
|
default ImportServerCatalogResponse |
importServerCatalog()
Gathers a complete list of on-premises servers.
|
default ImportServerCatalogResponse |
importServerCatalog(Consumer<ImportServerCatalogRequest.Builder> importServerCatalogRequest)
Gathers a complete list of on-premises servers.
|
default ImportServerCatalogResponse |
importServerCatalog(ImportServerCatalogRequest importServerCatalogRequest)
Gathers a complete list of on-premises servers.
|
default LaunchAppResponse |
launchApp(Consumer<LaunchAppRequest.Builder> launchAppRequest)
Launches an application stack.
|
default LaunchAppResponse |
launchApp(LaunchAppRequest launchAppRequest)
Launches an application stack.
|
default ListAppsResponse |
listApps()
Returns a list of summaries for all applications.
|
default ListAppsResponse |
listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)
Returns a list of summaries for all applications.
|
default ListAppsResponse |
listApps(ListAppsRequest listAppsRequest)
Returns a list of summaries for all applications.
|
default PutAppLaunchConfigurationResponse |
putAppLaunchConfiguration(Consumer<PutAppLaunchConfigurationRequest.Builder> putAppLaunchConfigurationRequest)
Creates a launch configuration for an application.
|
default PutAppLaunchConfigurationResponse |
putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest)
Creates a launch configuration for an application.
|
default PutAppReplicationConfigurationResponse |
putAppReplicationConfiguration(Consumer<PutAppReplicationConfigurationRequest.Builder> putAppReplicationConfigurationRequest)
Creates or updates a replication configuration for an application.
|
default PutAppReplicationConfigurationResponse |
putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest)
Creates or updates a replication configuration for an application.
|
static ServiceMetadata |
serviceMetadata() |
default StartAppReplicationResponse |
startAppReplication(Consumer<StartAppReplicationRequest.Builder> startAppReplicationRequest)
Starts replicating an application.
|
default StartAppReplicationResponse |
startAppReplication(StartAppReplicationRequest startAppReplicationRequest)
Starts replicating an application.
|
default StartOnDemandReplicationRunResponse |
startOnDemandReplicationRun(Consumer<StartOnDemandReplicationRunRequest.Builder> startOnDemandReplicationRunRequest)
Starts an on-demand replication run for the specified replication job.
|
default StartOnDemandReplicationRunResponse |
startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest)
Starts an on-demand replication run for the specified replication job.
|
default StopAppReplicationResponse |
stopAppReplication(Consumer<StopAppReplicationRequest.Builder> stopAppReplicationRequest)
Stops replicating an application.
|
default StopAppReplicationResponse |
stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest)
Stops replicating an application.
|
default TerminateAppResponse |
terminateApp(Consumer<TerminateAppRequest.Builder> terminateAppRequest)
Terminates the stack for an application.
|
default TerminateAppResponse |
terminateApp(TerminateAppRequest terminateAppRequest)
Terminates the stack for an application.
|
default UpdateAppResponse |
updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest)
Updates an application.
|
default UpdateAppResponse |
updateApp(UpdateAppRequest updateAppRequest)
Updates an application.
|
default UpdateReplicationJobResponse |
updateReplicationJob(Consumer<UpdateReplicationJobRequest.Builder> updateReplicationJobRequest)
Updates the specified settings for the specified replication job.
|
default UpdateReplicationJobResponse |
updateReplicationJob(UpdateReplicationJobRequest updateReplicationJobRequest)
Updates the specified settings for the specified replication job.
|
serviceName
close
static final String SERVICE_NAME
static SmsClient create()
SmsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SmsClientBuilder builder()
SmsClient
.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.
createAppRequest
- 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
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.Builder
avoiding the need to
create one manually via CreateAppRequest.builder()
createAppRequest
- A Consumer
that will call methods on CreateAppRequest.Builder
to create a request.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
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 AWS. Each replication run creates an Amazon Machine Image (AMI).
createReplicationJobRequest
- 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
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 AWS. Each replication run creates an Amazon Machine Image (AMI).
This is a convenience which creates an instance of the CreateReplicationJobRequest.Builder
avoiding the
need to create one manually via CreateReplicationJobRequest.builder()
createReplicationJobRequest
- A Consumer
that will call methods on CreateReplicationJobRequest.Builder
to create a
request.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
default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.
deleteAppRequest
- 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
default DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.
This is a convenience which creates an instance of the DeleteAppRequest.Builder
avoiding the need to
create one manually via DeleteAppRequest.builder()
deleteAppRequest
- A Consumer
that will call methods on DeleteAppRequest.Builder
to create a request.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
default DeleteAppLaunchConfigurationResponse deleteAppLaunchConfiguration(DeleteAppLaunchConfigurationRequest deleteAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes existing launch configuration for an application.
deleteAppLaunchConfigurationRequest
- 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
default DeleteAppLaunchConfigurationResponse deleteAppLaunchConfiguration(Consumer<DeleteAppLaunchConfigurationRequest.Builder> deleteAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes existing launch configuration for an application.
This is a convenience which creates an instance of the DeleteAppLaunchConfigurationRequest.Builder
avoiding the need to create one manually via DeleteAppLaunchConfigurationRequest.builder()
deleteAppLaunchConfigurationRequest
- A Consumer
that will call methods on DeleteAppLaunchConfigurationRequest.Builder
to create
a request.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
default DeleteAppReplicationConfigurationResponse deleteAppReplicationConfiguration(DeleteAppReplicationConfigurationRequest deleteAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes existing replication configuration for an application.
deleteAppReplicationConfigurationRequest
- 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
default DeleteAppReplicationConfigurationResponse deleteAppReplicationConfiguration(Consumer<DeleteAppReplicationConfigurationRequest.Builder> deleteAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Deletes existing replication configuration for an application.
This is a convenience which creates an instance of the DeleteAppReplicationConfigurationRequest.Builder
avoiding the need to create one manually via DeleteAppReplicationConfigurationRequest.builder()
deleteAppReplicationConfigurationRequest
- A Consumer
that will call methods on DeleteAppReplicationConfigurationRequest.Builder
to
create a request.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
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. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.
deleteReplicationJobRequest
- 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
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. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.
This is a convenience which creates an instance of the DeleteReplicationJobRequest.Builder
avoiding the
need to create one manually via DeleteReplicationJobRequest.builder()
deleteReplicationJobRequest
- A Consumer
that will call methods on DeleteReplicationJobRequest.Builder
to create a
request.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
default DeleteServerCatalogResponse deleteServerCatalog() throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, AwsServiceException, SdkClientException, SmsException
Deletes all servers from your server catalog.
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
deleteServerCatalog(DeleteServerCatalogRequest)
,
AWS API
Documentationdefault DeleteServerCatalogResponse deleteServerCatalog(DeleteServerCatalogRequest deleteServerCatalogRequest) throws UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, AwsServiceException, SdkClientException, SmsException
Deletes all servers from your server catalog.
deleteServerCatalogRequest
- 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
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.Builder
avoiding the
need to create one manually via DeleteServerCatalogRequest.builder()
deleteServerCatalogRequest
- A Consumer
that will call methods on DeleteServerCatalogRequest.Builder
to create a
request.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
default DisassociateConnectorResponse disassociateConnector(DisassociateConnectorRequest disassociateConnectorRequest) throws MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, SmsException
Disassociates the specified connector from AWS SMS.
After you disassociate a connector, it is no longer available to support replication jobs.
disassociateConnectorRequest
- 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
default DisassociateConnectorResponse disassociateConnector(Consumer<DisassociateConnectorRequest.Builder> disassociateConnectorRequest) throws MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, SmsException
Disassociates the specified connector from AWS SMS.
After you disassociate a connector, it is no longer available to support replication jobs.
This is a convenience which creates an instance of the DisassociateConnectorRequest.Builder
avoiding the
need to create one manually via DisassociateConnectorRequest.builder()
disassociateConnectorRequest
- A Consumer
that will call methods on DisassociateConnectorRequest.Builder
to create a
request.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
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.
generateChangeSetRequest
- 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
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.Builder
avoiding the need
to create one manually via GenerateChangeSetRequest.builder()
generateChangeSetRequest
- A Consumer
that will call methods on GenerateChangeSetRequest.Builder
to create a request.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
default GenerateTemplateResponse generateTemplate(GenerateTemplateRequest generateTemplateRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
generateTemplateRequest
- 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
default GenerateTemplateResponse generateTemplate(Consumer<GenerateTemplateRequest.Builder> generateTemplateRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
This is a convenience which creates an instance of the GenerateTemplateRequest.Builder
avoiding the need
to create one manually via GenerateTemplateRequest.builder()
generateTemplateRequest
- A Consumer
that will call methods on GenerateTemplateRequest.Builder
to create a request.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
default GetAppResponse getApp() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieve information about an application.
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
getApp(GetAppRequest)
,
AWS API
Documentationdefault GetAppResponse getApp(GetAppRequest getAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieve information about an application.
getAppRequest
- 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
default GetAppResponse getApp(Consumer<GetAppRequest.Builder> getAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieve information about an application.
This is a convenience which creates an instance of the GetAppRequest.Builder
avoiding the need to create
one manually via GetAppRequest.builder()
getAppRequest
- A Consumer
that will call methods on GetAppRequest.Builder
to create a request.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
default GetAppLaunchConfigurationResponse getAppLaunchConfiguration() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application launch configuration associated with an application.
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
getAppLaunchConfiguration(GetAppLaunchConfigurationRequest)
,
AWS
API Documentationdefault GetAppLaunchConfigurationResponse getAppLaunchConfiguration(GetAppLaunchConfigurationRequest getAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application launch configuration associated with an application.
getAppLaunchConfigurationRequest
- 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
default GetAppLaunchConfigurationResponse getAppLaunchConfiguration(Consumer<GetAppLaunchConfigurationRequest.Builder> getAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves the application launch configuration associated with an application.
This is a convenience which creates an instance of the GetAppLaunchConfigurationRequest.Builder
avoiding
the need to create one manually via GetAppLaunchConfigurationRequest.builder()
getAppLaunchConfigurationRequest
- A Consumer
that will call methods on GetAppLaunchConfigurationRequest.Builder
to create a
request.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
default GetAppReplicationConfigurationResponse getAppReplicationConfiguration() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves an application replication configuration associatd with an application.
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
getAppReplicationConfiguration(GetAppReplicationConfigurationRequest)
,
AWS API Documentationdefault GetAppReplicationConfigurationResponse getAppReplicationConfiguration(GetAppReplicationConfigurationRequest getAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves an application replication configuration associatd with an application.
getAppReplicationConfigurationRequest
- 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
default GetAppReplicationConfigurationResponse getAppReplicationConfiguration(Consumer<GetAppReplicationConfigurationRequest.Builder> getAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Retrieves an application replication configuration associatd with an application.
This is a convenience which creates an instance of the GetAppReplicationConfigurationRequest.Builder
avoiding the need to create one manually via GetAppReplicationConfigurationRequest.builder()
getAppReplicationConfigurationRequest
- A Consumer
that will call methods on GetAppReplicationConfigurationRequest.Builder
to
create a request.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
default GetConnectorsResponse getConnectors() throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the AWS SMS.
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
getConnectors(GetConnectorsRequest)
,
AWS API
Documentationdefault GetConnectorsResponse getConnectors(GetConnectorsRequest getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the AWS SMS.
getConnectorsRequest
- 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
default GetConnectorsResponse getConnectors(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the AWS SMS.
This is a convenience which creates an instance of the GetConnectorsRequest.Builder
avoiding the need to
create one manually via GetConnectorsRequest.builder()
getConnectorsRequest
- A Consumer
that will call methods on GetConnectorsRequest.Builder
to create a request.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
default GetConnectorsIterable getConnectorsPaginator() throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the AWS SMS.
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
software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.
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
getConnectorsPaginator(GetConnectorsRequest)
,
AWS API
Documentationdefault GetConnectorsIterable getConnectorsPaginator(GetConnectorsRequest getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the AWS SMS.
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
software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.
getConnectorsRequest
- 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
default GetConnectorsIterable getConnectorsPaginator(Consumer<GetConnectorsRequest.Builder> getConnectorsRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the connectors registered with the AWS SMS.
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
software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetConnectorsIterable responses = client.getConnectorsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getConnectors(software.amazon.awssdk.services.sms.model.GetConnectorsRequest)
operation.
This is a convenience which creates an instance of the GetConnectorsRequest.Builder
avoiding the need to
create one manually via GetConnectorsRequest.builder()
getConnectorsRequest
- A Consumer
that will call methods on GetConnectorsRequest.Builder
to create a request.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
default GetReplicationJobsResponse getReplicationJobs() throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the specified replication job or all of your replication jobs.
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
getReplicationJobs(GetReplicationJobsRequest)
,
AWS API
Documentationdefault GetReplicationJobsResponse getReplicationJobs(GetReplicationJobsRequest getReplicationJobsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the specified replication job or all of your replication jobs.
getReplicationJobsRequest
- 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
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.Builder
avoiding the
need to create one manually via GetReplicationJobsRequest.builder()
getReplicationJobsRequest
- A Consumer
that will call methods on GetReplicationJobsRequest.Builder
to create a
request.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
default GetReplicationJobsIterable getReplicationJobsPaginator() throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the specified replication job or all of your replication jobs.
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
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.
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
getReplicationJobsPaginator(GetReplicationJobsRequest)
,
AWS API
Documentationdefault GetReplicationJobsIterable getReplicationJobsPaginator(GetReplicationJobsRequest getReplicationJobsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the specified replication job or all of your replication jobs.
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
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.
getReplicationJobsRequest
- 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
default GetReplicationJobsIterable getReplicationJobsPaginator(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 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
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetReplicationJobsIterable responses = client.getReplicationJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getReplicationJobs(software.amazon.awssdk.services.sms.model.GetReplicationJobsRequest)
operation.
This is a convenience which creates an instance of the GetReplicationJobsRequest.Builder
avoiding the
need to create one manually via GetReplicationJobsRequest.builder()
getReplicationJobsRequest
- A Consumer
that will call methods on GetReplicationJobsRequest.Builder
to create a
request.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
default GetReplicationRunsResponse getReplicationRuns(GetReplicationRunsRequest getReplicationRunsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the replication runs for the specified replication job.
getReplicationRunsRequest
- 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
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.Builder
avoiding the
need to create one manually via GetReplicationRunsRequest.builder()
getReplicationRunsRequest
- A Consumer
that will call methods on GetReplicationRunsRequest.Builder
to create a
request.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
default GetReplicationRunsIterable getReplicationRunsPaginator(GetReplicationRunsRequest getReplicationRunsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the replication runs for the specified replication job.
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
software.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation.
getReplicationRunsRequest
- 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
default GetReplicationRunsIterable getReplicationRunsPaginator(Consumer<GetReplicationRunsRequest.Builder> getReplicationRunsRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the replication runs for the specified replication job.
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
software.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetReplicationRunsIterable responses = client.getReplicationRunsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getReplicationRuns(software.amazon.awssdk.services.sms.model.GetReplicationRunsRequest)
operation.
This is a convenience which creates an instance of the GetReplicationRunsRequest.Builder
avoiding the
need to create one manually via GetReplicationRunsRequest.builder()
getReplicationRunsRequest
- A Consumer
that will call methods on GetReplicationRunsRequest.Builder
to create a
request.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
default GetServersResponse getServers() throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
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
getServers(GetServersRequest)
,
AWS API
Documentationdefault GetServersResponse getServers(GetServersRequest getServersRequest) throws UnauthorizedOperationException, AwsServiceException, SdkClientException, SmsException
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
getServersRequest
- 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
default GetServersResponse getServers(Consumer<GetServersRequest.Builder> getServersRequest) throws UnauthorizedOperationException, 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.Builder
avoiding the need to
create one manually via GetServersRequest.builder()
getServersRequest
- A Consumer
that will call methods on GetServersRequest.Builder
to create a request.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
default GetServersIterable getServersPaginator() throws UnauthorizedOperationException, 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 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
software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.
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
getServersPaginator(GetServersRequest)
,
AWS API
Documentationdefault GetServersIterable getServersPaginator(GetServersRequest getServersRequest) throws UnauthorizedOperationException, 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 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
software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.
getServersRequest
- 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
default GetServersIterable getServersPaginator(Consumer<GetServersRequest.Builder> getServersRequest) throws UnauthorizedOperationException, 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 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
software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.sms.paginators.GetServersIterable responses = client.getServersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getServers(software.amazon.awssdk.services.sms.model.GetServersRequest)
operation.
This is a convenience which creates an instance of the GetServersRequest.Builder
avoiding the need to
create one manually via GetServersRequest.builder()
getServersRequest
- A Consumer
that will call methods on GetServersRequest.Builder
to create a request.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
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 that you want to import.
This call returns immediately, but might take additional time to retrieve all the servers.
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
importServerCatalog(ImportServerCatalogRequest)
,
AWS API
Documentationdefault 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 that you want to import.
This call returns immediately, but might take additional time to retrieve all the servers.
importServerCatalogRequest
- 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
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 that you want to import.
This call returns immediately, but might take additional time to retrieve all the servers.
This is a convenience which creates an instance of the ImportServerCatalogRequest.Builder
avoiding the
need to create one manually via ImportServerCatalogRequest.builder()
importServerCatalogRequest
- A Consumer
that will call methods on ImportServerCatalogRequest.Builder
to create a
request.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
default LaunchAppResponse launchApp(LaunchAppRequest launchAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Launches an application stack.
launchAppRequest
- 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
default LaunchAppResponse launchApp(Consumer<LaunchAppRequest.Builder> launchAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Launches an application stack.
This is a convenience which creates an instance of the LaunchAppRequest.Builder
avoiding the need to
create one manually via LaunchAppRequest.builder()
launchAppRequest
- A Consumer
that will call methods on LaunchAppRequest.Builder
to create a request.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
default ListAppsResponse listApps() throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Returns a list of summaries for all applications.
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
listApps(ListAppsRequest)
,
AWS API
Documentationdefault ListAppsResponse listApps(ListAppsRequest listAppsRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Returns a list of summaries for all applications.
listAppsRequest
- 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
default ListAppsResponse listApps(Consumer<ListAppsRequest.Builder> listAppsRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Returns a list of summaries for all applications.
This is a convenience which creates an instance of the ListAppsRequest.Builder
avoiding the need to
create one manually via ListAppsRequest.builder()
listAppsRequest
- A Consumer
that will call methods on ListAppsRequest.Builder
to create a request.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
default PutAppLaunchConfigurationResponse putAppLaunchConfiguration(PutAppLaunchConfigurationRequest putAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates a launch configuration for an application.
putAppLaunchConfigurationRequest
- 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
default PutAppLaunchConfigurationResponse putAppLaunchConfiguration(Consumer<PutAppLaunchConfigurationRequest.Builder> putAppLaunchConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates a launch configuration for an application.
This is a convenience which creates an instance of the PutAppLaunchConfigurationRequest.Builder
avoiding
the need to create one manually via PutAppLaunchConfigurationRequest.builder()
putAppLaunchConfigurationRequest
- A Consumer
that will call methods on PutAppLaunchConfigurationRequest.Builder
to create a
request.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
default PutAppReplicationConfigurationResponse putAppReplicationConfiguration(PutAppReplicationConfigurationRequest putAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates a replication configuration for an application.
putAppReplicationConfigurationRequest
- 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
default PutAppReplicationConfigurationResponse putAppReplicationConfiguration(Consumer<PutAppReplicationConfigurationRequest.Builder> putAppReplicationConfigurationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Creates or updates a replication configuration for an application.
This is a convenience which creates an instance of the PutAppReplicationConfigurationRequest.Builder
avoiding the need to create one manually via PutAppReplicationConfigurationRequest.builder()
putAppReplicationConfigurationRequest
- A Consumer
that will call methods on PutAppReplicationConfigurationRequest.Builder
to
create a request.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
default StartAppReplicationResponse startAppReplication(StartAppReplicationRequest startAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Starts replicating an application.
startAppReplicationRequest
- 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
default StartAppReplicationResponse startAppReplication(Consumer<StartAppReplicationRequest.Builder> startAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Starts replicating an application.
This is a convenience which creates an instance of the StartAppReplicationRequest.Builder
avoiding the
need to create one manually via StartAppReplicationRequest.builder()
startAppReplicationRequest
- A Consumer
that will call methods on StartAppReplicationRequest.Builder
to create a
request.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
default StartOnDemandReplicationRunResponse startOnDemandReplicationRun(StartOnDemandReplicationRunRequest startOnDemandReplicationRunRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ReplicationRunLimitExceededException, 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 you can request in a 24-hour period.
startOnDemandReplicationRunRequest
- 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.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
default StartOnDemandReplicationRunResponse startOnDemandReplicationRun(Consumer<StartOnDemandReplicationRunRequest.Builder> startOnDemandReplicationRunRequest) throws InvalidParameterException, MissingRequiredParameterException, UnauthorizedOperationException, OperationNotPermittedException, ReplicationRunLimitExceededException, 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 you can request in a 24-hour period.
This is a convenience which creates an instance of the StartOnDemandReplicationRunRequest.Builder
avoiding the need to create one manually via StartOnDemandReplicationRunRequest.builder()
startOnDemandReplicationRunRequest
- A Consumer
that will call methods on StartOnDemandReplicationRunRequest.Builder
to create
a request.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.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
default StopAppReplicationResponse stopAppReplication(StopAppReplicationRequest stopAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Stops replicating an application.
stopAppReplicationRequest
- 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
default StopAppReplicationResponse stopAppReplication(Consumer<StopAppReplicationRequest.Builder> stopAppReplicationRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Stops replicating an application.
This is a convenience which creates an instance of the StopAppReplicationRequest.Builder
avoiding the
need to create one manually via StopAppReplicationRequest.builder()
stopAppReplicationRequest
- A Consumer
that will call methods on StopAppReplicationRequest.Builder
to create a
request.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
default TerminateAppResponse terminateApp(TerminateAppRequest terminateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Terminates the stack for an application.
terminateAppRequest
- 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
default TerminateAppResponse terminateApp(Consumer<TerminateAppRequest.Builder> terminateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Terminates the stack for an application.
This is a convenience which creates an instance of the TerminateAppRequest.Builder
avoiding the need to
create one manually via TerminateAppRequest.builder()
terminateAppRequest
- A Consumer
that will call methods on TerminateAppRequest.Builder
to create a request.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
default UpdateAppResponse updateApp(UpdateAppRequest updateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Updates an application.
updateAppRequest
- 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
default UpdateAppResponse updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest) throws UnauthorizedOperationException, InvalidParameterException, MissingRequiredParameterException, InternalErrorException, OperationNotPermittedException, AwsServiceException, SdkClientException, SmsException
Updates an application.
This is a convenience which creates an instance of the UpdateAppRequest.Builder
avoiding the need to
create one manually via UpdateAppRequest.builder()
updateAppRequest
- A Consumer
that will call methods on UpdateAppRequest.Builder
to create a request.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
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.
updateReplicationJobRequest
- 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
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.Builder
avoiding the
need to create one manually via UpdateReplicationJobRequest.builder()
updateReplicationJobRequest
- A Consumer
that will call methods on UpdateReplicationJobRequest.Builder
to create a
request.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
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.