Class: Aws::RecycleBin::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RecycleBin::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb
Overview
An API client for RecycleBin. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::RecycleBin::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a Recycle Bin retention rule.
-
#delete_rule(params = {}) ⇒ Struct
Deletes a Recycle Bin retention rule.
-
#get_rule(params = {}) ⇒ Types::GetRuleResponse
Gets information about a Recycle Bin retention rule.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists the Recycle Bin retention rules in the Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a retention rule.
-
#lock_rule(params = {}) ⇒ Types::LockRuleResponse
Locks a Region-level retention rule.
-
#tag_resource(params = {}) ⇒ Struct
Assigns tags to the specified retention rule.
-
#unlock_rule(params = {}) ⇒ Types::UnlockRuleResponse
Unlocks a retention rule.
-
#untag_resource(params = {}) ⇒ Struct
Unassigns a tag from a retention rule.
-
#update_rule(params = {}) ⇒ Types::UpdateRuleResponse
Updates an existing Recycle Bin retention rule.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
466 467 468 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
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.
617 618 619 620 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 617 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Struct
Deletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
645 646 647 648 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 645 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#get_rule(params = {}) ⇒ Types::GetRuleResponse
Gets information about a Recycle Bin retention rule.
699 700 701 702 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 699 def get_rule(params = {}, = {}) req = build_request(:get_rule, params) req.send_request() end |
#list_rules(params = {}) ⇒ Types::ListRulesResponse
Lists the Recycle Bin retention rules in the Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
777 778 779 780 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 777 def list_rules(params = {}, = {}) req = build_request(:list_rules, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a retention rule.
807 808 809 810 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 807 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#lock_rule(params = {}) ⇒ Types::LockRuleResponse
Locks a Region-level retention rule. A locked retention rule can't be modified or deleted.
874 875 876 877 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 874 def lock_rule(params = {}, = {}) req = build_request(:lock_rule, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Assigns tags to the specified retention rule.
905 906 907 908 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 905 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#unlock_rule(params = {}) ⇒ Types::UnlockRuleResponse
Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.
960 961 962 963 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 960 def unlock_rule(params = {}, = {}) req = build_request(:unlock_rule, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Unassigns a tag from a retention rule.
987 988 989 990 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 987 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_rule(params = {}) ⇒ Types::UpdateRuleResponse
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.
1104 1105 1106 1107 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 1104 def update_rule(params = {}, = {}) req = build_request(:update_rule, params) req.send_request() end |