Backup Gateway
This page documents function available when using the Backup_Gateway module, created with @service Backup_Gateway.
Index
Main.Backup_Gateway.associate_gateway_to_serverMain.Backup_Gateway.create_gatewayMain.Backup_Gateway.delete_gatewayMain.Backup_Gateway.delete_hypervisorMain.Backup_Gateway.disassociate_gateway_from_serverMain.Backup_Gateway.get_gatewayMain.Backup_Gateway.get_virtual_machineMain.Backup_Gateway.import_hypervisor_configurationMain.Backup_Gateway.list_gatewaysMain.Backup_Gateway.list_hypervisorsMain.Backup_Gateway.list_tags_for_resourceMain.Backup_Gateway.list_virtual_machinesMain.Backup_Gateway.put_maintenance_start_timeMain.Backup_Gateway.tag_resourceMain.Backup_Gateway.test_hypervisor_configurationMain.Backup_Gateway.untag_resourceMain.Backup_Gateway.update_gateway_informationMain.Backup_Gateway.update_gateway_software_nowMain.Backup_Gateway.update_hypervisor
Documentation
Main.Backup_Gateway.associate_gateway_to_server — Methodassociate_gateway_to_server(gateway_arn, server_arn)
associate_gateway_to_server(gateway_arn, server_arn, params::Dict{String,<:Any})Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
Arguments
gateway_arn: The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.server_arn: The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
Main.Backup_Gateway.create_gateway — Methodcreate_gateway(activation_key, gateway_display_name, gateway_type)
create_gateway(activation_key, gateway_display_name, gateway_type, params::Dict{String,<:Any})Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.
Arguments
activation_key: The activation key of the created gateway.gateway_display_name: The display name of the created gateway.gateway_type: The type of created gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Tags": A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
Main.Backup_Gateway.delete_gateway — Methoddelete_gateway(gateway_arn)
delete_gateway(gateway_arn, params::Dict{String,<:Any})Deletes a backup gateway.
Arguments
gateway_arn: The Amazon Resource Name (ARN) of the gateway to delete.
Main.Backup_Gateway.delete_hypervisor — Methoddelete_hypervisor(hypervisor_arn)
delete_hypervisor(hypervisor_arn, params::Dict{String,<:Any})Deletes a hypervisor.
Arguments
hypervisor_arn: The Amazon Resource Name (ARN) of the hypervisor to delete.
Main.Backup_Gateway.disassociate_gateway_from_server — Methoddisassociate_gateway_from_server(gateway_arn)
disassociate_gateway_from_server(gateway_arn, params::Dict{String,<:Any})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.
Arguments
gateway_arn: The Amazon Resource Name (ARN) of the gateway to disassociate.
Main.Backup_Gateway.get_gateway — Methodget_gateway(gateway_arn)
get_gateway(gateway_arn, params::Dict{String,<:Any})By providing the ARN (Amazon Resource Name), this API returns the gateway.
Arguments
gateway_arn: The Amazon Resource Name (ARN) of the gateway.
Main.Backup_Gateway.get_virtual_machine — Methodget_virtual_machine(resource_arn)
get_virtual_machine(resource_arn, params::Dict{String,<:Any})By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the virtual machine.
Main.Backup_Gateway.import_hypervisor_configuration — Methodimport_hypervisor_configuration(host, name)
import_hypervisor_configuration(host, name, params::Dict{String,<:Any})Connect to a hypervisor by importing its configuration.
Arguments
host: The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).name: The name of the hypervisor.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"KmsKeyArn": The Key Management Service for the hypervisor."Password": The password for the hypervisor."Tags": The tags of the hypervisor configuration to import."Username": The username for the hypervisor.
Main.Backup_Gateway.list_gateways — Methodlist_gateways()
list_gateways(params::Dict{String,<:Any})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).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": The maximum number of gateways to list."NextToken": The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Main.Backup_Gateway.list_hypervisors — Methodlist_hypervisors()
list_hypervisors(params::Dict{String,<:Any})Lists your hypervisors.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": The maximum number of hypervisors to list."NextToken": The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Main.Backup_Gateway.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource's tags to list.
Main.Backup_Gateway.list_virtual_machines — Methodlist_virtual_machines()
list_virtual_machines(params::Dict{String,<:Any})Lists your virtual machines.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"HypervisorArn": The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine."MaxResults": The maximum number of virtual machines to list."NextToken": The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Main.Backup_Gateway.put_maintenance_start_time — Methodput_maintenance_start_time(gateway_arn, hour_of_day, minute_of_hour)
put_maintenance_start_time(gateway_arn, hour_of_day, minute_of_hour, params::Dict{String,<:Any})Set the maintenance start time for a gateway.
Arguments
gateway_arn: The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.hour_of_day: The hour of the day to start maintenance on a gateway.minute_of_hour: The minute of the hour to start maintenance on a gateway.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"DayOfMonth": The day of the month start maintenance on a gateway. Valid values range from Sunday to Saturday."DayOfWeek": The day of the week to start maintenance on a gateway.
Main.Backup_Gateway.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Tag the resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource to tag.tags: A list of tags to assign to the resource.
Main.Backup_Gateway.test_hypervisor_configuration — Methodtest_hypervisor_configuration(gateway_arn, host)
test_hypervisor_configuration(gateway_arn, host, params::Dict{String,<:Any})Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
Arguments
gateway_arn: The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.host: The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Password": The password for the hypervisor."Username": The username for the hypervisor.
Main.Backup_Gateway.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes tags from the resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource from which to remove tags.tag_keys: The list of tag keys specifying which tags to remove.
Main.Backup_Gateway.update_gateway_information — Methodupdate_gateway_information(gateway_arn)
update_gateway_information(gateway_arn, params::Dict{String,<:Any})Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
Arguments
gateway_arn: The Amazon Resource Name (ARN) of the gateway to update.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"GatewayDisplayName": The updated display name of the gateway.
Main.Backup_Gateway.update_gateway_software_now — Methodupdate_gateway_software_now(gateway_arn)
update_gateway_software_now(gateway_arn, params::Dict{String,<:Any})Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.
Arguments
gateway_arn: The Amazon Resource Name (ARN) of the gateway to be updated.
Main.Backup_Gateway.update_hypervisor — Methodupdate_hypervisor(hypervisor_arn)
update_hypervisor(hypervisor_arn, params::Dict{String,<:Any})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.
Arguments
hypervisor_arn: The Amazon Resource Name (ARN) of the hypervisor to update.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Host": The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN)."Name": The updated name for the hypervisor"Password": The updated password for the hypervisor."Username": The updated username for the hypervisor.