Interface RbinAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
This is the Recycle Bin API Reference. This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.
Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are deleted, they are retained in the Recycle Bin for a time period that you specify.
You can restore a resource from the Recycle Bin at any time before its retention period expires. After you restore a resource from the Recycle Bin, the resource is removed from the Recycle Bin, and you can then use it in the same way you use any other resource of that type in your account. If the retention period expires and the resource is not restored, the resource is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic RbinAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aRbinAsyncClient
.static RbinAsyncClient
create()
Create aRbinAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateRuleResponse> createRule
(Consumer<CreateRuleRequest.Builder> createRuleRequest) Creates a Recycle Bin retention rule.default CompletableFuture
<CreateRuleResponse> createRule
(CreateRuleRequest createRuleRequest) Creates a Recycle Bin retention rule.default CompletableFuture
<DeleteRuleResponse> deleteRule
(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) Deletes a Recycle Bin retention rule.default CompletableFuture
<DeleteRuleResponse> deleteRule
(DeleteRuleRequest deleteRuleRequest) Deletes a Recycle Bin retention rule.default CompletableFuture
<GetRuleResponse> getRule
(Consumer<GetRuleRequest.Builder> getRuleRequest) Gets information about a Recycle Bin retention rule.default CompletableFuture
<GetRuleResponse> getRule
(GetRuleRequest getRuleRequest) Gets information about a Recycle Bin retention rule.default CompletableFuture
<ListRulesResponse> listRules
(Consumer<ListRulesRequest.Builder> listRulesRequest) Lists the Recycle Bin retention rules in the Region.default CompletableFuture
<ListRulesResponse> listRules
(ListRulesRequest listRulesRequest) Lists the Recycle Bin retention rules in the Region.default ListRulesPublisher
listRulesPaginator
(Consumer<ListRulesRequest.Builder> listRulesRequest) This is a variant oflistRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest)
operation.default ListRulesPublisher
listRulesPaginator
(ListRulesRequest listRulesRequest) This is a variant oflistRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags assigned to a retention rule.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to a retention rule.default CompletableFuture
<LockRuleResponse> lockRule
(Consumer<LockRuleRequest.Builder> lockRuleRequest) Locks a retention rule.default CompletableFuture
<LockRuleResponse> lockRule
(LockRuleRequest lockRuleRequest) Locks a retention rule.default RbinServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns tags to the specified retention rule.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Assigns tags to the specified retention rule.default CompletableFuture
<UnlockRuleResponse> unlockRule
(Consumer<UnlockRuleRequest.Builder> unlockRuleRequest) Unlocks a retention rule.default CompletableFuture
<UnlockRuleResponse> unlockRule
(UnlockRuleRequest unlockRuleRequest) Unlocks a retention rule.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Unassigns a tag from a retention rule.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Unassigns a tag from a retention rule.default CompletableFuture
<UpdateRuleResponse> updateRule
(Consumer<UpdateRuleRequest.Builder> updateRuleRequest) Updates an existing Recycle Bin retention rule.default CompletableFuture
<UpdateRuleResponse> updateRule
(UpdateRuleRequest updateRuleRequest) Updates an existing Recycle Bin retention rule.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createRule
Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
- Parameters:
createRuleRequest
-- Returns:
- A Java Future containing the result of the CreateRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- ServiceQuotaExceededException The request would cause a service quota for the number of tags per resource to be exceeded.
- InternalServerException The service could not respond to the request due to an internal problem.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRule
default CompletableFuture<CreateRuleResponse> createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest) Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
This is a convenience which creates an instance of the
CreateRuleRequest.Builder
avoiding the need to create one manually viaCreateRuleRequest.builder()
- Parameters:
createRuleRequest
- AConsumer
that will call methods onCreateRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- ServiceQuotaExceededException The request would cause a service quota for the number of tags per resource to be exceeded.
- InternalServerException The service could not respond to the request due to an internal problem.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRule
Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
- Parameters:
deleteRuleRequest
-- Returns:
- A Java Future containing the result of the DeleteRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ValidationException One or more of the parameters in the request is not valid.
- ConflictException The specified retention rule lock request can't be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRule
default CompletableFuture<DeleteRuleResponse> deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
This is a convenience which creates an instance of the
DeleteRuleRequest.Builder
avoiding the need to create one manually viaDeleteRuleRequest.builder()
- Parameters:
deleteRuleRequest
- AConsumer
that will call methods onDeleteRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ValidationException One or more of the parameters in the request is not valid.
- ConflictException The specified retention rule lock request can't be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRule
Gets information about a Recycle Bin retention rule.
- Parameters:
getRuleRequest
-- Returns:
- A Java Future containing the result of the GetRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRule
Gets information about a Recycle Bin retention rule.
This is a convenience which creates an instance of the
GetRuleRequest.Builder
avoiding the need to create one manually viaGetRuleRequest.builder()
- Parameters:
getRuleRequest
- AConsumer
that will call methods onGetRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRules
Lists the Recycle Bin retention rules in the Region.
- Parameters:
listRulesRequest
-- Returns:
- A Java Future containing the result of the ListRules 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRules
default CompletableFuture<ListRulesResponse> listRules(Consumer<ListRulesRequest.Builder> listRulesRequest) Lists the Recycle Bin retention rules in the Region.
This is a convenience which creates an instance of the
ListRulesRequest.Builder
avoiding the need to create one manually viaListRulesRequest.builder()
- Parameters:
listRulesRequest
- AConsumer
that will call methods onListRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRules 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRulesPaginator
This is a variant of
listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.rbin.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rbin.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rbin.model.ListRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rbin.model.ListRulesResponse response) { //... }; });
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
listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest)
operation.- Parameters:
listRulesRequest
-- 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRulesPaginator
This is a variant of
listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.rbin.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.rbin.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.rbin.model.ListRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.rbin.model.ListRulesResponse response) { //... }; });
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
listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest)
operation.
This is a convenience which creates an instance of the
ListRulesRequest.Builder
avoiding the need to create one manually viaListRulesRequest.builder()
- Parameters:
listRulesRequest
- AConsumer
that will call methods onListRulesRequest.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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to a retention rule.
- 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags assigned to a retention rule.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
lockRule
Locks a retention rule. A locked retention rule can't be modified or deleted.
- Parameters:
lockRuleRequest
-- Returns:
- A Java Future containing the result of the LockRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ValidationException One or more of the parameters in the request is not valid.
- ConflictException The specified retention rule lock request can't be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
lockRule
default CompletableFuture<LockRuleResponse> lockRule(Consumer<LockRuleRequest.Builder> lockRuleRequest) Locks a retention rule. A locked retention rule can't be modified or deleted.
This is a convenience which creates an instance of the
LockRuleRequest.Builder
avoiding the need to create one manually viaLockRuleRequest.builder()
- Parameters:
lockRuleRequest
- AConsumer
that will call methods onLockRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the LockRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ValidationException One or more of the parameters in the request is not valid.
- ConflictException The specified retention rule lock request can't be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Assigns tags to the specified retention rule.
- 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException The request would cause a service quota for the number of tags per resource to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns tags to the specified retention rule.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ServiceQuotaExceededException The request would cause a service quota for the number of tags per resource to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
unlockRule
Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.
- Parameters:
unlockRuleRequest
-- Returns:
- A Java Future containing the result of the UnlockRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ValidationException One or more of the parameters in the request is not valid.
- ConflictException The specified retention rule lock request can't be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
unlockRule
default CompletableFuture<UnlockRuleResponse> unlockRule(Consumer<UnlockRuleRequest.Builder> unlockRuleRequest) Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.
This is a convenience which creates an instance of the
UnlockRuleRequest.Builder
avoiding the need to create one manually viaUnlockRuleRequest.builder()
- Parameters:
unlockRuleRequest
- AConsumer
that will call methods onUnlockRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UnlockRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ValidationException One or more of the parameters in the request is not valid.
- ConflictException The specified retention rule lock request can't be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Unassigns a tag from a retention rule.
- 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Unassigns a tag from a retention rule.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRule
Updates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
- Parameters:
updateRuleRequest
-- Returns:
- A Java Future containing the result of the UpdateRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ConflictException The specified retention rule lock request can't be completed.
- ServiceQuotaExceededException The request would cause a service quota for the number of tags per resource to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRule
default CompletableFuture<UpdateRuleResponse> updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest) Updates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
This is a convenience which creates an instance of the
UpdateRuleRequest.Builder
avoiding the need to create one manually viaUpdateRuleRequest.builder()
- Parameters:
updateRuleRequest
- AConsumer
that will call methods onUpdateRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRule 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 invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException One or more of the parameters in the request is not valid.
- InternalServerException The service could not respond to the request due to an internal problem.
- ResourceNotFoundException The specified resource was not found.
- ConflictException The specified retention rule lock request can't be completed.
- ServiceQuotaExceededException The request would cause a service quota for the number of tags per resource to be exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RbinException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aRbinAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRbinAsyncClient
.
-