Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- AssociateGatewayToServer
- CreateGateway
- DeleteGateway
- DeleteHypervisor
- DisassociateGatewayFromServer
- GetBandwidthRateLimitSchedule
- GetGateway
- GetHypervisor
- GetHypervisorPropertyMappings
- GetVirtualMachine
- ImportHypervisorConfiguration
- ListGateways
- ListHypervisors
- ListTagsForResource
- ListVirtualMachines
- PutBandwidthRateLimitSchedule
- PutHypervisorPropertyMappings
- PutMaintenanceStartTime
- StartVirtualMachinesMetadataSync
- TagResource
- TestHypervisorConfiguration
- UntagResource
- UpdateGatewayInformation
- UpdateGatewaySoftwareNow
- UpdateHypervisor
- Types
Synopsis
- associateGatewayToServer_gatewayArn :: Lens' AssociateGatewayToServer Text
- associateGatewayToServer_serverArn :: Lens' AssociateGatewayToServer Text
- associateGatewayToServerResponse_gatewayArn :: Lens' AssociateGatewayToServerResponse (Maybe Text)
- associateGatewayToServerResponse_httpStatus :: Lens' AssociateGatewayToServerResponse Int
- createGateway_tags :: Lens' CreateGateway (Maybe [Tag])
- createGateway_activationKey :: Lens' CreateGateway Text
- createGateway_gatewayDisplayName :: Lens' CreateGateway Text
- createGateway_gatewayType :: Lens' CreateGateway GatewayType
- createGatewayResponse_gatewayArn :: Lens' CreateGatewayResponse (Maybe Text)
- createGatewayResponse_httpStatus :: Lens' CreateGatewayResponse Int
- deleteGateway_gatewayArn :: Lens' DeleteGateway Text
- deleteGatewayResponse_gatewayArn :: Lens' DeleteGatewayResponse (Maybe Text)
- deleteGatewayResponse_httpStatus :: Lens' DeleteGatewayResponse Int
- deleteHypervisor_hypervisorArn :: Lens' DeleteHypervisor Text
- deleteHypervisorResponse_hypervisorArn :: Lens' DeleteHypervisorResponse (Maybe Text)
- deleteHypervisorResponse_httpStatus :: Lens' DeleteHypervisorResponse Int
- disassociateGatewayFromServer_gatewayArn :: Lens' DisassociateGatewayFromServer Text
- disassociateGatewayFromServerResponse_gatewayArn :: Lens' DisassociateGatewayFromServerResponse (Maybe Text)
- disassociateGatewayFromServerResponse_httpStatus :: Lens' DisassociateGatewayFromServerResponse Int
- getBandwidthRateLimitSchedule_gatewayArn :: Lens' GetBandwidthRateLimitSchedule Text
- getBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals :: Lens' GetBandwidthRateLimitScheduleResponse (Maybe [BandwidthRateLimitInterval])
- getBandwidthRateLimitScheduleResponse_gatewayArn :: Lens' GetBandwidthRateLimitScheduleResponse (Maybe Text)
- getBandwidthRateLimitScheduleResponse_httpStatus :: Lens' GetBandwidthRateLimitScheduleResponse Int
- getGateway_gatewayArn :: Lens' GetGateway Text
- getGatewayResponse_gateway :: Lens' GetGatewayResponse (Maybe GatewayDetails)
- getGatewayResponse_httpStatus :: Lens' GetGatewayResponse Int
- getHypervisor_hypervisorArn :: Lens' GetHypervisor Text
- getHypervisorResponse_hypervisor :: Lens' GetHypervisorResponse (Maybe HypervisorDetails)
- getHypervisorResponse_httpStatus :: Lens' GetHypervisorResponse Int
- getHypervisorPropertyMappings_hypervisorArn :: Lens' GetHypervisorPropertyMappings Text
- getHypervisorPropertyMappingsResponse_hypervisorArn :: Lens' GetHypervisorPropertyMappingsResponse (Maybe Text)
- getHypervisorPropertyMappingsResponse_iamRoleArn :: Lens' GetHypervisorPropertyMappingsResponse (Maybe Text)
- getHypervisorPropertyMappingsResponse_vmwareToAwsTagMappings :: Lens' GetHypervisorPropertyMappingsResponse (Maybe [VmwareToAwsTagMapping])
- getHypervisorPropertyMappingsResponse_httpStatus :: Lens' GetHypervisorPropertyMappingsResponse Int
- getVirtualMachine_resourceArn :: Lens' GetVirtualMachine Text
- getVirtualMachineResponse_virtualMachine :: Lens' GetVirtualMachineResponse (Maybe VirtualMachineDetails)
- getVirtualMachineResponse_httpStatus :: Lens' GetVirtualMachineResponse Int
- importHypervisorConfiguration_kmsKeyArn :: Lens' ImportHypervisorConfiguration (Maybe Text)
- importHypervisorConfiguration_password :: Lens' ImportHypervisorConfiguration (Maybe Text)
- importHypervisorConfiguration_tags :: Lens' ImportHypervisorConfiguration (Maybe [Tag])
- importHypervisorConfiguration_username :: Lens' ImportHypervisorConfiguration (Maybe Text)
- importHypervisorConfiguration_host :: Lens' ImportHypervisorConfiguration Text
- importHypervisorConfiguration_name :: Lens' ImportHypervisorConfiguration Text
- importHypervisorConfigurationResponse_hypervisorArn :: Lens' ImportHypervisorConfigurationResponse (Maybe Text)
- importHypervisorConfigurationResponse_httpStatus :: Lens' ImportHypervisorConfigurationResponse Int
- listGateways_maxResults :: Lens' ListGateways (Maybe Natural)
- listGateways_nextToken :: Lens' ListGateways (Maybe Text)
- listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [Gateway])
- listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text)
- listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int
- listHypervisors_maxResults :: Lens' ListHypervisors (Maybe Natural)
- listHypervisors_nextToken :: Lens' ListHypervisors (Maybe Text)
- listHypervisorsResponse_hypervisors :: Lens' ListHypervisorsResponse (Maybe [Hypervisor])
- listHypervisorsResponse_nextToken :: Lens' ListHypervisorsResponse (Maybe Text)
- listHypervisorsResponse_httpStatus :: Lens' ListHypervisorsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listVirtualMachines_hypervisorArn :: Lens' ListVirtualMachines (Maybe Text)
- listVirtualMachines_maxResults :: Lens' ListVirtualMachines (Maybe Natural)
- listVirtualMachines_nextToken :: Lens' ListVirtualMachines (Maybe Text)
- listVirtualMachinesResponse_nextToken :: Lens' ListVirtualMachinesResponse (Maybe Text)
- listVirtualMachinesResponse_virtualMachines :: Lens' ListVirtualMachinesResponse (Maybe [VirtualMachine])
- listVirtualMachinesResponse_httpStatus :: Lens' ListVirtualMachinesResponse Int
- putBandwidthRateLimitSchedule_bandwidthRateLimitIntervals :: Lens' PutBandwidthRateLimitSchedule [BandwidthRateLimitInterval]
- putBandwidthRateLimitSchedule_gatewayArn :: Lens' PutBandwidthRateLimitSchedule Text
- putBandwidthRateLimitScheduleResponse_gatewayArn :: Lens' PutBandwidthRateLimitScheduleResponse (Maybe Text)
- putBandwidthRateLimitScheduleResponse_httpStatus :: Lens' PutBandwidthRateLimitScheduleResponse Int
- putHypervisorPropertyMappings_hypervisorArn :: Lens' PutHypervisorPropertyMappings Text
- putHypervisorPropertyMappings_iamRoleArn :: Lens' PutHypervisorPropertyMappings Text
- putHypervisorPropertyMappings_vmwareToAwsTagMappings :: Lens' PutHypervisorPropertyMappings [VmwareToAwsTagMapping]
- putHypervisorPropertyMappingsResponse_hypervisorArn :: Lens' PutHypervisorPropertyMappingsResponse (Maybe Text)
- putHypervisorPropertyMappingsResponse_httpStatus :: Lens' PutHypervisorPropertyMappingsResponse Int
- putMaintenanceStartTime_dayOfMonth :: Lens' PutMaintenanceStartTime (Maybe Natural)
- putMaintenanceStartTime_dayOfWeek :: Lens' PutMaintenanceStartTime (Maybe Natural)
- putMaintenanceStartTime_gatewayArn :: Lens' PutMaintenanceStartTime Text
- putMaintenanceStartTime_hourOfDay :: Lens' PutMaintenanceStartTime Natural
- putMaintenanceStartTime_minuteOfHour :: Lens' PutMaintenanceStartTime Natural
- putMaintenanceStartTimeResponse_gatewayArn :: Lens' PutMaintenanceStartTimeResponse (Maybe Text)
- putMaintenanceStartTimeResponse_httpStatus :: Lens' PutMaintenanceStartTimeResponse Int
- startVirtualMachinesMetadataSync_hypervisorArn :: Lens' StartVirtualMachinesMetadataSync Text
- startVirtualMachinesMetadataSyncResponse_hypervisorArn :: Lens' StartVirtualMachinesMetadataSyncResponse (Maybe Text)
- startVirtualMachinesMetadataSyncResponse_httpStatus :: Lens' StartVirtualMachinesMetadataSyncResponse Int
- tagResource_resourceARN :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_resourceARN :: Lens' TagResourceResponse (Maybe Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- testHypervisorConfiguration_password :: Lens' TestHypervisorConfiguration (Maybe Text)
- testHypervisorConfiguration_username :: Lens' TestHypervisorConfiguration (Maybe Text)
- testHypervisorConfiguration_gatewayArn :: Lens' TestHypervisorConfiguration Text
- testHypervisorConfiguration_host :: Lens' TestHypervisorConfiguration Text
- testHypervisorConfigurationResponse_httpStatus :: Lens' TestHypervisorConfigurationResponse Int
- untagResource_resourceARN :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_resourceARN :: Lens' UntagResourceResponse (Maybe Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateGatewayInformation_gatewayDisplayName :: Lens' UpdateGatewayInformation (Maybe Text)
- updateGatewayInformation_gatewayArn :: Lens' UpdateGatewayInformation Text
- updateGatewayInformationResponse_gatewayArn :: Lens' UpdateGatewayInformationResponse (Maybe Text)
- updateGatewayInformationResponse_httpStatus :: Lens' UpdateGatewayInformationResponse Int
- updateGatewaySoftwareNow_gatewayArn :: Lens' UpdateGatewaySoftwareNow Text
- updateGatewaySoftwareNowResponse_gatewayArn :: Lens' UpdateGatewaySoftwareNowResponse (Maybe Text)
- updateGatewaySoftwareNowResponse_httpStatus :: Lens' UpdateGatewaySoftwareNowResponse Int
- updateHypervisor_host :: Lens' UpdateHypervisor (Maybe Text)
- updateHypervisor_logGroupArn :: Lens' UpdateHypervisor (Maybe Text)
- updateHypervisor_name :: Lens' UpdateHypervisor (Maybe Text)
- updateHypervisor_password :: Lens' UpdateHypervisor (Maybe Text)
- updateHypervisor_username :: Lens' UpdateHypervisor (Maybe Text)
- updateHypervisor_hypervisorArn :: Lens' UpdateHypervisor Text
- updateHypervisorResponse_hypervisorArn :: Lens' UpdateHypervisorResponse (Maybe Text)
- updateHypervisorResponse_httpStatus :: Lens' UpdateHypervisorResponse Int
- bandwidthRateLimitInterval_averageUploadRateLimitInBitsPerSec :: Lens' BandwidthRateLimitInterval (Maybe Natural)
- bandwidthRateLimitInterval_daysOfWeek :: Lens' BandwidthRateLimitInterval (NonEmpty Natural)
- bandwidthRateLimitInterval_endHourOfDay :: Lens' BandwidthRateLimitInterval Natural
- bandwidthRateLimitInterval_endMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural
- bandwidthRateLimitInterval_startHourOfDay :: Lens' BandwidthRateLimitInterval Natural
- bandwidthRateLimitInterval_startMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural
- gateway_gatewayArn :: Lens' Gateway (Maybe Text)
- gateway_gatewayDisplayName :: Lens' Gateway (Maybe Text)
- gateway_gatewayType :: Lens' Gateway (Maybe GatewayType)
- gateway_hypervisorId :: Lens' Gateway (Maybe Text)
- gateway_lastSeenTime :: Lens' Gateway (Maybe UTCTime)
- gatewayDetails_gatewayArn :: Lens' GatewayDetails (Maybe Text)
- gatewayDetails_gatewayDisplayName :: Lens' GatewayDetails (Maybe Text)
- gatewayDetails_gatewayType :: Lens' GatewayDetails (Maybe GatewayType)
- gatewayDetails_hypervisorId :: Lens' GatewayDetails (Maybe Text)
- gatewayDetails_lastSeenTime :: Lens' GatewayDetails (Maybe UTCTime)
- gatewayDetails_maintenanceStartTime :: Lens' GatewayDetails (Maybe MaintenanceStartTime)
- gatewayDetails_nextUpdateAvailabilityTime :: Lens' GatewayDetails (Maybe UTCTime)
- gatewayDetails_vpcEndpoint :: Lens' GatewayDetails (Maybe Text)
- hypervisor_host :: Lens' Hypervisor (Maybe Text)
- hypervisor_hypervisorArn :: Lens' Hypervisor (Maybe Text)
- hypervisor_kmsKeyArn :: Lens' Hypervisor (Maybe Text)
- hypervisor_name :: Lens' Hypervisor (Maybe Text)
- hypervisor_state :: Lens' Hypervisor (Maybe HypervisorState)
- hypervisorDetails_host :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_hypervisorArn :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_kmsKeyArn :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_lastSuccessfulMetadataSyncTime :: Lens' HypervisorDetails (Maybe UTCTime)
- hypervisorDetails_latestMetadataSyncStatus :: Lens' HypervisorDetails (Maybe SyncMetadataStatus)
- hypervisorDetails_latestMetadataSyncStatusMessage :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_logGroupArn :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_name :: Lens' HypervisorDetails (Maybe Text)
- hypervisorDetails_state :: Lens' HypervisorDetails (Maybe HypervisorState)
- maintenanceStartTime_dayOfMonth :: Lens' MaintenanceStartTime (Maybe Natural)
- maintenanceStartTime_dayOfWeek :: Lens' MaintenanceStartTime (Maybe Natural)
- maintenanceStartTime_hourOfDay :: Lens' MaintenanceStartTime Natural
- maintenanceStartTime_minuteOfHour :: Lens' MaintenanceStartTime Natural
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- virtualMachine_hostName :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_hypervisorId :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_lastBackupDate :: Lens' VirtualMachine (Maybe UTCTime)
- virtualMachine_name :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_path :: Lens' VirtualMachine (Maybe Text)
- virtualMachine_resourceArn :: Lens' VirtualMachine (Maybe Text)
- virtualMachineDetails_hostName :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_hypervisorId :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_lastBackupDate :: Lens' VirtualMachineDetails (Maybe UTCTime)
- virtualMachineDetails_name :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_path :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_resourceArn :: Lens' VirtualMachineDetails (Maybe Text)
- virtualMachineDetails_vmwareTags :: Lens' VirtualMachineDetails (Maybe [VmwareTag])
- vmwareTag_vmwareCategory :: Lens' VmwareTag (Maybe Text)
- vmwareTag_vmwareTagDescription :: Lens' VmwareTag (Maybe Text)
- vmwareTag_vmwareTagName :: Lens' VmwareTag (Maybe Text)
- vmwareToAwsTagMapping_awsTagKey :: Lens' VmwareToAwsTagMapping Text
- vmwareToAwsTagMapping_awsTagValue :: Lens' VmwareToAwsTagMapping Text
- vmwareToAwsTagMapping_vmwareCategory :: Lens' VmwareToAwsTagMapping Text
- vmwareToAwsTagMapping_vmwareTagName :: Lens' VmwareToAwsTagMapping Text
Operations
AssociateGatewayToServer
associateGatewayToServer_gatewayArn :: Lens' AssociateGatewayToServer Text Source #
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.
associateGatewayToServer_serverArn :: Lens' AssociateGatewayToServer Text Source #
The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
associateGatewayToServerResponse_gatewayArn :: Lens' AssociateGatewayToServerResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of a gateway.
associateGatewayToServerResponse_httpStatus :: Lens' AssociateGatewayToServerResponse Int Source #
The response's http status code.
CreateGateway
createGateway_tags :: Lens' CreateGateway (Maybe [Tag]) Source #
A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
createGateway_activationKey :: Lens' CreateGateway Text Source #
The activation key of the created gateway.
createGateway_gatewayDisplayName :: Lens' CreateGateway Text Source #
The display name of the created gateway.
createGateway_gatewayType :: Lens' CreateGateway GatewayType Source #
The type of created gateway.
createGatewayResponse_gatewayArn :: Lens' CreateGatewayResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway you create.
createGatewayResponse_httpStatus :: Lens' CreateGatewayResponse Int Source #
The response's http status code.
DeleteGateway
deleteGateway_gatewayArn :: Lens' DeleteGateway Text Source #
The Amazon Resource Name (ARN) of the gateway to delete.
deleteGatewayResponse_gatewayArn :: Lens' DeleteGatewayResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway you deleted.
deleteGatewayResponse_httpStatus :: Lens' DeleteGatewayResponse Int Source #
The response's http status code.
DeleteHypervisor
deleteHypervisor_hypervisorArn :: Lens' DeleteHypervisor Text Source #
The Amazon Resource Name (ARN) of the hypervisor to delete.
deleteHypervisorResponse_hypervisorArn :: Lens' DeleteHypervisorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor you deleted.
deleteHypervisorResponse_httpStatus :: Lens' DeleteHypervisorResponse Int Source #
The response's http status code.
DisassociateGatewayFromServer
disassociateGatewayFromServer_gatewayArn :: Lens' DisassociateGatewayFromServer Text Source #
The Amazon Resource Name (ARN) of the gateway to disassociate.
disassociateGatewayFromServerResponse_gatewayArn :: Lens' DisassociateGatewayFromServerResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway you disassociated.
disassociateGatewayFromServerResponse_httpStatus :: Lens' DisassociateGatewayFromServerResponse Int Source #
The response's http status code.
GetBandwidthRateLimitSchedule
getBandwidthRateLimitSchedule_gatewayArn :: Lens' GetBandwidthRateLimitSchedule Text Source #
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.
getBandwidthRateLimitScheduleResponse_bandwidthRateLimitIntervals :: Lens' GetBandwidthRateLimitScheduleResponse (Maybe [BandwidthRateLimitInterval]) Source #
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
getBandwidthRateLimitScheduleResponse_gatewayArn :: Lens' GetBandwidthRateLimitScheduleResponse (Maybe Text) Source #
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.
getBandwidthRateLimitScheduleResponse_httpStatus :: Lens' GetBandwidthRateLimitScheduleResponse Int Source #
The response's http status code.
GetGateway
getGateway_gatewayArn :: Lens' GetGateway Text Source #
The Amazon Resource Name (ARN) of the gateway.
getGatewayResponse_gateway :: Lens' GetGatewayResponse (Maybe GatewayDetails) Source #
By providing the ARN (Amazon Resource Name), this API returns the gateway.
getGatewayResponse_httpStatus :: Lens' GetGatewayResponse Int Source #
The response's http status code.
GetHypervisor
getHypervisor_hypervisorArn :: Lens' GetHypervisor Text Source #
The Amazon Resource Name (ARN) of the hypervisor.
getHypervisorResponse_hypervisor :: Lens' GetHypervisorResponse (Maybe HypervisorDetails) Source #
Details about the requested hypervisor.
getHypervisorResponse_httpStatus :: Lens' GetHypervisorResponse Int Source #
The response's http status code.
GetHypervisorPropertyMappings
getHypervisorPropertyMappings_hypervisorArn :: Lens' GetHypervisorPropertyMappings Text Source #
The Amazon Resource Name (ARN) of the hypervisor.
getHypervisorPropertyMappingsResponse_hypervisorArn :: Lens' GetHypervisorPropertyMappingsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor.
getHypervisorPropertyMappingsResponse_iamRoleArn :: Lens' GetHypervisorPropertyMappingsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role.
getHypervisorPropertyMappingsResponse_vmwareToAwsTagMappings :: Lens' GetHypervisorPropertyMappingsResponse (Maybe [VmwareToAwsTagMapping]) Source #
This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.
getHypervisorPropertyMappingsResponse_httpStatus :: Lens' GetHypervisorPropertyMappingsResponse Int Source #
The response's http status code.
GetVirtualMachine
getVirtualMachine_resourceArn :: Lens' GetVirtualMachine Text Source #
The Amazon Resource Name (ARN) of the virtual machine.
getVirtualMachineResponse_virtualMachine :: Lens' GetVirtualMachineResponse (Maybe VirtualMachineDetails) Source #
This object contains the basic attributes of VirtualMachine
contained
by the output of GetVirtualMachine
getVirtualMachineResponse_httpStatus :: Lens' GetVirtualMachineResponse Int Source #
The response's http status code.
ImportHypervisorConfiguration
importHypervisorConfiguration_kmsKeyArn :: Lens' ImportHypervisorConfiguration (Maybe Text) Source #
The Key Management Service for the hypervisor.
importHypervisorConfiguration_password :: Lens' ImportHypervisorConfiguration (Maybe Text) Source #
The password for the hypervisor.
importHypervisorConfiguration_tags :: Lens' ImportHypervisorConfiguration (Maybe [Tag]) Source #
The tags of the hypervisor configuration to import.
importHypervisorConfiguration_username :: Lens' ImportHypervisorConfiguration (Maybe Text) Source #
The username for the hypervisor.
importHypervisorConfiguration_host :: Lens' ImportHypervisorConfiguration Text Source #
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
importHypervisorConfiguration_name :: Lens' ImportHypervisorConfiguration Text Source #
The name of the hypervisor.
importHypervisorConfigurationResponse_hypervisorArn :: Lens' ImportHypervisorConfigurationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor you disassociated.
importHypervisorConfigurationResponse_httpStatus :: Lens' ImportHypervisorConfigurationResponse Int Source #
The response's http status code.
ListGateways
listGateways_maxResults :: Lens' ListGateways (Maybe Natural) Source #
The maximum number of gateways to list.
listGateways_nextToken :: Lens' ListGateways (Maybe Text) Source #
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.
listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [Gateway]) Source #
A list of your gateways.
listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text) Source #
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.
listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int Source #
The response's http status code.
ListHypervisors
listHypervisors_maxResults :: Lens' ListHypervisors (Maybe Natural) Source #
The maximum number of hypervisors to list.
listHypervisors_nextToken :: Lens' ListHypervisors (Maybe Text) Source #
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.
listHypervisorsResponse_hypervisors :: Lens' ListHypervisorsResponse (Maybe [Hypervisor]) Source #
A list of your Hypervisor
objects, ordered by their Amazon Resource
Names (ARNs).
listHypervisorsResponse_nextToken :: Lens' ListHypervisorsResponse (Maybe Text) Source #
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.
listHypervisorsResponse_httpStatus :: Lens' ListHypervisorsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the resource's tags to list.
listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource's tags that you listed.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
A list of the resource's tags.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListVirtualMachines
listVirtualMachines_hypervisorArn :: Lens' ListVirtualMachines (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
listVirtualMachines_maxResults :: Lens' ListVirtualMachines (Maybe Natural) Source #
The maximum number of virtual machines to list.
listVirtualMachines_nextToken :: Lens' ListVirtualMachines (Maybe Text) Source #
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.
listVirtualMachinesResponse_nextToken :: Lens' ListVirtualMachinesResponse (Maybe Text) Source #
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.
listVirtualMachinesResponse_virtualMachines :: Lens' ListVirtualMachinesResponse (Maybe [VirtualMachine]) Source #
A list of your VirtualMachine
objects, ordered by their Amazon
Resource Names (ARNs).
listVirtualMachinesResponse_httpStatus :: Lens' ListVirtualMachinesResponse Int Source #
The response's http status code.
PutBandwidthRateLimitSchedule
putBandwidthRateLimitSchedule_bandwidthRateLimitIntervals :: Lens' PutBandwidthRateLimitSchedule [BandwidthRateLimitInterval] Source #
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
putBandwidthRateLimitSchedule_gatewayArn :: Lens' PutBandwidthRateLimitSchedule Text Source #
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.
putBandwidthRateLimitScheduleResponse_gatewayArn :: Lens' PutBandwidthRateLimitScheduleResponse (Maybe Text) Source #
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.
putBandwidthRateLimitScheduleResponse_httpStatus :: Lens' PutBandwidthRateLimitScheduleResponse Int Source #
The response's http status code.
PutHypervisorPropertyMappings
putHypervisorPropertyMappings_hypervisorArn :: Lens' PutHypervisorPropertyMappings Text Source #
The Amazon Resource Name (ARN) of the hypervisor.
putHypervisorPropertyMappings_iamRoleArn :: Lens' PutHypervisorPropertyMappings Text Source #
The Amazon Resource Name (ARN) of the IAM role.
putHypervisorPropertyMappings_vmwareToAwsTagMappings :: Lens' PutHypervisorPropertyMappings [VmwareToAwsTagMapping] Source #
This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.
putHypervisorPropertyMappingsResponse_hypervisorArn :: Lens' PutHypervisorPropertyMappingsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor.
putHypervisorPropertyMappingsResponse_httpStatus :: Lens' PutHypervisorPropertyMappingsResponse Int Source #
The response's http status code.
PutMaintenanceStartTime
putMaintenanceStartTime_dayOfMonth :: Lens' PutMaintenanceStartTime (Maybe Natural) Source #
The day of the month start maintenance on a gateway.
Valid values range from Sunday
to Saturday
.
putMaintenanceStartTime_dayOfWeek :: Lens' PutMaintenanceStartTime (Maybe Natural) Source #
The day of the week to start maintenance on a gateway.
putMaintenanceStartTime_gatewayArn :: Lens' PutMaintenanceStartTime Text Source #
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.
putMaintenanceStartTime_hourOfDay :: Lens' PutMaintenanceStartTime Natural Source #
The hour of the day to start maintenance on a gateway.
putMaintenanceStartTime_minuteOfHour :: Lens' PutMaintenanceStartTime Natural Source #
The minute of the hour to start maintenance on a gateway.
putMaintenanceStartTimeResponse_gatewayArn :: Lens' PutMaintenanceStartTimeResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.
putMaintenanceStartTimeResponse_httpStatus :: Lens' PutMaintenanceStartTimeResponse Int Source #
The response's http status code.
StartVirtualMachinesMetadataSync
startVirtualMachinesMetadataSync_hypervisorArn :: Lens' StartVirtualMachinesMetadataSync Text Source #
The Amazon Resource Name (ARN) of the hypervisor.
startVirtualMachinesMetadataSyncResponse_hypervisorArn :: Lens' StartVirtualMachinesMetadataSyncResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor.
startVirtualMachinesMetadataSyncResponse_httpStatus :: Lens' StartVirtualMachinesMetadataSyncResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceARN :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the resource to tag.
tagResource_tags :: Lens' TagResource [Tag] Source #
A list of tags to assign to the resource.
tagResourceResponse_resourceARN :: Lens' TagResourceResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource you tagged.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
TestHypervisorConfiguration
testHypervisorConfiguration_password :: Lens' TestHypervisorConfiguration (Maybe Text) Source #
The password for the hypervisor.
testHypervisorConfiguration_username :: Lens' TestHypervisorConfiguration (Maybe Text) Source #
The username for the hypervisor.
testHypervisorConfiguration_gatewayArn :: Lens' TestHypervisorConfiguration Text Source #
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
testHypervisorConfiguration_host :: Lens' TestHypervisorConfiguration Text Source #
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
testHypervisorConfigurationResponse_httpStatus :: Lens' TestHypervisorConfigurationResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceARN :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the resource from which to remove tags.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The list of tag keys specifying which tags to remove.
untagResourceResponse_resourceARN :: Lens' UntagResourceResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource from which you removed tags.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateGatewayInformation
updateGatewayInformation_gatewayDisplayName :: Lens' UpdateGatewayInformation (Maybe Text) Source #
The updated display name of the gateway.
updateGatewayInformation_gatewayArn :: Lens' UpdateGatewayInformation Text Source #
The Amazon Resource Name (ARN) of the gateway to update.
updateGatewayInformationResponse_gatewayArn :: Lens' UpdateGatewayInformationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway you updated.
updateGatewayInformationResponse_httpStatus :: Lens' UpdateGatewayInformationResponse Int Source #
The response's http status code.
UpdateGatewaySoftwareNow
updateGatewaySoftwareNow_gatewayArn :: Lens' UpdateGatewaySoftwareNow Text Source #
The Amazon Resource Name (ARN) of the gateway to be updated.
updateGatewaySoftwareNowResponse_gatewayArn :: Lens' UpdateGatewaySoftwareNowResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the gateway you updated.
updateGatewaySoftwareNowResponse_httpStatus :: Lens' UpdateGatewaySoftwareNowResponse Int Source #
The response's http status code.
UpdateHypervisor
updateHypervisor_host :: Lens' UpdateHypervisor (Maybe Text) Source #
The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
updateHypervisor_logGroupArn :: Lens' UpdateHypervisor (Maybe Text) Source #
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
updateHypervisor_name :: Lens' UpdateHypervisor (Maybe Text) Source #
The updated name for the hypervisor
updateHypervisor_password :: Lens' UpdateHypervisor (Maybe Text) Source #
The updated password for the hypervisor.
updateHypervisor_username :: Lens' UpdateHypervisor (Maybe Text) Source #
The updated username for the hypervisor.
updateHypervisor_hypervisorArn :: Lens' UpdateHypervisor Text Source #
The Amazon Resource Name (ARN) of the hypervisor to update.
updateHypervisorResponse_hypervisorArn :: Lens' UpdateHypervisorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor you updated.
updateHypervisorResponse_httpStatus :: Lens' UpdateHypervisorResponse Int Source #
The response's http status code.
Types
BandwidthRateLimitInterval
bandwidthRateLimitInterval_averageUploadRateLimitInBitsPerSec :: Lens' BandwidthRateLimitInterval (Maybe Natural) Source #
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)
.
bandwidthRateLimitInterval_daysOfWeek :: Lens' BandwidthRateLimitInterval (NonEmpty Natural) Source #
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.
bandwidthRateLimitInterval_endHourOfDay :: Lens' BandwidthRateLimitInterval Natural Source #
The hour of the day to end the bandwidth rate limit interval.
bandwidthRateLimitInterval_endMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural Source #
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
.
bandwidthRateLimitInterval_startHourOfDay :: Lens' BandwidthRateLimitInterval Natural Source #
The hour of the day to start the bandwidth rate limit interval.
bandwidthRateLimitInterval_startMinuteOfHour :: Lens' BandwidthRateLimitInterval Natural Source #
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
.
Gateway
gateway_gatewayArn :: Lens' Gateway (Maybe Text) Source #
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.
gateway_gatewayType :: Lens' Gateway (Maybe GatewayType) Source #
The type of the gateway.
gateway_lastSeenTime :: Lens' Gateway (Maybe UTCTime) Source #
The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
GatewayDetails
gatewayDetails_gatewayArn :: Lens' GatewayDetails (Maybe Text) Source #
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.
gatewayDetails_gatewayDisplayName :: Lens' GatewayDetails (Maybe Text) Source #
The display name of the gateway.
gatewayDetails_gatewayType :: Lens' GatewayDetails (Maybe GatewayType) Source #
The type of the gateway type.
gatewayDetails_hypervisorId :: Lens' GatewayDetails (Maybe Text) Source #
The hypervisor ID of the gateway.
gatewayDetails_lastSeenTime :: Lens' GatewayDetails (Maybe UTCTime) Source #
Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.
gatewayDetails_maintenanceStartTime :: Lens' GatewayDetails (Maybe MaintenanceStartTime) Source #
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.
gatewayDetails_nextUpdateAvailabilityTime :: Lens' GatewayDetails (Maybe UTCTime) Source #
Details showing the next update availability time of the gateway.
gatewayDetails_vpcEndpoint :: Lens' GatewayDetails (Maybe Text) Source #
The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.
Hypervisor
hypervisor_host :: Lens' Hypervisor (Maybe Text) Source #
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
hypervisor_hypervisorArn :: Lens' Hypervisor (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor.
hypervisor_kmsKeyArn :: Lens' Hypervisor (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.
hypervisor_name :: Lens' Hypervisor (Maybe Text) Source #
The name of the hypervisor.
hypervisor_state :: Lens' Hypervisor (Maybe HypervisorState) Source #
The state of the hypervisor.
HypervisorDetails
hypervisorDetails_host :: Lens' HypervisorDetails (Maybe Text) Source #
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
hypervisorDetails_hypervisorArn :: Lens' HypervisorDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the hypervisor.
hypervisorDetails_kmsKeyArn :: Lens' HypervisorDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.
hypervisorDetails_lastSuccessfulMetadataSyncTime :: Lens' HypervisorDetails (Maybe UTCTime) Source #
This is the time when the most recent successful sync of metadata occurred.
hypervisorDetails_latestMetadataSyncStatus :: Lens' HypervisorDetails (Maybe SyncMetadataStatus) Source #
This is the most recent status for the indicated metadata sync.
hypervisorDetails_latestMetadataSyncStatusMessage :: Lens' HypervisorDetails (Maybe Text) Source #
This is the most recent status for the indicated metadata sync.
hypervisorDetails_logGroupArn :: Lens' HypervisorDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
hypervisorDetails_name :: Lens' HypervisorDetails (Maybe Text) Source #
This is the name of the specified hypervisor.
hypervisorDetails_state :: Lens' HypervisorDetails (Maybe HypervisorState) Source #
This is the current state of the specified hypervisor.
The possible states are PENDING
, ONLINE
, OFFLINE
, or ERROR
.
MaintenanceStartTime
maintenanceStartTime_dayOfMonth :: Lens' MaintenanceStartTime (Maybe Natural) Source #
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.
maintenanceStartTime_dayOfWeek :: Lens' MaintenanceStartTime (Maybe Natural) Source #
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.
maintenanceStartTime_hourOfDay :: Lens' MaintenanceStartTime Natural Source #
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.
maintenanceStartTime_minuteOfHour :: Lens' MaintenanceStartTime Natural Source #
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.
Tag
tag_key :: Lens' Tag Text Source #
The key part of a tag's key-value pair. The key can't start with
aws:
.
VirtualMachine
virtualMachine_hostName :: Lens' VirtualMachine (Maybe Text) Source #
The host name of the virtual machine.
virtualMachine_hypervisorId :: Lens' VirtualMachine (Maybe Text) Source #
The ID of the virtual machine's hypervisor.
virtualMachine_lastBackupDate :: Lens' VirtualMachine (Maybe UTCTime) Source #
The most recent date a virtual machine was backed up, in Unix format and UTC time.
virtualMachine_name :: Lens' VirtualMachine (Maybe Text) Source #
The name of the virtual machine.
virtualMachine_path :: Lens' VirtualMachine (Maybe Text) Source #
The path of the virtual machine.
virtualMachine_resourceArn :: Lens' VirtualMachine (Maybe Text) Source #
The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
VirtualMachineDetails
virtualMachineDetails_hostName :: Lens' VirtualMachineDetails (Maybe Text) Source #
The host name of the virtual machine.
virtualMachineDetails_hypervisorId :: Lens' VirtualMachineDetails (Maybe Text) Source #
The ID of the virtual machine's hypervisor.
virtualMachineDetails_lastBackupDate :: Lens' VirtualMachineDetails (Maybe UTCTime) Source #
The most recent date a virtual machine was backed up, in Unix format and UTC time.
virtualMachineDetails_name :: Lens' VirtualMachineDetails (Maybe Text) Source #
The name of the virtual machine.
virtualMachineDetails_path :: Lens' VirtualMachineDetails (Maybe Text) Source #
The path of the virtual machine.
virtualMachineDetails_resourceArn :: Lens' VirtualMachineDetails (Maybe Text) Source #
The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL
.
virtualMachineDetails_vmwareTags :: Lens' VirtualMachineDetails (Maybe [VmwareTag]) Source #
These are the details of the VMware tags associated with the specified virtual machine.
VmwareTag
vmwareTag_vmwareTagDescription :: Lens' VmwareTag (Maybe Text) Source #
This is a user-defined description of a VMware tag.
vmwareTag_vmwareTagName :: Lens' VmwareTag (Maybe Text) Source #
This is the user-defined name of a VMware tag.
VmwareToAwsTagMapping
vmwareToAwsTagMapping_awsTagKey :: Lens' VmwareToAwsTagMapping Text Source #
The key part of the Amazon Web Services tag's key-value pair.
vmwareToAwsTagMapping_awsTagValue :: Lens' VmwareToAwsTagMapping Text Source #
The value part of the Amazon Web Services tag's key-value pair.
vmwareToAwsTagMapping_vmwareCategory :: Lens' VmwareToAwsTagMapping Text Source #
The is the category of VMware.
vmwareToAwsTagMapping_vmwareTagName :: Lens' VmwareToAwsTagMapping Text Source #
This is the user-defined name of a VMware tag.