com.amazonaws.services.recyclebin

Class AmazonRecycleBinClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.recyclebin.AmazonRecycleBinClient

All Implemented Interfaces:

AmazonRecycleBin

Direct Known Subclasses:

AmazonRecycleBinAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonRecycleBinClient
extends AmazonWebServiceClient
implements AmazonRecycleBin

Client for accessing Amazon Recycle Bin. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.recyclebin.AmazonRecycleBin

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonRecycleBinClientBuilder	builder()
CreateRuleResult	createRule(CreateRuleRequest request) Creates a Recycle Bin retention rule.
DeleteRuleResult	deleteRule(DeleteRuleRequest request) 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 request) Gets information about a Recycle Bin retention rule.
ListRulesResult	listRules(ListRulesRequest request) Lists the Recycle Bin retention rules in the Region.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags assigned to a retention rule.
LockRuleResult	lockRule(LockRuleRequest request) Locks a retention rule.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Assigns tags to the specified retention rule.
UnlockRuleResult	unlockRule(UnlockRuleRequest request) Unlocks a retention rule.
UntagResourceResult	untagResource(UntagResourceRequest request) Unassigns a tag from a retention rule.
UpdateRuleResult	updateRule(UpdateRuleRequest request) Updates an existing Recycle Bin retention rule.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonRecycleBinClientBuilder builder()

createRule

public CreateRuleResult createRule(CreateRuleRequest request)

Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Specified by:

createRule in interface AmazonRecycleBin

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

public DeleteRuleResult deleteRule(DeleteRuleRequest request)

Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.

Specified by:

deleteRule in interface AmazonRecycleBin

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

public GetRuleResult getRule(GetRuleRequest request)

Gets information about a Recycle Bin retention rule.

Specified by:

getRule in interface AmazonRecycleBin

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

public ListRulesResult listRules(ListRulesRequest request)

Lists the Recycle Bin retention rules in the Region.

Specified by:

listRules in interface AmazonRecycleBin

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags assigned to a retention rule.

Specified by:

listTagsForResource in interface AmazonRecycleBin

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

public LockRuleResult lockRule(LockRuleRequest request)

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

Specified by:

lockRule in interface AmazonRecycleBin

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

public TagResourceResult tagResource(TagResourceRequest request)

Assigns tags to the specified retention rule.

Specified by:

tagResource in interface AmazonRecycleBin

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

public UnlockRuleResult unlockRule(UnlockRuleRequest request)

Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.

Specified by:

unlockRule in interface AmazonRecycleBin

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Unassigns a tag from a retention rule.

Specified by:

untagResource in interface AmazonRecycleBin

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

public UpdateRuleResult updateRule(UpdateRuleRequest request)

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.

Specified by:

updateRule in interface AmazonRecycleBin

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonRecycleBin

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonRecycleBin

Overrides:

shutdown in class AmazonWebServiceClient