Package software.amazon.awssdk.services.ssmsap

Interface SsmSapAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SsmSapAsyncClient extends AwsClient
Service client for accessing SsmSap asynchronously. This can be created using the static builder() method.

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Systems Manager for SAP. The topic for each action shows the API request parameters and responses.

  • Field Details

  • Method Details

    • deleteResourcePermission

      default CompletableFuture<DeleteResourcePermissionResponse> deleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest)

      Removes permissions associated with the target database.

      Parameters:
      deleteResourcePermissionRequest -
      Returns:
      A Java Future containing the result of the DeleteResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePermission

      default CompletableFuture<DeleteResourcePermissionResponse> deleteResourcePermission(Consumer<DeleteResourcePermissionRequest.Builder> deleteResourcePermissionRequest)

      Removes permissions associated with the target database.


      This is a convenience which creates an instance of the DeleteResourcePermissionRequest.Builder avoiding the need to create one manually via DeleteResourcePermissionRequest.builder()

      Parameters:
      deleteResourcePermissionRequest - A Consumer that will call methods on DeleteResourcePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterApplication

      default CompletableFuture<DeregisterApplicationResponse> deregisterApplication(DeregisterApplicationRequest deregisterApplicationRequest)

      Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.

      Parameters:
      deregisterApplicationRequest -
      Returns:
      A Java Future containing the result of the DeregisterApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deregisterApplication

      default CompletableFuture<DeregisterApplicationResponse> deregisterApplication(Consumer<DeregisterApplicationRequest.Builder> deregisterApplicationRequest)

      Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.


      This is a convenience which creates an instance of the DeregisterApplicationRequest.Builder avoiding the need to create one manually via DeregisterApplicationRequest.builder()

      Parameters:
      deregisterApplicationRequest - A Consumer that will call methods on DeregisterApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest)

      Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.

      Parameters:
      getApplicationRequest -
      Returns:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getApplication

      default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)

      Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.


      This is a convenience which creates an instance of the GetApplicationRequest.Builder avoiding the need to create one manually via GetApplicationRequest.builder()

      Parameters:
      getApplicationRequest - A Consumer that will call methods on GetApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponent

      default CompletableFuture<GetComponentResponse> getComponent(GetComponentRequest getComponentRequest)

      Gets the component of an application registered with AWS Systems Manager for SAP.

      Parameters:
      getComponentRequest -
      Returns:
      A Java Future containing the result of the GetComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getComponent

      default CompletableFuture<GetComponentResponse> getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest)

      Gets the component of an application registered with AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the GetComponentRequest.Builder avoiding the need to create one manually via GetComponentRequest.builder()

      Parameters:
      getComponentRequest - A Consumer that will call methods on GetComponentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetComponent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDatabase

      default CompletableFuture<GetDatabaseResponse> getDatabase(GetDatabaseRequest getDatabaseRequest)

      Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.

      Parameters:
      getDatabaseRequest -
      Returns:
      A Java Future containing the result of the GetDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDatabase

      default CompletableFuture<GetDatabaseResponse> getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest)

      Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the GetDatabaseRequest.Builder avoiding the need to create one manually via GetDatabaseRequest.builder()

      Parameters:
      getDatabaseRequest - A Consumer that will call methods on GetDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperation

      default CompletableFuture<GetOperationResponse> getOperation(GetOperationRequest getOperationRequest)

      Gets the details of an operation by specifying the operation ID.

      Parameters:
      getOperationRequest -
      Returns:
      A Java Future containing the result of the GetOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperation

      default CompletableFuture<GetOperationResponse> getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)

      Gets the details of an operation by specifying the operation ID.


      This is a convenience which creates an instance of the GetOperationRequest.Builder avoiding the need to create one manually via GetOperationRequest.builder()

      Parameters:
      getOperationRequest - A Consumer that will call methods on GetOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePermission

      default CompletableFuture<GetResourcePermissionResponse> getResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest)

      Gets permissions associated with the target database.

      Parameters:
      getResourcePermissionRequest -
      Returns:
      A Java Future containing the result of the GetResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourcePermission

      default CompletableFuture<GetResourcePermissionResponse> getResourcePermission(Consumer<GetResourcePermissionRequest.Builder> getResourcePermissionRequest)

      Gets permissions associated with the target database.


      This is a convenience which creates an instance of the GetResourcePermissionRequest.Builder avoiding the need to create one manually via GetResourcePermissionRequest.builder()

      Parameters:
      getResourcePermissionRequest - A Consumer that will call methods on GetResourcePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)

      Lists all the applications registered with AWS Systems Manager for SAP.

      Parameters:
      listApplicationsRequest -
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplications

      default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      Lists all the applications registered with AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)

      Lists all the applications registered with AWS Systems Manager for SAP.


      This is a variant of listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest) operation.

      Parameters:
      listApplicationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationsPaginator

      default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

      Lists all the applications registered with AWS Systems Manager for SAP.


      This is a variant of listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest) operation.

      This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

      Parameters:
      listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(ListComponentsRequest listComponentsRequest)

      Lists all the components registered with AWS Systems Manager for SAP.

      Parameters:
      listComponentsRequest -
      Returns:
      A Java Future containing the result of the ListComponents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponents

      default CompletableFuture<ListComponentsResponse> listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

      Lists all the components registered with AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the ListComponentsRequest.Builder avoiding the need to create one manually via ListComponentsRequest.builder()

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListComponents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(ListComponentsRequest listComponentsRequest)

      Lists all the components registered with AWS Systems Manager for SAP.


      This is a variant of listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest) operation.

      Parameters:
      listComponentsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listComponentsPaginator

      default ListComponentsPublisher listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)

      Lists all the components registered with AWS Systems Manager for SAP.


      This is a variant of listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest) operation.

      This is a convenience which creates an instance of the ListComponentsRequest.Builder avoiding the need to create one manually via ListComponentsRequest.builder()

      Parameters:
      listComponentsRequest - A Consumer that will call methods on ListComponentsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabases

      default CompletableFuture<ListDatabasesResponse> listDatabases(ListDatabasesRequest listDatabasesRequest)

      Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

      Parameters:
      listDatabasesRequest -
      Returns:
      A Java Future containing the result of the ListDatabases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabases

      default CompletableFuture<ListDatabasesResponse> listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)

      Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to create one manually via ListDatabasesRequest.builder()

      Parameters:
      listDatabasesRequest - A Consumer that will call methods on ListDatabasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDatabases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabasesPaginator

      default ListDatabasesPublisher listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)

      Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.


      This is a variant of listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest) operation.

      Parameters:
      listDatabasesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabasesPaginator

      default ListDatabasesPublisher listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)

      Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.


      This is a variant of listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest) operation.

      This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to create one manually via ListDatabasesRequest.builder()

      Parameters:
      listDatabasesRequest - A Consumer that will call methods on ListDatabasesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperations

      default CompletableFuture<ListOperationsResponse> listOperations(ListOperationsRequest listOperationsRequest)

      Lists the operations performed by AWS Systems Manager for SAP.

      Parameters:
      listOperationsRequest -
      Returns:
      A Java Future containing the result of the ListOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperations

      default CompletableFuture<ListOperationsResponse> listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest)

      Lists the operations performed by AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the ListOperationsRequest.Builder avoiding the need to create one manually via ListOperationsRequest.builder()

      Parameters:
      listOperationsRequest - A Consumer that will call methods on ListOperationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperationsPaginator

      default ListOperationsPublisher listOperationsPaginator(ListOperationsRequest listOperationsRequest)

      Lists the operations performed by AWS Systems Manager for SAP.


      This is a variant of listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest) operation.

      Parameters:
      listOperationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listOperationsPaginator

      default ListOperationsPublisher listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest)

      Lists the operations performed by AWS Systems Manager for SAP.


      This is a variant of listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest) operation.

      This is a convenience which creates an instance of the ListOperationsRequest.Builder avoiding the need to create one manually via ListOperationsRequest.builder()

      Parameters:
      listOperationsRequest - A Consumer that will call methods on ListOperationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePermission

      default CompletableFuture<PutResourcePermissionResponse> putResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest)

      Adds permissions to the target database.

      Parameters:
      putResourcePermissionRequest -
      Returns:
      A Java Future containing the result of the PutResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePermission

      default CompletableFuture<PutResourcePermissionResponse> putResourcePermission(Consumer<PutResourcePermissionRequest.Builder> putResourcePermissionRequest)

      Adds permissions to the target database.


      This is a convenience which creates an instance of the PutResourcePermissionRequest.Builder avoiding the need to create one manually via PutResourcePermissionRequest.builder()

      Parameters:
      putResourcePermissionRequest - A Consumer that will call methods on PutResourcePermissionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutResourcePermission operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerApplication

      default CompletableFuture<RegisterApplicationResponse> registerApplication(RegisterApplicationRequest registerApplicationRequest)

      Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.

      The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.

      AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.

      Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.

      Parameters:
      registerApplicationRequest -
      Returns:
      A Java Future containing the result of the RegisterApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerApplication

      default CompletableFuture<RegisterApplicationResponse> registerApplication(Consumer<RegisterApplicationRequest.Builder> registerApplicationRequest)

      Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.

      The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.

      AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.

      Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.


      This is a convenience which creates an instance of the RegisterApplicationRequest.Builder avoiding the need to create one manually via RegisterApplicationRequest.builder()

      Parameters:
      registerApplicationRequest - A Consumer that will call methods on RegisterApplicationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startApplicationRefresh

      default CompletableFuture<StartApplicationRefreshResponse> startApplicationRefresh(StartApplicationRefreshRequest startApplicationRefreshRequest)

      Refreshes a registered application.

      Parameters:
      startApplicationRefreshRequest -
      Returns:
      A Java Future containing the result of the StartApplicationRefresh operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startApplicationRefresh

      default CompletableFuture<StartApplicationRefreshResponse> startApplicationRefresh(Consumer<StartApplicationRefreshRequest.Builder> startApplicationRefreshRequest)

      Refreshes a registered application.


      This is a convenience which creates an instance of the StartApplicationRefreshRequest.Builder avoiding the need to create one manually via StartApplicationRefreshRequest.builder()

      Parameters:
      startApplicationRefreshRequest - A Consumer that will call methods on StartApplicationRefreshRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartApplicationRefresh operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Creates tag for a resource by specifying the ARN.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Creates tag for a resource by specifying the ARN.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Delete the tags for a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Delete the tags for a resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplicationSettings

      default CompletableFuture<UpdateApplicationSettingsResponse> updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)

      Updates the settings of an application registered with AWS Systems Manager for SAP.

      Parameters:
      updateApplicationSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateApplicationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateApplicationSettings

      default CompletableFuture<UpdateApplicationSettingsResponse> updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest)

      Updates the settings of an application registered with AWS Systems Manager for SAP.


      This is a convenience which creates an instance of the UpdateApplicationSettingsRequest.Builder avoiding the need to create one manually via UpdateApplicationSettingsRequest.builder()

      Parameters:
      updateApplicationSettingsRequest - A Consumer that will call methods on UpdateApplicationSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApplicationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • UnauthorizedException The request is not authorized.
      • ResourceNotFoundException The resource is not available.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • ConflictException A conflict has occurred.
      • InternalServerException An internal error has occurred.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default SsmSapServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SsmSapAsyncClient create()
      Create a SsmSapAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SsmSapAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SsmSapAsyncClient.