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 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.
385 386 387 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
Creates a Recycle Bin retention rule. For more information, see Create Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.
501 502 503 504 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 501 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.
529 530 531 532 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 529 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.
579 580 581 582 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 579 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.
646 647 648 649 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 646 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.
676 677 678 679 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 676 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#lock_rule(params = {}) ⇒ Types::LockRuleResponse
Locks a retention rule. A locked retention rule can't be modified or deleted.
734 735 736 737 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 734 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.
765 766 767 768 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 765 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.
816 817 818 819 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 816 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.
843 844 845 846 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 843 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.
942 943 944 945 |
# File 'gems/aws-sdk-recyclebin/lib/aws-sdk-recyclebin/client.rb', line 942 def update_rule(params = {}, = {}) req = build_request(:update_rule, params) req.send_request() end |