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.
419 420 421 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 419 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.
457 458 459 460 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 457 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.
505 506 507 508 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 505 def create_gateway(params = {}, = {}) req = build_request(:create_gateway, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayOutput
Deletes a backup gateway.
533 534 535 536 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 533 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_hypervisor(params = {}) ⇒ Types::DeleteHypervisorOutput
Deletes a hypervisor.
561 562 563 564 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 561 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.
591 592 593 594 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 591 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.
637 638 639 640 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 637 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.
676 677 678 679 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 676 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.
715 716 717 718 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 715 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.
754 755 756 757 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 754 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.
792 793 794 795 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 792 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.
846 847 848 849 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 846 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.
892 893 894 895 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 892 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.
936 937 938 939 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 936 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).
969 970 971 972 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 969 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.
1019 1020 1021 1022 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1019 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.
1071 1072 1073 1074 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1071 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.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1118 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.
1165 1166 1167 1168 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1165 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.
1194 1195 1196 1197 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1194 def (params = {}, = {}) req = build_request(:start_virtual_machines_metadata_sync, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceOutput
Tag the resource.
1231 1232 1233 1234 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1231 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.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1268 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.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1301 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.
1334 1335 1336 1337 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1334 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.
1369 1370 1371 1372 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1369 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.
1421 1422 1423 1424 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1421 def update_hypervisor(params = {}, = {}) req = build_request(:update_hypervisor, params) req.send_request() end |