Interface RbinClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface RbinClient
extends AwsClient

Service client for accessing Amazon Recycle Bin. This can be created using the static builder() method.

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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static RbinClientBuilder	builder()	Create a builder that can be used to configure and create a RbinClient.
static RbinClient	create()	Create a RbinClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateRuleResponse	createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)	Creates a Recycle Bin retention rule.
default CreateRuleResponse	createRule(CreateRuleRequest createRuleRequest)	Creates a Recycle Bin retention rule.
default DeleteRuleResponse	deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)	Deletes a Recycle Bin retention rule.
default DeleteRuleResponse	deleteRule(DeleteRuleRequest deleteRuleRequest)	Deletes a Recycle Bin retention rule.
default GetRuleResponse	getRule(Consumer<GetRuleRequest.Builder> getRuleRequest)	Gets information about a Recycle Bin retention rule.
default GetRuleResponse	getRule(GetRuleRequest getRuleRequest)	Gets information about a Recycle Bin retention rule.
default ListRulesResponse	listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)	Lists the Recycle Bin retention rules in the Region.
default ListRulesResponse	listRules(ListRulesRequest listRulesRequest)	Lists the Recycle Bin retention rules in the Region.
default ListRulesIterable	listRulesPaginator(Consumer<ListRulesRequest.Builder> listRulesRequest)	This is a variant of listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest) operation.
default ListRulesIterable	listRulesPaginator(ListRulesRequest listRulesRequest)	This is a variant of listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags assigned to a retention rule.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags assigned to a retention rule.
default LockRuleResponse	lockRule(Consumer<LockRuleRequest.Builder> lockRuleRequest)	Locks a Region-level retention rule.
default LockRuleResponse	lockRule(LockRuleRequest lockRuleRequest)	Locks a Region-level retention rule.
default RbinServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns tags to the specified retention rule.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns tags to the specified retention rule.
default UnlockRuleResponse	unlockRule(Consumer<UnlockRuleRequest.Builder> unlockRuleRequest)	Unlocks a retention rule.
default UnlockRuleResponse	unlockRule(UnlockRuleRequest unlockRuleRequest)	Unlocks a retention rule.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Unassigns a tag from a retention rule.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Unassigns a tag from a retention rule.
default UpdateRuleResponse	updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest)	Updates an existing Recycle Bin retention rule.
default 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

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 the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createRule

default CreateRuleResponse createRule(CreateRuleRequest createRuleRequest)
                               throws ValidationException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
RbinException

Creates a Recycle Bin retention rule. You can create two types of retention rules:

• Tag-level retention rules - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources (of the specified type) that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on their tags.

• Region-level retention rules - These retention rules, by default, apply to all of the resources (of the specified type) in the Region, even if the resources are not tagged. However, you can specify exclusion tags to exclude resources that have specific tags. Use this type of retention rule to protect all resources of a specific type in a Region.

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide.

Parameters:

createRuleRequest -

Returns:

Result of the CreateRule operation returned by the service.

See Also:

• AWS API Documentation

createRule

default CreateRuleResponse createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)
                               throws ValidationException,
ServiceQuotaExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
RbinException

Creates a Recycle Bin retention rule. You can create two types of retention rules:

• Tag-level retention rules - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources (of the specified type) that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on their tags.

• Region-level retention rules - These retention rules, by default, apply to all of the resources (of the specified type) in the Region, even if the resources are not tagged. However, you can specify exclusion tags to exclude resources that have specific tags. Use this type of retention rule to protect all resources of a specific type in a Region.

For more information, see Create Recycle Bin retention rules in the Amazon EBS User Guide.

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

Parameters:

createRuleRequest - A Consumer that will call methods on CreateRuleRequest.Builder to create a request.

Returns:

Result of the CreateRule operation returned by the service.

See Also:

• AWS API Documentation

deleteRule

default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
RbinException

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:

Result of the DeleteRule operation returned by the service.

See Also:

• AWS API Documentation

deleteRule

default DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
RbinException

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 via DeleteRuleRequest.builder()

Parameters:

deleteRuleRequest - A Consumer that will call methods on DeleteRuleRequest.Builder to create a request.

Returns:

Result of the DeleteRule operation returned by the service.

See Also:

• AWS API Documentation

getRule

default GetRuleResponse getRule(GetRuleRequest getRuleRequest)
                         throws ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RbinException

Gets information about a Recycle Bin retention rule.

Parameters:

getRuleRequest -

Returns:

Result of the GetRule operation returned by the service.

See Also:

• AWS API Documentation

getRule

default GetRuleResponse getRule(Consumer<GetRuleRequest.Builder> getRuleRequest)
                         throws ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RbinException

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 via GetRuleRequest.builder()

Parameters:

getRuleRequest - A Consumer that will call methods on GetRuleRequest.Builder to create a request.

Returns:

Result of the GetRule operation returned by the service.

See Also:

• AWS API Documentation

listRules

default ListRulesResponse listRules(ListRulesRequest listRulesRequest)
                             throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
RbinException

Lists the Recycle Bin retention rules in the Region.

Parameters:

listRulesRequest -

Returns:

Result of the ListRules operation returned by the service.

See Also:

• AWS API Documentation

listRules

default ListRulesResponse listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
                             throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
RbinException

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 via ListRulesRequest.builder()

Parameters:

listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.

Returns:

Result of the ListRules operation returned by the service.

See Also:

• AWS API Documentation

listRulesPaginator

default ListRulesIterable listRulesPaginator(ListRulesRequest listRulesRequest)
                                      throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
RbinException

This is a variant of listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rbin.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rbin.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
     for (software.amazon.awssdk.services.rbin.model.ListRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rbin.paginators.ListRulesIterable responses = client.listRulesPaginator(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 listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest) operation.

Parameters:

listRulesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRulesPaginator

default ListRulesIterable listRulesPaginator(Consumer<ListRulesRequest.Builder> listRulesRequest)
                                      throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
RbinException

This is a variant of listRules(software.amazon.awssdk.services.rbin.model.ListRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.rbin.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.rbin.paginators.ListRulesIterable responses = client.listRulesPaginator(request);
     for (software.amazon.awssdk.services.rbin.model.ListRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.rbin.paginators.ListRulesIterable responses = client.listRulesPaginator(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 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 via ListRulesRequest.builder()

Parameters:

listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RbinException

Lists the tags assigned to a retention rule.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RbinException

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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

lockRule

default LockRuleResponse lockRule(LockRuleRequest lockRuleRequest)
                           throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
RbinException

Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.

You can't lock tag-level retention rules, or Region-level retention rules that have exclusion tags.

Parameters:

lockRuleRequest -

Returns:

Result of the LockRule operation returned by the service.

See Also:

• AWS API Documentation

lockRule

default LockRuleResponse lockRule(Consumer<LockRuleRequest.Builder> lockRuleRequest)
                           throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
RbinException

Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.

You can't lock tag-level retention rules, or Region-level retention rules that have exclusion tags.

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

Parameters:

lockRuleRequest - A Consumer that will call methods on LockRuleRequest.Builder to create a request.

Returns:

Result of the LockRule operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
InternalServerException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RbinException

Assigns tags to the specified retention rule.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
InternalServerException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RbinException

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

unlockRule

default UnlockRuleResponse unlockRule(UnlockRuleRequest unlockRuleRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
RbinException

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:

Result of the UnlockRule operation returned by the service.

See Also:

• AWS API Documentation

unlockRule

default UnlockRuleResponse unlockRule(Consumer<UnlockRuleRequest.Builder> unlockRuleRequest)
                               throws InternalServerException,
ResourceNotFoundException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
RbinException

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 via UnlockRuleRequest.builder()

Parameters:

unlockRuleRequest - A Consumer that will call methods on UnlockRuleRequest.Builder to create a request.

Returns:

Result of the UnlockRule operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RbinException

Unassigns a tag from a retention rule.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
InternalServerException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
RbinException

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 via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateRule

default UpdateRuleResponse updateRule(UpdateRuleRequest updateRuleRequest)
                               throws ValidationException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RbinException

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:

Result of the UpdateRule operation returned by the service.

See Also:

• AWS API Documentation

updateRule

default UpdateRuleResponse updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest)
                               throws ValidationException,
InternalServerException,
ResourceNotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
RbinException

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 via UpdateRuleRequest.builder()

Parameters:

updateRuleRequest - A Consumer that will call methods on UpdateRuleRequest.Builder to create a request.

Returns:

Result of the UpdateRule operation returned by the service.

See Also:

• AWS API Documentation

create

static RbinClient create()

Create a RbinClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static RbinClientBuilder builder()

Create a builder that can be used to configure and create a RbinClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default RbinServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration