AmazonRecycleBin (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.recyclebin

Interface AmazonRecycleBin

All Known Subinterfaces:

AmazonRecycleBinAsync

All Known Implementing Classes:

AbstractAmazonRecycleBin, AbstractAmazonRecycleBinAsync, AmazonRecycleBinAsyncClient, AmazonRecycleBinClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonRecycleBin
```
Interface for accessing Amazon Recycle Bin.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonRecycleBin instead.

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 and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateRuleResult`	`createRule (CreateRuleRequest createRuleRequest)` Creates a Recycle Bin retention rule.
`DeleteRuleResult`	`deleteRule (DeleteRuleRequest deleteRuleRequest)` Deletes a Recycle Bin retention rule.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetRuleResult`	`getRule (GetRuleRequest getRuleRequest)` Gets information about a Recycle Bin retention rule.
`ListRulesResult`	`listRules (ListRulesRequest listRulesRequest)` Lists the Recycle Bin retention rules in the Region.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest listTagsForResourceRequest)` Lists the tags assigned to a retention rule.
`LockRuleResult`	`lockRule (LockRuleRequest lockRuleRequest)` Locks a retention rule.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource (TagResourceRequest tagResourceRequest)` Assigns tags to the specified retention rule.
`UnlockRuleResult`	`unlockRule (UnlockRuleRequest unlockRuleRequest)` Unlocks a retention rule.
`UntagResourceResult`	`untagResource (UntagResourceRequest untagResourceRequest)` Unassigns a tag from a retention rule.
`UpdateRuleResult`	`updateRule (UpdateRuleRequest updateRuleRequest)` Updates an existing Recycle Bin retention rule.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createRule
```
CreateRuleResult createRule(CreateRuleRequest createRuleRequest)
```
    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:
    
    Result of the CreateRule operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteRule
```
DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest)
```
    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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getRule
```
GetRuleResult getRule(GetRuleRequest getRuleRequest)
```
    Gets information about a Recycle Bin retention rule.
    
    Parameters:
    
    getRuleRequest -
    
    Returns:
    
    Result of the GetRule operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listRules
```
ListRulesResult listRules(ListRulesRequest listRulesRequest)
```
    Lists the Recycle Bin retention rules in the Region.
    
    Parameters:
    
    listRulesRequest -
    
    Returns:
    
    Result of the ListRules operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists the tags assigned to a retention rule.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - lockRule
```
LockRuleResult lockRule(LockRuleRequest lockRuleRequest)
```
    Locks a retention rule. A locked retention rule can't be modified or deleted.
    
    Parameters:
    
    lockRuleRequest -
    
    Returns:
    
    Result of the LockRule operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Assigns tags to the specified retention rule.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - unlockRule
```
UnlockRuleResult unlockRule(UnlockRuleRequest unlockRuleRequest)
```
    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.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Unassigns a tag from a retention rule.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateRule
```
UpdateRuleResult updateRule(UpdateRuleRequest 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.
    
    Parameters:
    
    updateRuleRequest -
    
    Returns:
    
    Result of the UpdateRule operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Interface AmazonRecycleBin

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createRule

deleteRule

getRule

listRules

listTagsForResource

lockRule

tagResource

unlockRule

untagResource

updateRule

shutdown

getCachedResponseMetadata