Module Smaws_Client_BackupGateway

Backup Gateway client library built on EIO.

Types

type nonrec vmware_to_aws_tag_mapping = {
  1. aws_tag_value : string;
    (*

    The value part of the Amazon Web Services tag's key-value pair.

    *)
  2. aws_tag_key : string;
    (*

    The key part of the Amazon Web Services tag's key-value pair.

    *)
  3. vmware_tag_name : string;
    (*

    This is the user-defined name of a VMware tag.

    *)
  4. vmware_category : string;
    (*

    The is the category of VMware.

    *)
}

This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.

type nonrec vmware_tag = {
  1. vmware_tag_description : string option;
    (*

    This is a user-defined description of a VMware tag.

    *)
  2. vmware_tag_name : string option;
    (*

    This is the user-defined name of a VMware tag.

    *)
  3. vmware_category : string option;
    (*

    The is the category of VMware.

    *)
}

A VMware tag is a tag attached to a specific virtual machine. A tag is a key-value pair you can use to manage, filter, and search for your resources.

The content of VMware tags can be matched to Amazon Web Services tags.

type nonrec virtual_machine = {
  1. last_backup_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The most recent date a virtual machine was backed up, in Unix format and UTC time.

    *)
  2. resource_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

    *)
  3. path : string option;
    (*

    The path of the virtual machine.

    *)
  4. name : string option;
    (*

    The name of the virtual machine.

    *)
  5. hypervisor_id : string option;
    (*

    The ID of the virtual machine's hypervisor.

    *)
  6. host_name : string option;
    (*

    The host name of the virtual machine.

    *)
}

A virtual machine that is on a hypervisor.

type nonrec virtual_machine_details = {
  1. vmware_tags : vmware_tag list option;
    (*

    These are the details of the VMware tags associated with the specified virtual machine.

    *)
  2. last_backup_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The most recent date a virtual machine was backed up, in Unix format and UTC time.

    *)
  3. resource_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

    *)
  4. path : string option;
    (*

    The path of the virtual machine.

    *)
  5. name : string option;
    (*

    The name of the virtual machine.

    *)
  6. hypervisor_id : string option;
    (*

    The ID of the virtual machine's hypervisor.

    *)
  7. host_name : string option;
    (*

    The host name of the virtual machine.

    *)
}

Your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

type nonrec validation_exception = {
  1. message : string option;
  2. error_code : string option;
    (*

    A description of what caused the validation error.

    *)
}

The operation did not succeed because a validation error occurred.

type nonrec update_hypervisor_output = {
  1. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor you updated.

    *)
}
type nonrec update_hypervisor_input = {
  1. log_group_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the group of gateways within the requested log.

    *)
  2. name : string option;
    (*

    The updated name for the hypervisor

    *)
  3. password : string option;
    (*

    The updated password for the hypervisor.

    *)
  4. username : string option;
    (*

    The updated username for the hypervisor.

    *)
  5. host : string option;
    (*

    The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

    *)
  6. hypervisor_arn : string;
    (*

    The Amazon Resource Name (ARN) of the hypervisor to update.

    *)
}
type nonrec resource_not_found_exception = {
  1. message : string option;
  2. error_code : string option;
    (*

    A description of which resource wasn't found.

    *)
}

A resource that is required for the action wasn't found.

type nonrec conflict_exception = {
  1. message : string option;
  2. error_code : string;
    (*

    A description of why the operation is not supported.

    *)
}

The operation cannot proceed because it is not supported.

type nonrec access_denied_exception = {
  1. message : string option;
  2. error_code : string;
    (*

    A description of why you have insufficient permissions.

    *)
}

The operation cannot proceed because you have insufficient permissions.

type nonrec update_gateway_software_now_output = {
  1. gateway_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the gateway you updated.

    *)
}
type nonrec update_gateway_software_now_input = {
  1. gateway_arn : string;
    (*

    The Amazon Resource Name (ARN) of the gateway to be updated.

    *)
}
type nonrec update_gateway_information_output = {
  1. gateway_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the gateway you updated.

    *)
}
type nonrec update_gateway_information_input = {
  1. gateway_display_name : string option;
    (*

    The updated display name of the gateway.

    *)
  2. gateway_arn : string;
    (*

    The Amazon Resource Name (ARN) of the gateway to update.

    *)
}
type nonrec untag_resource_output = {
  1. resource_ar_n : string option;
    (*

    The Amazon Resource Name (ARN) of the resource from which you removed tags.

    *)
}
type nonrec untag_resource_input = {
  1. tag_keys : string list;
    (*

    The list of tag keys specifying which tags to remove.

    *)
  2. resource_ar_n : string;
    (*

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

    *)
}
type nonrec throttling_exception = {
  1. message : string option;
  2. error_code : string;
    (*

    Error: TPS has been limited to protect against intentional or unintentional high request volumes.

    *)
}

TPS has been limited to protect against intentional or unintentional high request volumes.

type nonrec test_hypervisor_configuration_input = {
  1. password : string option;
    (*

    The password for the hypervisor.

    *)
  2. username : string option;
    (*

    The username for the hypervisor.

    *)
  3. host : string;
    (*

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

    *)
  4. gateway_arn : string;
    (*

    The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.

    *)
}
type nonrec tag = {
  1. value : string;
    (*

    The value part of a tag's key-value pair.

    *)
  2. key : string;
    (*

    The key part of a tag's key-value pair. The key can't start with aws:.

    *)
}

A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

type nonrec tag_resource_output = {
  1. resource_ar_n : string option;
    (*

    The Amazon Resource Name (ARN) of the resource you tagged.

    *)
}
type nonrec tag_resource_input = {
  1. tags : tag list;
    (*

    A list of tags to assign to the resource.

    *)
  2. resource_ar_n : string;
    (*

    The Amazon Resource Name (ARN) of the resource to tag.

    *)
}
type nonrec sync_metadata_status =
  1. | CREATED
  2. | RUNNING
  3. | FAILED
  4. | PARTIALLY_FAILED
  5. | SUCCEEDED
type nonrec start_virtual_machines_metadata_sync_output = {
  1. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
}
type nonrec start_virtual_machines_metadata_sync_input = {
  1. hypervisor_arn : string;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
}
type nonrec put_maintenance_start_time_output = {
  1. gateway_arn : string option;
    (*

    The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.

    *)
}
type nonrec put_maintenance_start_time_input = {
  1. day_of_month : int option;
    (*

    The day of the month start maintenance on a gateway.

    Valid values range from Sunday to Saturday.

    *)
  2. day_of_week : int option;
    (*

    The day of the week to start maintenance on a gateway.

    *)
  3. minute_of_hour : int;
    (*

    The minute of the hour to start maintenance on a gateway.

    *)
  4. hour_of_day : int;
    (*

    The hour of the day to start maintenance on a gateway.

    *)
  5. gateway_arn : string;
    (*

    The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.

    *)
}
type nonrec put_hypervisor_property_mappings_output = {
  1. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
}
type nonrec put_hypervisor_property_mappings_input = {
  1. iam_role_arn : string;
    (*

    The Amazon Resource Name (ARN) of the IAM role.

    *)
  2. vmware_to_aws_tag_mappings : vmware_to_aws_tag_mapping list;
    (*

    This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.

    *)
  3. hypervisor_arn : string;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
}
type nonrec put_bandwidth_rate_limit_schedule_output = {
  1. gateway_arn : string option;
    (*

    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.

    *)
}
type nonrec bandwidth_rate_limit_interval = {
  1. days_of_week : int list;
    (*

    The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

    *)
  2. end_minute_of_hour : int;
    (*

    The minute of the hour to end the bandwidth rate limit interval.

    The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59.

    *)
  3. start_minute_of_hour : int;
    (*

    The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0.

    *)
  4. end_hour_of_day : int;
    (*

    The hour of the day to end the bandwidth rate limit interval.

    *)
  5. start_hour_of_day : int;
    (*

    The hour of the day to start the bandwidth rate limit interval.

    *)
  6. average_upload_rate_limit_in_bits_per_sec : int option;
    (*

    The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

    For Backup Gateway, the minimum value is (Value).

    *)
}

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

type nonrec put_bandwidth_rate_limit_schedule_input = {
  1. bandwidth_rate_limit_intervals : bandwidth_rate_limit_interval list;
    (*

    An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

    *)
  2. gateway_arn : string;
    (*

    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.

    *)
}
type nonrec maintenance_start_time = {
  1. minute_of_hour : int;
    (*

    The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

    *)
  2. hour_of_day : int;
    (*

    The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

    *)
  3. day_of_week : int option;
    (*

    An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

    *)
  4. day_of_month : int option;
    (*

    The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

    *)
}

This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

type nonrec list_virtual_machines_output = {
  1. next_token : string option;
    (*

    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.

    *)
  2. virtual_machines : virtual_machine list option;
    (*

    A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

    *)
}
type nonrec list_virtual_machines_input = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The maximum number of virtual machines to list.

    *)
  3. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

    *)
}
type nonrec list_tags_for_resource_output = {
  1. tags : tag list option;
    (*

    A list of the resource's tags.

    *)
  2. resource_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the resource's tags that you listed.

    *)
}
type nonrec list_tags_for_resource_input = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the resource's tags to list.

    *)
}
type nonrec hypervisor_state =
  1. | PENDING
  2. | ONLINE
  3. | OFFLINE
  4. | ERROR
type nonrec hypervisor = {
  1. state : hypervisor_state option;
    (*

    The state of the hypervisor.

    *)
  2. name : string option;
    (*

    The name of the hypervisor.

    *)
  3. kms_key_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.

    *)
  4. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
  5. host : string option;
    (*

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

    *)
}

Represents the hypervisor's permissions to which the gateway will connect.

A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

type nonrec list_hypervisors_output = {
  1. next_token : string option;
    (*

    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.

    *)
  2. hypervisors : hypervisor list option;
    (*

    A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).

    *)
}
type nonrec list_hypervisors_input = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The maximum number of hypervisors to list.

    *)
}
type nonrec gateway_type =
  1. | BACKUP_VM
type nonrec gateway = {
  1. last_seen_time : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The last time Backup gateway communicated with the gateway, in Unix format and UTC time.

    *)
  2. hypervisor_id : string option;
    (*

    The hypervisor ID of the gateway.

    *)
  3. gateway_type : gateway_type option;
    (*

    The type of the gateway.

    *)
  4. gateway_display_name : string option;
    (*

    The display name of the gateway.

    *)
  5. gateway_arn : string option;
    (*

    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.

    *)
}

A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.

type nonrec list_gateways_output = {
  1. next_token : string option;
    (*

    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.

    *)
  2. gateways : gateway list option;
    (*

    A list of your gateways.

    *)
}
type nonrec list_gateways_input = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The maximum number of gateways to list.

    *)
}
type nonrec internal_server_exception = {
  1. message : string option;
  2. error_code : string option;
    (*

    A description of which internal error occured.

    *)
}

The operation did not succeed because an internal error occurred. Try again later.

type nonrec import_hypervisor_configuration_output = {
  1. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor you disassociated.

    *)
}
type nonrec import_hypervisor_configuration_input = {
  1. tags : tag list option;
    (*

    The tags of the hypervisor configuration to import.

    *)
  2. kms_key_arn : string option;
    (*

    The Key Management Service for the hypervisor.

    *)
  3. password : string option;
    (*

    The password for the hypervisor.

    *)
  4. username : string option;
    (*

    The username for the hypervisor.

    *)
  5. host : string;
    (*

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

    *)
  6. name : string;
    (*

    The name of the hypervisor.

    *)
}
type nonrec hypervisor_details = {
  1. latest_metadata_sync_status : sync_metadata_status option;
    (*

    This is the most recent status for the indicated metadata sync.

    *)
  2. latest_metadata_sync_status_message : string option;
    (*

    This is the most recent status for the indicated metadata sync.

    *)
  3. last_successful_metadata_sync_time : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    This is the time when the most recent successful sync of metadata occurred.

    *)
  4. state : hypervisor_state option;
    (*

    This is the current state of the specified hypervisor.

    The possible states are PENDING, ONLINE, OFFLINE, or ERROR.

    *)
  5. log_group_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the group of gateways within the requested log.

    *)
  6. name : string option;
    (*

    This is the name of the specified hypervisor.

    *)
  7. kms_key_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.

    *)
  8. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
  9. host : string option;
    (*

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

    *)
}

These are the details of the specified hypervisor. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

type nonrec get_virtual_machine_output = {
  1. virtual_machine : virtual_machine_details option;
    (*

    This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine

    *)
}
type nonrec get_virtual_machine_input = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the virtual machine.

    *)
}
type nonrec get_hypervisor_property_mappings_output = {
  1. iam_role_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the IAM role.

    *)
  2. vmware_to_aws_tag_mappings : vmware_to_aws_tag_mapping list option;
    (*

    This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.

    *)
  3. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
}
type nonrec get_hypervisor_property_mappings_input = {
  1. hypervisor_arn : string;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
}
type nonrec get_hypervisor_output = {
  1. hypervisor : hypervisor_details option;
    (*

    Details about the requested hypervisor.

    *)
}
type nonrec get_hypervisor_input = {
  1. hypervisor_arn : string;
    (*

    The Amazon Resource Name (ARN) of the hypervisor.

    *)
}
type nonrec gateway_details = {
  1. vpc_endpoint : string option;
    (*

    The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.

    *)
  2. next_update_availability_time : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    Details showing the next update availability time of the gateway.

    *)
  3. maintenance_start_time : maintenance_start_time option;
    (*

    Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

    *)
  4. last_seen_time : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.

    *)
  5. hypervisor_id : string option;
    (*

    The hypervisor ID of the gateway.

    *)
  6. gateway_type : gateway_type option;
    (*

    The type of the gateway type.

    *)
  7. gateway_display_name : string option;
    (*

    The display name of the gateway.

    *)
  8. gateway_arn : string option;
    (*

    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.

    *)
}

The details of gateway.

type nonrec get_gateway_output = {
  1. gateway : gateway_details option;
    (*

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

    *)
}
type nonrec get_gateway_input = {
  1. gateway_arn : string;
    (*

    The Amazon Resource Name (ARN) of the gateway.

    *)
}
type nonrec get_bandwidth_rate_limit_schedule_output = {
  1. bandwidth_rate_limit_intervals : bandwidth_rate_limit_interval list option;
    (*

    An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

    *)
  2. gateway_arn : string option;
    (*

    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.

    *)
}
type nonrec get_bandwidth_rate_limit_schedule_input = {
  1. gateway_arn : string;
    (*

    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.

    *)
}
type nonrec disassociate_gateway_from_server_output = {
  1. gateway_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the gateway you disassociated.

    *)
}
type nonrec disassociate_gateway_from_server_input = {
  1. gateway_arn : string;
    (*

    The Amazon Resource Name (ARN) of the gateway to disassociate.

    *)
}
type nonrec delete_hypervisor_output = {
  1. hypervisor_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the hypervisor you deleted.

    *)
}
type nonrec delete_hypervisor_input = {
  1. hypervisor_arn : string;
    (*

    The Amazon Resource Name (ARN) of the hypervisor to delete.

    *)
}
type nonrec delete_gateway_output = {
  1. gateway_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the gateway you deleted.

    *)
}
type nonrec delete_gateway_input = {
  1. gateway_arn : string;
    (*

    The Amazon Resource Name (ARN) of the gateway to delete.

    *)
}
type nonrec create_gateway_output = {
  1. gateway_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the gateway you create.

    *)
}
type nonrec create_gateway_input = {
  1. tags : tag list option;
    (*

    A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

    *)
  2. gateway_type : gateway_type;
    (*

    The type of created gateway.

    *)
  3. gateway_display_name : string;
    (*

    The display name of the created gateway.

    *)
  4. activation_key : string;
    (*

    The activation key of the created gateway.

    *)
}
type nonrec associate_gateway_to_server_output = {
  1. gateway_arn : string option;
    (*

    The Amazon Resource Name (ARN) of a gateway.

    *)
}
type nonrec associate_gateway_to_server_input = {
  1. server_arn : string;
    (*

    The Amazon Resource Name (ARN) of the server that hosts your virtual machines.

    *)
  2. gateway_arn : string;
    (*

    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.

    *)
}

Builders

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