Interface BackupSearchClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BackupSearchClient extends AwsClient
Service client for accessing AWS Backup Search. This can be created using the staticbuilder()method.Backup Search Backup Search is the recovery point and item level search for Backup.
For additional information, see:
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
getSearchJob
default GetSearchJobResponse getSearchJob(GetSearchJobRequest getSearchJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation retrieves metadata of a search job, including its progress.
- Parameters:
getSearchJobRequest-- Returns:
- Result of the GetSearchJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getSearchJob
default GetSearchJobResponse getSearchJob(Consumer<GetSearchJobRequest.Builder> getSearchJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation retrieves metadata of a search job, including its progress.
This is a convenience which creates an instance of the
GetSearchJobRequest.Builderavoiding the need to create one manually viaGetSearchJobRequest.builder()- Parameters:
getSearchJobRequest- AConsumerthat will call methods onGetSearchJobRequest.Builderto create a request.- Returns:
- Result of the GetSearchJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getSearchResultExportJob
default GetSearchResultExportJobResponse getSearchResultExportJob(GetSearchResultExportJobRequest getSearchResultExportJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
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:
- Result of the GetSearchResultExportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getSearchResultExportJob
default GetSearchResultExportJobResponse getSearchResultExportJob(Consumer<GetSearchResultExportJobRequest.Builder> getSearchResultExportJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
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.Builderavoiding the need to create one manually viaGetSearchResultExportJobRequest.builder()- Parameters:
getSearchResultExportJobRequest- AConsumerthat will call methods onGetSearchResultExportJobRequest.Builderto create a request.- Returns:
- Result of the GetSearchResultExportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobBackups
default ListSearchJobBackupsResponse listSearchJobBackups(ListSearchJobBackupsRequest listSearchJobBackupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
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
FAILEDstatus from a permissions issue will be displayed, along with a status message.Only recovery points with a backup index that has a status of
ACTIVEwill 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:
- Result of the ListSearchJobBackups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobBackups
default ListSearchJobBackupsResponse listSearchJobBackups(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
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
FAILEDstatus from a permissions issue will be displayed, along with a status message.Only recovery points with a backup index that has a status of
ACTIVEwill 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.Builderavoiding the need to create one manually viaListSearchJobBackupsRequest.builder()- Parameters:
listSearchJobBackupsRequest- AConsumerthat will call methods onListSearchJobBackupsRequest.Builderto create a request.- Returns:
- Result of the ListSearchJobBackups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobBackupsPaginator
default ListSearchJobBackupsIterable listSearchJobBackupsPaginator(ListSearchJobBackupsRequest listSearchJobBackupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client .listSearchJobBackupsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest)operation.- Parameters:
listSearchJobBackupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobBackupsPaginator
default ListSearchJobBackupsIterable listSearchJobBackupsPaginator(Consumer<ListSearchJobBackupsRequest.Builder> listSearchJobBackupsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client .listSearchJobBackupsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobBackupsIterable responses = client.listSearchJobBackupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchJobBackups(software.amazon.awssdk.services.backupsearch.model.ListSearchJobBackupsRequest)operation.
This is a convenience which creates an instance of the
ListSearchJobBackupsRequest.Builderavoiding the need to create one manually viaListSearchJobBackupsRequest.builder()- Parameters:
listSearchJobBackupsRequest- AConsumerthat will call methods onListSearchJobBackupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobResults
default ListSearchJobResultsResponse listSearchJobResults(ListSearchJobResultsRequest listSearchJobResultsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation returns a list of a specified search job.
- Parameters:
listSearchJobResultsRequest-- Returns:
- Result of the ListSearchJobResults operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobResults
default ListSearchJobResultsResponse listSearchJobResults(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation returns a list of a specified search job.
This is a convenience which creates an instance of the
ListSearchJobResultsRequest.Builderavoiding the need to create one manually viaListSearchJobResultsRequest.builder()- Parameters:
listSearchJobResultsRequest- AConsumerthat will call methods onListSearchJobResultsRequest.Builderto create a request.- Returns:
- Result of the ListSearchJobResults operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobResultsPaginator
default ListSearchJobResultsIterable listSearchJobResultsPaginator(ListSearchJobResultsRequest listSearchJobResultsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client .listSearchJobResultsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest)operation.- Parameters:
listSearchJobResultsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobResultsPaginator
default ListSearchJobResultsIterable listSearchJobResultsPaginator(Consumer<ListSearchJobResultsRequest.Builder> listSearchJobResultsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client .listSearchJobResultsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobResultsIterable responses = client.listSearchJobResultsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchJobResults(software.amazon.awssdk.services.backupsearch.model.ListSearchJobResultsRequest)operation.
This is a convenience which creates an instance of the
ListSearchJobResultsRequest.Builderavoiding the need to create one manually viaListSearchJobResultsRequest.builder()- Parameters:
listSearchJobResultsRequest- AConsumerthat will call methods onListSearchJobResultsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobs
default ListSearchJobsResponse listSearchJobs(ListSearchJobsRequest listSearchJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation returns a list of search jobs belonging to an account.
- Parameters:
listSearchJobsRequest-- Returns:
- Result of the ListSearchJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobs
default ListSearchJobsResponse listSearchJobs(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation returns a list of search jobs belonging to an account.
This is a convenience which creates an instance of the
ListSearchJobsRequest.Builderavoiding the need to create one manually viaListSearchJobsRequest.builder()- Parameters:
listSearchJobsRequest- AConsumerthat will call methods onListSearchJobsRequest.Builderto create a request.- Returns:
- Result of the ListSearchJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobsPaginator
default ListSearchJobsIterable listSearchJobsPaginator(ListSearchJobsRequest listSearchJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client .listSearchJobsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest)operation.- Parameters:
listSearchJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchJobsPaginator
default ListSearchJobsIterable listSearchJobsPaginator(Consumer<ListSearchJobsRequest.Builder> listSearchJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client .listSearchJobsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchJobsIterable responses = client.listSearchJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchJobsRequest)operation.
This is a convenience which creates an instance of the
ListSearchJobsRequest.Builderavoiding the need to create one manually viaListSearchJobsRequest.builder()- Parameters:
listSearchJobsRequest- AConsumerthat will call methods onListSearchJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchResultExportJobs
default ListSearchResultExportJobsResponse listSearchResultExportJobs(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BackupSearchException
This operation exports search results of a search job to a specified destination S3 bucket.
- Parameters:
listSearchResultExportJobsRequest-- Returns:
- Result of the ListSearchResultExportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchResultExportJobs
default ListSearchResultExportJobsResponse listSearchResultExportJobs(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BackupSearchException
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.Builderavoiding the need to create one manually viaListSearchResultExportJobsRequest.builder()- Parameters:
listSearchResultExportJobsRequest- AConsumerthat will call methods onListSearchResultExportJobsRequest.Builderto create a request.- Returns:
- Result of the ListSearchResultExportJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchResultExportJobsPaginator
default ListSearchResultExportJobsIterable listSearchResultExportJobsPaginator(ListSearchResultExportJobsRequest listSearchResultExportJobsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client .listSearchResultExportJobsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest)operation.- Parameters:
listSearchResultExportJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSearchResultExportJobsPaginator
default ListSearchResultExportJobsIterable listSearchResultExportJobsPaginator(Consumer<ListSearchResultExportJobsRequest.Builder> listSearchResultExportJobsRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BackupSearchException
This is a variant of
listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client .listSearchResultExportJobsPaginator(request); for (software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.backupsearch.paginators.ListSearchResultExportJobsIterable responses = client.listSearchResultExportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSearchResultExportJobs(software.amazon.awssdk.services.backupsearch.model.ListSearchResultExportJobsRequest)operation.
This is a convenience which creates an instance of the
ListSearchResultExportJobsRequest.Builderavoiding the need to create one manually viaListSearchResultExportJobsRequest.builder()- Parameters:
listSearchResultExportJobsRequest- AConsumerthat will call methods onListSearchResultExportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation returns the tags for a resource type.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation returns the tags for a resource type.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startSearchJob
default StartSearchJobResponse startSearchJob(StartSearchJobRequest startSearchJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, BackupSearchException
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:
- Result of the StartSearchJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startSearchJob
default StartSearchJobResponse startSearchJob(Consumer<StartSearchJobRequest.Builder> startSearchJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, BackupSearchException
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.Builderavoiding the need to create one manually viaStartSearchJobRequest.builder()- Parameters:
startSearchJobRequest- AConsumerthat will call methods onStartSearchJobRequest.Builderto create a request.- Returns:
- Result of the StartSearchJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startSearchResultExportJob
default StartSearchResultExportJobResponse startSearchResultExportJob(StartSearchResultExportJobRequest startSearchResultExportJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, BackupSearchException
This operations starts a job to export the results of search job to a designated S3 bucket.
- Parameters:
startSearchResultExportJobRequest-- Returns:
- Result of the StartSearchResultExportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startSearchResultExportJob
default StartSearchResultExportJobResponse startSearchResultExportJob(Consumer<StartSearchResultExportJobRequest.Builder> startSearchResultExportJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, BackupSearchException
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.Builderavoiding the need to create one manually viaStartSearchResultExportJobRequest.builder()- Parameters:
startSearchResultExportJobRequest- AConsumerthat will call methods onStartSearchResultExportJobRequest.Builderto create a request.- Returns:
- Result of the StartSearchResultExportJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopSearchJob
default StopSearchJobResponse stopSearchJob(StopSearchJobRequest stopSearchJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, BackupSearchException
This operations ends a search job.
Only a search job with a status of
RUNNINGcan be stopped.- Parameters:
stopSearchJobRequest-- Returns:
- Result of the StopSearchJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopSearchJob
default StopSearchJobResponse stopSearchJob(Consumer<StopSearchJobRequest.Builder> stopSearchJobRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, AwsServiceException, SdkClientException, BackupSearchException
This operations ends a search job.
Only a search job with a status of
RUNNINGcan be stopped.
This is a convenience which creates an instance of the
StopSearchJobRequest.Builderavoiding the need to create one manually viaStopSearchJobRequest.builder()- Parameters:
stopSearchJobRequest- AConsumerthat will call methods onStopSearchJobRequest.Builderto create a request.- Returns:
- Result of the StopSearchJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation puts tags on the resource you indicate.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation puts tags on the resource you indicate.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation removes tags from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupSearchException
This operation removes tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static BackupSearchClient create()
Create aBackupSearchClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static BackupSearchClientBuilder builder()
Create a builder that can be used to configure and create aBackupSearchClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default BackupSearchServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-