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.
483 484 485 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 483 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.
521 522 523 524 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 521 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.
569 570 571 572 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 569 def create_gateway(params = {}, = {}) req = build_request(:create_gateway, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayOutput
Deletes a backup gateway.
597 598 599 600 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 597 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#delete_hypervisor(params = {}) ⇒ Types::DeleteHypervisorOutput
Deletes a hypervisor.
625 626 627 628 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 625 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.
655 656 657 658 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 655 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.
701 702 703 704 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 701 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.
740 741 742 743 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 740 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.
779 780 781 782 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 779 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.
818 819 820 821 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 818 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.
856 857 858 859 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 856 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.
910 911 912 913 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 910 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.
956 957 958 959 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 956 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.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1000 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).
1033 1034 1035 1036 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1033 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.
1083 1084 1085 1086 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1083 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.
1135 1136 1137 1138 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1135 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.
1182 1183 1184 1185 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1182 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1229 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.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1258 def (params = {}, = {}) req = build_request(:start_virtual_machines_metadata_sync, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceOutput
Tag the resource.
1295 1296 1297 1298 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1295 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.
1332 1333 1334 1335 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1332 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.
1365 1366 1367 1368 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1365 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.
1398 1399 1400 1401 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1398 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.
1433 1434 1435 1436 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1433 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.
1485 1486 1487 1488 |
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1485 def update_hypervisor(params = {}, = {}) req = build_request(:update_hypervisor, params) req.send_request() end |