Module Smaws_Client_BackupGateway

Backup Gateway client library built on EIO.

Types

module Types : sig ... end

Builders

val make_vmware_to_aws_tag_mapping : aws_tag_value:Types.tag_value -> aws_tag_key:Types.tag_key -> vmware_tag_name:Types.vmware_tag_name -> vmware_category:Types.vmware_category -> unit -> Types.vmware_to_aws_tag_mapping
val make_vmware_tag : ?vmware_tag_description:Types.string_ -> ?vmware_tag_name:Types.vmware_tag_name -> ?vmware_category:Types.vmware_category -> unit -> Types.vmware_tag
val make_virtual_machine : ?last_backup_date:Types.time -> ?resource_arn:Types.resource_arn -> ?path:Types.path -> ?name:Types.name -> ?hypervisor_id:Types.string_ -> ?host_name:Types.name -> unit -> Types.virtual_machine
val make_virtual_machine_details : ?vmware_tags:Types.vmware_tags -> ?last_backup_date:Types.time -> ?resource_arn:Types.resource_arn -> ?path:Types.path -> ?name:Types.name -> ?hypervisor_id:Types.string_ -> ?host_name:Types.name -> unit -> Types.virtual_machine_details
val make_update_hypervisor_output : ?hypervisor_arn:Types.server_arn -> unit -> Types.update_hypervisor_output
val make_update_hypervisor_input : ?log_group_arn:Types.log_group_arn -> ?name:Types.name -> ?password:Types.password -> ?username:Types.username -> ?host:Types.host -> hypervisor_arn:Types.server_arn -> unit -> Types.update_hypervisor_input
val make_update_gateway_software_now_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.update_gateway_software_now_output
val make_update_gateway_software_now_input : gateway_arn:Types.gateway_arn -> unit -> Types.update_gateway_software_now_input
val make_update_gateway_information_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.update_gateway_information_output
val make_update_gateway_information_input : ?gateway_display_name:Types.name -> gateway_arn:Types.gateway_arn -> unit -> Types.update_gateway_information_input
val make_untag_resource_output : ?resource_ar_n:Types.resource_arn -> unit -> Types.untag_resource_output
val make_untag_resource_input : tag_keys:Types.tag_keys -> resource_ar_n:Types.resource_arn -> unit -> Types.untag_resource_input
val make_test_hypervisor_configuration_output : unit -> unit
val make_test_hypervisor_configuration_input : ?password:Types.password -> ?username:Types.username -> host:Types.host -> gateway_arn:Types.gateway_arn -> unit -> Types.test_hypervisor_configuration_input
val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_output : ?resource_ar_n:Types.resource_arn -> unit -> Types.tag_resource_output
val make_tag_resource_input : tags:Types.tags -> resource_ar_n:Types.resource_arn -> unit -> Types.tag_resource_input
val make_start_virtual_machines_metadata_sync_output : ?hypervisor_arn:Types.server_arn -> unit -> Types.start_virtual_machines_metadata_sync_output
val make_start_virtual_machines_metadata_sync_input : hypervisor_arn:Types.server_arn -> unit -> Types.start_virtual_machines_metadata_sync_input
val make_put_maintenance_start_time_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.put_maintenance_start_time_output
val make_put_maintenance_start_time_input : ?day_of_month:Types.day_of_month -> ?day_of_week:Types.day_of_week -> minute_of_hour:Types.minute_of_hour -> hour_of_day:Types.hour_of_day -> gateway_arn:Types.gateway_arn -> unit -> Types.put_maintenance_start_time_input
val make_put_hypervisor_property_mappings_output : ?hypervisor_arn:Types.server_arn -> unit -> Types.put_hypervisor_property_mappings_output
val make_put_hypervisor_property_mappings_input : iam_role_arn:Types.iam_role_arn -> vmware_to_aws_tag_mappings:Types.vmware_to_aws_tag_mappings -> hypervisor_arn:Types.server_arn -> unit -> Types.put_hypervisor_property_mappings_input
val make_put_bandwidth_rate_limit_schedule_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.put_bandwidth_rate_limit_schedule_output
val make_bandwidth_rate_limit_interval : ?average_upload_rate_limit_in_bits_per_sec:Types.average_upload_rate_limit -> days_of_week:Types.days_of_week -> end_minute_of_hour:Types.minute_of_hour -> start_minute_of_hour:Types.minute_of_hour -> end_hour_of_day:Types.hour_of_day -> start_hour_of_day:Types.hour_of_day -> unit -> Types.bandwidth_rate_limit_interval
val make_put_bandwidth_rate_limit_schedule_input : bandwidth_rate_limit_intervals:Types.bandwidth_rate_limit_intervals -> gateway_arn:Types.gateway_arn -> unit -> Types.put_bandwidth_rate_limit_schedule_input
val make_maintenance_start_time : ?day_of_week:Types.day_of_week -> ?day_of_month:Types.day_of_month -> minute_of_hour:Types.minute_of_hour -> hour_of_day:Types.hour_of_day -> unit -> Types.maintenance_start_time
val make_list_virtual_machines_output : ?next_token:Types.next_token -> ?virtual_machines:Types.virtual_machines -> unit -> Types.list_virtual_machines_output
val make_list_virtual_machines_input : ?next_token:Types.next_token -> ?max_results:Types.max_results -> ?hypervisor_arn:Types.server_arn -> unit -> Types.list_virtual_machines_input
val make_list_tags_for_resource_output : ?tags:Types.tags -> ?resource_arn:Types.resource_arn -> unit -> Types.list_tags_for_resource_output
val make_list_tags_for_resource_input : resource_arn:Types.resource_arn -> unit -> Types.list_tags_for_resource_input
val make_hypervisor : ?state:Types.hypervisor_state -> ?name:Types.name -> ?kms_key_arn:Types.kms_key_arn -> ?hypervisor_arn:Types.server_arn -> ?host:Types.host -> unit -> Types.hypervisor
val make_list_hypervisors_output : ?next_token:Types.next_token -> ?hypervisors:Types.hypervisors -> unit -> Types.list_hypervisors_output
val make_list_hypervisors_input : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_hypervisors_input
val make_gateway : ?last_seen_time:Types.time -> ?hypervisor_id:Types.hypervisor_id -> ?gateway_type:Types.gateway_type -> ?gateway_display_name:Types.name -> ?gateway_arn:Types.gateway_arn -> unit -> Types.gateway
val make_list_gateways_output : ?next_token:Types.next_token -> ?gateways:Types.gateways -> unit -> Types.list_gateways_output
val make_list_gateways_input : ?next_token:Types.next_token -> ?max_results:Types.max_results -> unit -> Types.list_gateways_input
val make_import_hypervisor_configuration_output : ?hypervisor_arn:Types.server_arn -> unit -> Types.import_hypervisor_configuration_output
val make_import_hypervisor_configuration_input : ?tags:Types.tags -> ?kms_key_arn:Types.kms_key_arn -> ?password:Types.password -> ?username:Types.username -> host:Types.host -> name:Types.name -> unit -> Types.import_hypervisor_configuration_input
val make_hypervisor_details : ?latest_metadata_sync_status:Types.sync_metadata_status -> ?latest_metadata_sync_status_message:Types.string_ -> ?last_successful_metadata_sync_time:Types.time -> ?state:Types.hypervisor_state -> ?log_group_arn:Types.log_group_arn -> ?name:Types.name -> ?kms_key_arn:Types.kms_key_arn -> ?hypervisor_arn:Types.server_arn -> ?host:Types.host -> unit -> Types.hypervisor_details
val make_get_virtual_machine_output : ?virtual_machine:Types.virtual_machine_details -> unit -> Types.get_virtual_machine_output
val make_get_virtual_machine_input : resource_arn:Types.resource_arn -> unit -> Types.get_virtual_machine_input
val make_get_hypervisor_property_mappings_output : ?iam_role_arn:Types.iam_role_arn -> ?vmware_to_aws_tag_mappings:Types.vmware_to_aws_tag_mappings -> ?hypervisor_arn:Types.server_arn -> unit -> Types.get_hypervisor_property_mappings_output
val make_get_hypervisor_property_mappings_input : hypervisor_arn:Types.server_arn -> unit -> Types.get_hypervisor_property_mappings_input
val make_get_hypervisor_output : ?hypervisor:Types.hypervisor_details -> unit -> Types.get_hypervisor_output
val make_get_hypervisor_input : hypervisor_arn:Types.server_arn -> unit -> Types.get_hypervisor_input
val make_gateway_details : ?vpc_endpoint:Types.vpc_endpoint -> ?next_update_availability_time:Types.time -> ?maintenance_start_time:Types.maintenance_start_time -> ?last_seen_time:Types.time -> ?hypervisor_id:Types.hypervisor_id -> ?gateway_type:Types.gateway_type -> ?gateway_display_name:Types.name -> ?gateway_arn:Types.gateway_arn -> unit -> Types.gateway_details
val make_get_gateway_output : ?gateway:Types.gateway_details -> unit -> Types.get_gateway_output
val make_get_gateway_input : gateway_arn:Types.gateway_arn -> unit -> Types.get_gateway_input
val make_get_bandwidth_rate_limit_schedule_output : ?bandwidth_rate_limit_intervals:Types.bandwidth_rate_limit_intervals -> ?gateway_arn:Types.gateway_arn -> unit -> Types.get_bandwidth_rate_limit_schedule_output
val make_get_bandwidth_rate_limit_schedule_input : gateway_arn:Types.gateway_arn -> unit -> Types.get_bandwidth_rate_limit_schedule_input
val make_disassociate_gateway_from_server_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.disassociate_gateway_from_server_output
val make_disassociate_gateway_from_server_input : gateway_arn:Types.gateway_arn -> unit -> Types.disassociate_gateway_from_server_input
val make_delete_hypervisor_output : ?hypervisor_arn:Types.server_arn -> unit -> Types.delete_hypervisor_output
val make_delete_hypervisor_input : hypervisor_arn:Types.server_arn -> unit -> Types.delete_hypervisor_input
val make_delete_gateway_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.delete_gateway_output
val make_delete_gateway_input : gateway_arn:Types.gateway_arn -> unit -> Types.delete_gateway_input
val make_create_gateway_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.create_gateway_output
val make_create_gateway_input : ?tags:Types.tags -> gateway_type:Types.gateway_type -> gateway_display_name:Types.name -> activation_key:Types.activation_key -> unit -> Types.create_gateway_input
val make_associate_gateway_to_server_output : ?gateway_arn:Types.gateway_arn -> unit -> Types.associate_gateway_to_server_output
val make_associate_gateway_to_server_input : server_arn:Types.server_arn -> gateway_arn:Types.gateway_arn -> unit -> Types.associate_gateway_to_server_input

Operations

module AssociateGatewayToServer : sig ... end

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

module CreateGateway : sig ... end

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

module DeleteGateway : sig ... end

Deletes a backup gateway.

module DeleteHypervisor : sig ... end

Deletes a hypervisor.

module DisassociateGatewayFromServer : sig ... end

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.

module GetBandwidthRateLimitSchedule : sig ... end

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.

module GetGateway : sig ... end

By providing the ARN (Amazon Resource Name), this API returns the gateway.

module GetHypervisor : sig ... end

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.

module GetHypervisorPropertyMappings : sig ... end

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.

module GetVirtualMachine : sig ... end

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

module ImportHypervisorConfiguration : sig ... end

Connect to a hypervisor by importing its configuration.

module ListGateways : sig ... end

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).

module ListHypervisors : sig ... end

Lists your hypervisors.

module ListTagsForResource : sig ... end

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

module ListVirtualMachines : sig ... end

Lists your virtual machines.

module PutBandwidthRateLimitSchedule : sig ... end

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.

module PutHypervisorPropertyMappings : sig ... end

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.

module PutMaintenanceStartTime : sig ... end

Set the maintenance start time for a gateway.

This action sends a request to sync metadata across the specified virtual machines.

module TagResource : sig ... end

Tag the resource.

module TestHypervisorConfiguration : sig ... end

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

module UntagResource : sig ... end

Removes tags from the resource.

module UpdateGatewayInformation : sig ... end

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

module UpdateGatewaySoftwareNow : sig ... end

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

module UpdateHypervisor : sig ... end

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.

module Json_serializers : sig ... end
module Json_deserializers : sig ... end