Smaws_Client_BackupGateway.Types
type nonrec vmware_to_aws_tag_mapping = {
aws_tag_value : tag_value;
The value part of the Amazon Web Services tag's key-value pair.
*)aws_tag_key : tag_key;
The key part of the Amazon Web Services tag's key-value pair.
*)vmware_tag_name : vmware_tag_name;
This is the user-defined name of a VMware tag.
*)vmware_category : vmware_category;
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_to_aws_tag_mappings = vmware_to_aws_tag_mapping list
type nonrec vmware_tag = {
vmware_tag_description : string_ option;
This is a user-defined description of a VMware tag.
*)vmware_tag_name : vmware_tag_name option;
This is the user-defined name of a VMware tag.
*)vmware_category : vmware_category 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 vmware_tags = vmware_tag list
type nonrec virtual_machine = {
last_backup_date : time option;
The most recent date a virtual machine was backed up, in Unix format and UTC time.
*)resource_arn : resource_arn option;
The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
path : path option;
The path of the virtual machine.
*)name : name option;
The name of the virtual machine.
*)hypervisor_id : string_ option;
The ID of the virtual machine's hypervisor.
*)host_name : name option;
The host name of the virtual machine.
*)}
A virtual machine that is on a hypervisor.
type nonrec virtual_machines = virtual_machine list
type nonrec virtual_machine_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec virtual_machine_details = {
last_backup_date : time option;
The most recent date a virtual machine was backed up, in Unix format and UTC time.
*)resource_arn : resource_arn option;
The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
path : path option;
The path of the virtual machine.
*)name : name option;
The name of the virtual machine.
*)hypervisor_id : string_ option;
The ID of the virtual machine's hypervisor.
*)host_name : name option;
The host name of the virtual machine.
*)}
Your VirtualMachine
objects, ordered by their Amazon Resource Names (ARNs).
type nonrec validation_exception = {
message : string_ option;
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 = {
hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor you updated.
*)}
type nonrec update_hypervisor_input = {
log_group_arn : log_group_arn option;
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
*)name : name option;
The updated name for the hypervisor
*)password : password option;
The updated password for the hypervisor.
*)username : username option;
The updated username for the hypervisor.
*)host : host option;
The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*)hypervisor_arn : server_arn;
The Amazon Resource Name (ARN) of the hypervisor to update.
*)}
type nonrec resource_not_found_exception = {
message : string_ option;
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 = {
message : string_ option;
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 = {
message : string_ option;
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 = {
gateway_arn : gateway_arn option;
The Amazon Resource Name (ARN) of the gateway you updated.
*)}
type nonrec update_gateway_software_now_input = {
gateway_arn : gateway_arn;
The Amazon Resource Name (ARN) of the gateway to be updated.
*)}
type nonrec update_gateway_information_output = {
gateway_arn : gateway_arn option;
The Amazon Resource Name (ARN) of the gateway you updated.
*)}
type nonrec update_gateway_information_input = {
gateway_display_name : name option;
The updated display name of the gateway.
*)gateway_arn : gateway_arn;
The Amazon Resource Name (ARN) of the gateway to update.
*)}
type nonrec untag_resource_output = {
resource_ar_n : resource_arn option;
The Amazon Resource Name (ARN) of the resource from which you removed tags.
*)}
type nonrec tag_keys = tag_key list
type nonrec untag_resource_input = {
tag_keys : tag_keys;
The list of tag keys specifying which tags to remove.
*)resource_ar_n : resource_arn;
The Amazon Resource Name (ARN) of the resource from which to remove tags.
*)}
type nonrec throttling_exception = {
message : string_ option;
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 = {
password : password option;
The password for the hypervisor.
*)username : username option;
The username for the hypervisor.
*)host : host;
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*)gateway_arn : gateway_arn;
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
*)}
type nonrec tag = {
value : tag_value;
The value part of a tag's key-value pair.
*)key : tag_key;
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 tags = tag list
type nonrec tag_resource_output = {
resource_ar_n : resource_arn option;
The Amazon Resource Name (ARN) of the resource you tagged.
*)}
type nonrec tag_resource_input = {
resource_ar_n : resource_arn;
The Amazon Resource Name (ARN) of the resource to tag.
*)}
type nonrec start_virtual_machines_metadata_sync_output = {
hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor.
*)}
type nonrec start_virtual_machines_metadata_sync_input = {
hypervisor_arn : server_arn;
The Amazon Resource Name (ARN) of the hypervisor.
*)}
type nonrec put_maintenance_start_time_output = {
gateway_arn : gateway_arn option;
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.
*)}
type nonrec put_maintenance_start_time_input = {
day_of_month : day_of_month option;
The day of the month start maintenance on a gateway.
Valid values range from Sunday
to Saturday
.
day_of_week : day_of_week option;
The day of the week to start maintenance on a gateway.
*)minute_of_hour : minute_of_hour;
The minute of the hour to start maintenance on a gateway.
*)hour_of_day : hour_of_day;
The hour of the day to start maintenance on a gateway.
*)gateway_arn : gateway_arn;
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.
*)}
type nonrec put_hypervisor_property_mappings_output = {
hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor.
*)}
type nonrec put_hypervisor_property_mappings_input = {
iam_role_arn : iam_role_arn;
The Amazon Resource Name (ARN) of the IAM role.
*)vmware_to_aws_tag_mappings : vmware_to_aws_tag_mappings;
This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.
*)hypervisor_arn : server_arn;
The Amazon Resource Name (ARN) of the hypervisor.
*)}
type nonrec put_bandwidth_rate_limit_schedule_output = {
gateway_arn : gateway_arn 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 days_of_week = day_of_week list
type nonrec bandwidth_rate_limit_interval = {
days_of_week : days_of_week;
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.
*)end_minute_of_hour : minute_of_hour;
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
.
start_minute_of_hour : minute_of_hour;
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
.
end_hour_of_day : hour_of_day;
The hour of the day to end the bandwidth rate limit interval.
*)start_hour_of_day : hour_of_day;
The hour of the day to start the bandwidth rate limit interval.
*)average_upload_rate_limit_in_bits_per_sec : average_upload_rate_limit 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 bandwidth_rate_limit_intervals = bandwidth_rate_limit_interval list
type nonrec put_bandwidth_rate_limit_schedule_input = {
bandwidth_rate_limit_intervals : bandwidth_rate_limit_intervals;
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
*)gateway_arn : 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.
}
type nonrec maintenance_start_time = {
minute_of_hour : minute_of_hour;
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.
*)hour_of_day : hour_of_day;
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.
*)day_of_week : day_of_week 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.
*)day_of_month : day_of_month 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 = {
next_token : next_token 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.
virtual_machines : virtual_machines option;
A list of your VirtualMachine
objects, ordered by their Amazon Resource Names (ARNs).
}
type nonrec list_virtual_machines_input = {
next_token : next_token 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.
max_results : max_results option;
The maximum number of virtual machines to list.
*)hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
*)}
type nonrec hypervisor = {
state : hypervisor_state option;
The state of the hypervisor.
*)name : name option;
The name of the hypervisor.
*)kms_key_arn : kms_key_arn option;
The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.
*)hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor.
*)host : host 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 hypervisors = hypervisor list
type nonrec list_hypervisors_output = {
next_token : next_token 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.
hypervisors : hypervisors option;
A list of your Hypervisor
objects, ordered by their Amazon Resource Names (ARNs).
}
type nonrec list_hypervisors_input = {
next_token : next_token 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.
max_results : max_results option;
The maximum number of hypervisors to list.
*)}
type nonrec gateway = {
last_seen_time : time option;
The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
*)hypervisor_id : hypervisor_id option;
The hypervisor ID of the gateway.
*)gateway_type : gateway_type option;
The type of the gateway.
*)gateway_display_name : name option;
The display name of the gateway.
*)gateway_arn : gateway_arn 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 gateways = gateway list
type nonrec list_gateways_output = {
next_token : next_token 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.
gateways : gateways option;
A list of your gateways.
*)}
type nonrec list_gateways_input = {
next_token : next_token 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.
max_results : max_results option;
The maximum number of gateways to list.
*)}
type nonrec internal_server_exception = {
message : string_ option;
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 = {
hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor you disassociated.
*)}
type nonrec import_hypervisor_configuration_input = {
kms_key_arn : kms_key_arn option;
The Key Management Service for the hypervisor.
*)password : password option;
The password for the hypervisor.
*)username : username option;
The username for the hypervisor.
*)host : host;
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
*)name : name;
The name of the hypervisor.
*)}
type nonrec hypervisor_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec hypervisor_property_mapping_resource =
Smaws_Lib.CoreTypes.Resource.t
type nonrec hypervisor_details = {
latest_metadata_sync_status : sync_metadata_status option;
This is the most recent status for the indicated metadata sync.
*)latest_metadata_sync_status_message : string_ option;
This is the most recent status for the indicated metadata sync.
*)last_successful_metadata_sync_time : time option;
This is the time when the most recent successful sync of metadata occurred.
*)state : hypervisor_state option;
This is the current state of the specified hypervisor.
The possible states are PENDING
, ONLINE
, OFFLINE
, or ERROR
.
log_group_arn : log_group_arn option;
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
*)name : name option;
This is the name of the specified hypervisor.
*)kms_key_arn : kms_key_arn option;
The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.
*)hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor.
*)host : host 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 = {
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 = {
resource_arn : resource_arn;
The Amazon Resource Name (ARN) of the virtual machine.
*)}
type nonrec get_hypervisor_property_mappings_output = {
iam_role_arn : iam_role_arn option;
The Amazon Resource Name (ARN) of the IAM role.
*)vmware_to_aws_tag_mappings : vmware_to_aws_tag_mappings option;
This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.
*)hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor.
*)}
type nonrec get_hypervisor_property_mappings_input = {
hypervisor_arn : server_arn;
The Amazon Resource Name (ARN) of the hypervisor.
*)}
type nonrec get_hypervisor_output = {
hypervisor : hypervisor_details option;
Details about the requested hypervisor.
*)}
type nonrec get_hypervisor_input = {
hypervisor_arn : server_arn;
The Amazon Resource Name (ARN) of the hypervisor.
*)}
type nonrec gateway_details = {
vpc_endpoint : vpc_endpoint option;
The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.
*)next_update_availability_time : time option;
Details showing the next update availability time of the gateway.
*)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.
*)last_seen_time : time option;
Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.
*)hypervisor_id : hypervisor_id option;
The hypervisor ID of the gateway.
*)gateway_type : gateway_type option;
The type of the gateway type.
*)gateway_display_name : name option;
The display name of the gateway.
*)gateway_arn : gateway_arn 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 = {
gateway : gateway_details option;
By providing the ARN (Amazon Resource Name), this API returns the gateway.
*)}
type nonrec get_gateway_input = {
gateway_arn : gateway_arn;
The Amazon Resource Name (ARN) of the gateway.
*)}
type nonrec get_bandwidth_rate_limit_schedule_output = {
bandwidth_rate_limit_intervals : bandwidth_rate_limit_intervals 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.
*)gateway_arn : gateway_arn 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 = {
gateway_arn : 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.
}
type nonrec gateway_resource = Smaws_Lib.CoreTypes.Resource.t
type nonrec disassociate_gateway_from_server_output = {
gateway_arn : gateway_arn option;
The Amazon Resource Name (ARN) of the gateway you disassociated.
*)}
type nonrec disassociate_gateway_from_server_input = {
gateway_arn : gateway_arn;
The Amazon Resource Name (ARN) of the gateway to disassociate.
*)}
type nonrec delete_hypervisor_output = {
hypervisor_arn : server_arn option;
The Amazon Resource Name (ARN) of the hypervisor you deleted.
*)}
type nonrec delete_hypervisor_input = {
hypervisor_arn : server_arn;
The Amazon Resource Name (ARN) of the hypervisor to delete.
*)}
type nonrec delete_gateway_output = {
gateway_arn : gateway_arn option;
The Amazon Resource Name (ARN) of the gateway you deleted.
*)}
type nonrec delete_gateway_input = {
gateway_arn : gateway_arn;
The Amazon Resource Name (ARN) of the gateway to delete.
*)}
type nonrec create_gateway_output = {
gateway_arn : gateway_arn option;
The Amazon Resource Name (ARN) of the gateway you create.
*)}
type nonrec create_gateway_input = {
gateway_type : gateway_type;
The type of created gateway.
*)gateway_display_name : name;
The display name of the created gateway.
*)activation_key : activation_key;
The activation key of the created gateway.
*)}
type nonrec bandwidth_rate_limit_schedule_resource =
Smaws_Lib.CoreTypes.Resource.t
type nonrec associate_gateway_to_server_output = {
gateway_arn : gateway_arn option;
The Amazon Resource Name (ARN) of a gateway.
*)}
type nonrec associate_gateway_to_server_input = {
server_arn : server_arn;
The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
*)gateway_arn : 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.
}