amazonka-backup-gateway-2.0: Amazon Backup Gateway SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.BackupGateway.Lens

Description

 
Synopsis

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.

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.

createGatewayResponse_gatewayArn :: Lens' CreateGatewayResponse (Maybe Text) Source #

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

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.

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.

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.

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.

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.

GetHypervisor

getHypervisor_hypervisorArn :: Lens' GetHypervisor Text Source #

The Amazon Resource Name (ARN) of the hypervisor.

GetHypervisorPropertyMappings

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.

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

ImportHypervisorConfiguration

importHypervisorConfiguration_tags :: Lens' ImportHypervisorConfiguration (Maybe [Tag]) Source #

The tags of the hypervisor configuration to import.

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

importHypervisorConfigurationResponse_hypervisorArn :: Lens' ImportHypervisorConfigurationResponse (Maybe Text) Source #

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

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

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.

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.

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

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.

PutHypervisorPropertyMappings

putHypervisorPropertyMappings_vmwareToAwsTagMappings :: Lens' PutHypervisorPropertyMappings [VmwareToAwsTagMapping] Source #

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

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.

StartVirtualMachinesMetadataSync

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.

TestHypervisorConfiguration

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

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.

UpdateGatewayInformation

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.

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.

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.

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_gatewayDisplayName :: Lens' Gateway (Maybe Text) Source #

The display name of the gateway.

gateway_hypervisorId :: Lens' Gateway (Maybe Text) Source #

The hypervisor ID 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_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:.

tag_value :: Lens' Tag Text Source #

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

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_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_vmwareCategory :: Lens' VmwareTag (Maybe Text) Source #

The is the category of VMware.

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_vmwareTagName :: Lens' VmwareToAwsTagMapping Text Source #

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