Package software.amazon.awssdk.services.backupsearch

Interface BackupSearchAsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface BackupSearchAsyncClient
extends AwsClient
    Service client for accessing AWS Backup Search asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

    Backup Search

    Backup Search is the recovery point and item level search for Backup.

    For additional information, see:

    • Method Detail

      • getSearchJob

        default CompletableFuture<GetSearchJobResponse> getSearchJob​(GetSearchJobRequest getSearchJobRequest)

        This operation retrieves metadata of a search job, including its progress.

        Parameters:
        getSearchJobRequest -
        Returns:
        A Java Future containing the result of the GetSearchJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getSearchJob

        default CompletableFuture<GetSearchJobResponse> getSearchJob​(Consumer<GetSearchJobRequest.Builder> getSearchJobRequest)

        This operation retrieves metadata of a search job, including its progress.


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

        Parameters:
        getSearchJobRequest - A Consumer that will call methods on GetSearchJobRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetSearchJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getSearchResultExportJob

        default CompletableFuture<GetSearchResultExportJobResponse> getSearchResultExportJob​(GetSearchResultExportJobRequest getSearchResultExportJobRequest)

        This operation retrieves the metadata of an export job.

        An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

        An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

        Parameters:
        getSearchResultExportJobRequest -
        Returns:
        A Java Future containing the result of the GetSearchResultExportJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getSearchResultExportJob

        default CompletableFuture<GetSearchResultExportJobResponse> getSearchResultExportJob​(Consumer<GetSearchResultExportJobRequest.Builder> getSearchResultExportJobRequest)

        This operation retrieves the metadata of an export job.

        An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

        An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.


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

        Parameters:
        getSearchResultExportJobRequest - A Consumer that will call methods on GetSearchResultExportJobRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetSearchResultExportJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobBackups

        default CompletableFuture<ListSearchJobBackupsResponse> listSearchJobBackups​(ListSearchJobBackupsRequest listSearchJobBackupsRequest)

        This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

        If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

        Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

        Parameters:
        listSearchJobBackupsRequest -
        Returns:
        A Java Future containing the result of the ListSearchJobBackups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobBackups

        default CompletableFuture<ListSearchJobBackupsResponse> listSearchJobBackups​(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest)

        This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

        If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

        Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.


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

        Parameters:
        listSearchJobBackupsRequest - A Consumer that will call methods on ListSearchJobBackupsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListSearchJobBackups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobBackupsPaginator

        default ListSearchJobBackupsPublisher listSearchJobBackupsPaginator​(ListSearchJobBackupsRequest listSearchJobBackupsRequest)

        This is a variant of listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) 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.backupsearch.paginators.ListSearchJobBackupsPublisher publisher = client.listSearchJobBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsPublisher publisher = client.listSearchJobBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse 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 listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation.

        Parameters:
        listSearchJobBackupsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobBackupsPaginator

        default ListSearchJobBackupsPublisher listSearchJobBackupsPaginator​(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest)

        This is a variant of listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) 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.backupsearch.paginators.ListSearchJobBackupsPublisher publisher = client.listSearchJobBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsPublisher publisher = client.listSearchJobBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse 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 listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest) operation.


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

        Parameters:
        listSearchJobBackupsRequest - A Consumer that will call methods on ListSearchJobBackupsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobResults

        default CompletableFuture<ListSearchJobResultsResponse> listSearchJobResults​(ListSearchJobResultsRequest listSearchJobResultsRequest)

        This operation returns a list of a specified search job.

        Parameters:
        listSearchJobResultsRequest -
        Returns:
        A Java Future containing the result of the ListSearchJobResults operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobResults

        default CompletableFuture<ListSearchJobResultsResponse> listSearchJobResults​(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest)

        This operation returns a list of a specified search job.


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

        Parameters:
        listSearchJobResultsRequest - A Consumer that will call methods on ListSearchJobResultsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListSearchJobResults operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobResultsPaginator

        default ListSearchJobResultsPublisher listSearchJobResultsPaginator​(ListSearchJobResultsRequest listSearchJobResultsRequest)

        This is a variant of listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) 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.backupsearch.paginators.ListSearchJobResultsPublisher publisher = client.listSearchJobResultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsPublisher publisher = client.listSearchJobResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse 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 listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation.

        Parameters:
        listSearchJobResultsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobResultsPaginator

        default ListSearchJobResultsPublisher listSearchJobResultsPaginator​(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest)

        This is a variant of listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) 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.backupsearch.paginators.ListSearchJobResultsPublisher publisher = client.listSearchJobResultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsPublisher publisher = client.listSearchJobResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse 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 listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest) operation.


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

        Parameters:
        listSearchJobResultsRequest - A Consumer that will call methods on ListSearchJobResultsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobs

        default CompletableFuture<ListSearchJobsResponse> listSearchJobs​(ListSearchJobsRequest listSearchJobsRequest)

        This operation returns a list of search jobs belonging to an account.

        Parameters:
        listSearchJobsRequest -
        Returns:
        A Java Future containing the result of the ListSearchJobs operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobs

        default CompletableFuture<ListSearchJobsResponse> listSearchJobs​(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest)

        This operation returns a list of search jobs belonging to an account.


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

        Parameters:
        listSearchJobsRequest - A Consumer that will call methods on ListSearchJobsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListSearchJobs operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobsPaginator

        default ListSearchJobsPublisher listSearchJobsPaginator​(ListSearchJobsRequest listSearchJobsRequest)

        This is a variant of listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) 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.backupsearch.paginators.ListSearchJobsPublisher publisher = client.listSearchJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsPublisher publisher = client.listSearchJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse 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 listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation.

        Parameters:
        listSearchJobsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchJobsPaginator

        default ListSearchJobsPublisher listSearchJobsPaginator​(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest)

        This is a variant of listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) 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.backupsearch.paginators.ListSearchJobsPublisher publisher = client.listSearchJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsPublisher publisher = client.listSearchJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse 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 listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest) operation.


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

        Parameters:
        listSearchJobsRequest - A Consumer that will call methods on ListSearchJobsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchResultExportJobs

        default CompletableFuture<ListSearchResultExportJobsResponse> listSearchResultExportJobs​(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest)

        This operation exports search results of a search job to a specified destination S3 bucket.

        Parameters:
        listSearchResultExportJobsRequest -
        Returns:
        A Java Future containing the result of the ListSearchResultExportJobs operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchResultExportJobs

        default CompletableFuture<ListSearchResultExportJobsResponse> listSearchResultExportJobs​(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest)

        This operation exports search results of a search job to a specified destination S3 bucket.


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

        Parameters:
        listSearchResultExportJobsRequest - A Consumer that will call methods on ListSearchResultExportJobsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListSearchResultExportJobs operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchResultExportJobsPaginator

        default ListSearchResultExportJobsPublisher listSearchResultExportJobsPaginator​(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest)

        This is a variant of listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) 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.backupsearch.paginators.ListSearchResultExportJobsPublisher publisher = client.listSearchResultExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsPublisher publisher = client.listSearchResultExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse 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 listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation.

        Parameters:
        listSearchResultExportJobsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listSearchResultExportJobsPaginator

        default ListSearchResultExportJobsPublisher listSearchResultExportJobsPaginator​(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest)

        This is a variant of listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) 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.backupsearch.paginators.ListSearchResultExportJobsPublisher publisher = client.listSearchResultExportJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsPublisher publisher = client.listSearchResultExportJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse 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 listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest) operation.


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

        Parameters:
        listSearchResultExportJobsRequest - A Consumer that will call methods on ListSearchResultExportJobsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsForResource

        default CompletableFuture<ListTagsForResourceResponse> listTagsForResource​(ListTagsForResourceRequest listTagsForResourceRequest)

        This operation returns the tags for a resource type.

        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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsForResource

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

        This operation returns the tags for a resource type.


        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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • startSearchJob

        default CompletableFuture<StartSearchJobResponse> startSearchJob​(StartSearchJobRequest startSearchJobRequest)

        This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

        You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

        Parameters:
        startSearchJobRequest -
        Returns:
        A Java Future containing the result of the StartSearchJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • ConflictException This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

          A retry (with appropriate backoff logic) is the recommended response to this exception.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • startSearchJob

        default CompletableFuture<StartSearchJobResponse> startSearchJob​(Consumer<StartSearchJobRequest.Builder> startSearchJobRequest)

        This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

        You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.


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

        Parameters:
        startSearchJobRequest - A Consumer that will call methods on StartSearchJobRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the StartSearchJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • ConflictException This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

          A retry (with appropriate backoff logic) is the recommended response to this exception.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • startSearchResultExportJob

        default CompletableFuture<StartSearchResultExportJobResponse> startSearchResultExportJob​(StartSearchResultExportJobRequest startSearchResultExportJobRequest)

        This operations starts a job to export the results of search job to a designated S3 bucket.

        Parameters:
        startSearchResultExportJobRequest -
        Returns:
        A Java Future containing the result of the StartSearchResultExportJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • ConflictException This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

          A retry (with appropriate backoff logic) is the recommended response to this exception.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • startSearchResultExportJob

        default CompletableFuture<StartSearchResultExportJobResponse> startSearchResultExportJob​(Consumer<StartSearchResultExportJobRequest.Builder> startSearchResultExportJobRequest)

        This operations starts a job to export the results of search job to a designated S3 bucket.


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

        Parameters:
        startSearchResultExportJobRequest - A Consumer that will call methods on StartSearchResultExportJobRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the StartSearchResultExportJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ServiceQuotaExceededException The request denied due to exceeding the quota limits permitted.
        • ConflictException This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

          A retry (with appropriate backoff logic) is the recommended response to this exception.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • stopSearchJob

        default CompletableFuture<StopSearchJobResponse> stopSearchJob​(StopSearchJobRequest stopSearchJobRequest)

        This operations ends a search job.

        Only a search job with a status of RUNNING can be stopped.

        Parameters:
        stopSearchJobRequest -
        Returns:
        A Java Future containing the result of the StopSearchJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ConflictException This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

          A retry (with appropriate backoff logic) is the recommended response to this exception.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • stopSearchJob

        default CompletableFuture<StopSearchJobResponse> stopSearchJob​(Consumer<StopSearchJobRequest.Builder> stopSearchJobRequest)

        This operations ends a search job.

        Only a search job with a status of RUNNING can be stopped.


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

        Parameters:
        stopSearchJobRequest - A Consumer that will call methods on StopSearchJobRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the StopSearchJob operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • ConflictException This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

          A retry (with appropriate backoff logic) is the recommended response to this exception.

        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

        default CompletableFuture<TagResourceResponse> tagResource​(TagResourceRequest tagResourceRequest)

        This operation puts tags on the resource you indicate.

        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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

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

        This operation puts tags on the resource you indicate.


        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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

        default CompletableFuture<UntagResourceResponse> untagResource​(UntagResourceRequest untagResourceRequest)

        This operation removes tags from the specified 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

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

        This operation removes tags from the specified 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • ResourceNotFoundException The resource was not found for this request.

          Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

        • ThrottlingException The request was denied due to request throttling.
        • AccessDeniedException You do not have sufficient access to perform this action.
        • ValidationException The input fails to satisfy the constraints specified by a service.
        • InternalServerException An internal server error occurred. Retry your request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • BackupSearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation