Class: Aws::BackupGateway::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BackupGateway::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb
Overview
An API client for BackupGateway. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::BackupGateway::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
-
#associate_gateway_to_server(params = {}) ⇒ Types::AssociateGatewayToServerOutput
Associates a backup gateway with your server.
-
#create_gateway(params = {}) ⇒ Types::CreateGatewayOutput
Creates a backup gateway.
-
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayOutput
Deletes a backup gateway.
-
#delete_hypervisor(params = {}) ⇒ Types::DeleteHypervisorOutput
Deletes a hypervisor.
-
#disassociate_gateway_from_server(params = {}) ⇒ Types::DisassociateGatewayFromServerOutput
Disassociates a backup gateway from the specified server.
-
#get_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::GetBandwidthRateLimitScheduleOutput
Retrieves the bandwidth rate limit schedule for a specified gateway.
-
#get_gateway(params = {}) ⇒ Types::GetGatewayOutput
By providing the ARN (Amazon Resource Name), this API returns the gateway.
-
#get_hypervisor(params = {}) ⇒ Types::GetHypervisorOutput
This action requests information about the specified hypervisor to which the gateway will connect.
-
#get_hypervisor_property_mappings(params = {}) ⇒ Types::GetHypervisorPropertyMappingsOutput
This action retrieves the property mappings for the specified hypervisor.
-
#get_virtual_machine(params = {}) ⇒ Types::GetVirtualMachineOutput
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
-
#import_hypervisor_configuration(params = {}) ⇒ Types::ImportHypervisorConfigurationOutput
Connect to a hypervisor by importing its configuration.
-
#list_gateways(params = {}) ⇒ Types::ListGatewaysOutput
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
-
#list_hypervisors(params = {}) ⇒ Types::ListHypervisorsOutput
Lists your hypervisors.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
-
#list_virtual_machines(params = {}) ⇒ Types::ListVirtualMachinesOutput
Lists your virtual machines.
-
#put_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::PutBandwidthRateLimitScheduleOutput
This action sets the bandwidth rate limit schedule for a specified gateway.
-
#put_hypervisor_property_mappings(params = {}) ⇒ Types::PutHypervisorPropertyMappingsOutput
This action sets the property mappings for the specified hypervisor.
-
#put_maintenance_start_time(params = {}) ⇒ Types::PutMaintenanceStartTimeOutput
Set the maintenance start time for a gateway.
-
#start_virtual_machines_metadata_sync(params = {}) ⇒ Types::StartVirtualMachinesMetadataSyncOutput
This action sends a request to sync metadata across the specified virtual machines.
-
#tag_resource(params = {}) ⇒ Types::TagResourceOutput
Tag the resource.
-
#test_hypervisor_configuration(params = {}) ⇒ Struct
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceOutput
Removes tags from the resource.
-
#update_gateway_information(params = {}) ⇒ Types::UpdateGatewayInformationOutput
Updates a gateway's name.
-
#update_gateway_software_now(params = {}) ⇒ Types::UpdateGatewaySoftwareNowOutput
Updates the gateway virtual machine (VM) software.
-
#update_hypervisor(params = {}) ⇒ Types::UpdateHypervisorOutput
Updates a hypervisor metadata, including its host, username, and password.
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.
441 442 443 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 441 def initialize(*args) super end |
Instance Method Details
#associate_gateway_to_server(params = {}) ⇒ Types::AssociateGatewayToServerOutput
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
479 480 481 482 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 479 def associate_gateway_to_server(params = {}, = {}) req = build_request(:associate_gateway_to_server, params) req.send_request() end |
#create_gateway(params = {}) ⇒ Types::CreateGatewayOutput
Creates a backup gateway. After you create a gateway, you can
associate it with a server using the AssociateGatewayToServer
operation.
527 528 529 530 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 527 def create_gateway(params = {}, = {}) req = build_request(:create_gateway, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayOutput
Deletes a backup gateway.
555 556 557 558 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 555 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_hypervisor(params = {}) ⇒ Types::DeleteHypervisorOutput
Deletes a hypervisor.
583 584 585 586 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 583 def delete_hypervisor(params = {}, = {}) req = build_request(:delete_hypervisor, params) req.send_request() end |
#disassociate_gateway_from_server(params = {}) ⇒ Types::DisassociateGatewayFromServerOutput
Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.
613 614 615 616 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 613 def disassociate_gateway_from_server(params = {}, = {}) req = build_request(:disassociate_gateway_from_server, params) req.send_request() end |
#get_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::GetBandwidthRateLimitScheduleOutput
Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.
659 660 661 662 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 659 def get_bandwidth_rate_limit_schedule(params = {}, = {}) req = build_request(:get_bandwidth_rate_limit_schedule, params) req.send_request() end |
#get_gateway(params = {}) ⇒ Types::GetGatewayOutput
By providing the ARN (Amazon Resource Name), this API returns the gateway.
698 699 700 701 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 698 def get_gateway(params = {}, = {}) req = build_request(:get_gateway, params) req.send_request() end |
#get_hypervisor(params = {}) ⇒ Types::GetHypervisorOutput
This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
737 738 739 740 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 737 def get_hypervisor(params = {}, = {}) req = build_request(:get_hypervisor, params) req.send_request() end |
#get_hypervisor_property_mappings(params = {}) ⇒ Types::GetHypervisorPropertyMappingsOutput
This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
776 777 778 779 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 776 def get_hypervisor_property_mappings(params = {}, = {}) req = build_request(:get_hypervisor_property_mappings, params) req.send_request() end |
#get_virtual_machine(params = {}) ⇒ Types::GetVirtualMachineOutput
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
814 815 816 817 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 814 def get_virtual_machine(params = {}, = {}) req = build_request(:get_virtual_machine, params) req.send_request() end |
#import_hypervisor_configuration(params = {}) ⇒ Types::ImportHypervisorConfigurationOutput
Connect to a hypervisor by importing its configuration.
868 869 870 871 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 868 def import_hypervisor_configuration(params = {}, = {}) req = build_request(:import_hypervisor_configuration, params) req.send_request() end |
#list_gateways(params = {}) ⇒ Types::ListGatewaysOutput
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
914 915 916 917 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 914 def list_gateways(params = {}, = {}) req = build_request(:list_gateways, params) req.send_request() end |
#list_hypervisors(params = {}) ⇒ Types::ListHypervisorsOutput
Lists your hypervisors.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
958 959 960 961 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 958 def list_hypervisors(params = {}, = {}) req = build_request(:list_hypervisors, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
991 992 993 994 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 991 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_virtual_machines(params = {}) ⇒ Types::ListVirtualMachinesOutput
Lists your virtual machines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1041 1042 1043 1044 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1041 def list_virtual_machines(params = {}, = {}) req = build_request(:list_virtual_machines, params) req.send_request() end |
#put_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::PutBandwidthRateLimitScheduleOutput
This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1093 def put_bandwidth_rate_limit_schedule(params = {}, = {}) req = build_request(:put_bandwidth_rate_limit_schedule, params) req.send_request() end |
#put_hypervisor_property_mappings(params = {}) ⇒ Types::PutHypervisorPropertyMappingsOutput
This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1140 def put_hypervisor_property_mappings(params = {}, = {}) req = build_request(:put_hypervisor_property_mappings, params) req.send_request() end |
#put_maintenance_start_time(params = {}) ⇒ Types::PutMaintenanceStartTimeOutput
Set the maintenance start time for a gateway.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1187 def put_maintenance_start_time(params = {}, = {}) req = build_request(:put_maintenance_start_time, params) req.send_request() end |
#start_virtual_machines_metadata_sync(params = {}) ⇒ Types::StartVirtualMachinesMetadataSyncOutput
This action sends a request to sync metadata across the specified virtual machines.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1216 def (params = {}, = {}) req = build_request(:start_virtual_machines_metadata_sync, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceOutput
Tag the resource.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1253 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_hypervisor_configuration(params = {}) ⇒ Struct
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1290 def test_hypervisor_configuration(params = {}, = {}) req = build_request(:test_hypervisor_configuration, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Types::UntagResourceOutput
Removes tags from the resource.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1323 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_gateway_information(params = {}) ⇒ Types::UpdateGatewayInformationOutput
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
1356 1357 1358 1359 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1356 def update_gateway_information(params = {}, = {}) req = build_request(:update_gateway_information, params) req.send_request() end |
#update_gateway_software_now(params = {}) ⇒ Types::UpdateGatewaySoftwareNowOutput
Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
200 OK
success response
immediately. However, it might take some time for the update to
complete.
1391 1392 1393 1394 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1391 def update_gateway_software_now(params = {}, = {}) req = build_request(:update_gateway_software_now, params) req.send_request() end |
#update_hypervisor(params = {}) ⇒ Types::UpdateHypervisorOutput
Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.
1443 1444 1445 1446 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1443 def update_hypervisor(params = {}, = {}) req = build_request(:update_hypervisor, params) req.send_request() end |