AWSBackupGateway (AWS SDK for Java

All Known Subinterfaces:

AWSBackupGatewayAsync

All Known Implementing Classes:

AbstractAWSBackupGateway, AbstractAWSBackupGatewayAsync, AWSBackupGatewayAsyncClient, AWSBackupGatewayClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBackupGateway
```
Interface for accessing AWS Backup Gateway.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSBackupGateway instead.

Backup gateway
Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateGatewayToServerResult`	`associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest)` Associates a backup gateway with your server.
`CreateGatewayResult`	`createGateway(CreateGatewayRequest createGatewayRequest)` Creates a backup gateway.
`DeleteGatewayResult`	`deleteGateway(DeleteGatewayRequest deleteGatewayRequest)` Deletes a backup gateway.
`DeleteHypervisorResult`	`deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest)` Deletes a hypervisor.
`DisassociateGatewayFromServerResult`	`disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest)` Disassociates a backup gateway from the specified server.
`GetBandwidthRateLimitScheduleResult`	`getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest)` Retrieves the bandwidth rate limit schedule for a specified gateway.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetGatewayResult`	`getGateway(GetGatewayRequest getGatewayRequest)` By providing the ARN (Amazon Resource Name), this API returns the gateway.
`GetHypervisorResult`	`getHypervisor(GetHypervisorRequest getHypervisorRequest)` This action requests information about the specified hypervisor to which the gateway will connect.
`GetHypervisorPropertyMappingsResult`	`getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest)` This action retrieves the property mappings for the specified hypervisor.
`GetVirtualMachineResult`	`getVirtualMachine(GetVirtualMachineRequest getVirtualMachineRequest)` By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
`ImportHypervisorConfigurationResult`	`importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest)` Connect to a hypervisor by importing its configuration.
`ListGatewaysResult`	`listGateways(ListGatewaysRequest listGatewaysRequest)` Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
`ListHypervisorsResult`	`listHypervisors(ListHypervisorsRequest listHypervisorsRequest)` Lists your hypervisors.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
`ListVirtualMachinesResult`	`listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest)` Lists your virtual machines.
`PutBandwidthRateLimitScheduleResult`	`putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest)` This action sets the bandwidth rate limit schedule for a specified gateway.
`PutHypervisorPropertyMappingsResult`	`putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest)` This action sets the property mappings for the specified hypervisor.
`PutMaintenanceStartTimeResult`	`putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest)` Set the maintenance start time for a gateway.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartVirtualMachinesMetadataSyncResult`	`startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest)` This action sends a request to sync metadata across the specified virtual machines.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Tag the resource.
`TestHypervisorConfigurationResult`	`testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest)` Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags from the resource.
`UpdateGatewayInformationResult`	`updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)` Updates a gateway's name.
`UpdateGatewaySoftwareNowResult`	`updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)` Updates the gateway virtual machine (VM) software.
`UpdateHypervisorResult`	`updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest)` Updates a hypervisor metadata, including its host, username, and password.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateGatewayToServer
```
AssociateGatewayToServerResult associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest)
```
    Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
    
    Parameters:
    
    associateGatewayToServerRequest -
    
    Returns:
    
    Result of the AssociateGatewayToServer operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - createGateway
```
CreateGatewayResult createGateway(CreateGatewayRequest createGatewayRequest)
```
    Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.
    
    Parameters:
    
    createGatewayRequest -
    
    Returns:
    
    Result of the CreateGateway operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - deleteGateway
```
DeleteGatewayResult deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
```
    Deletes a backup gateway.
    
    Parameters:
    
    deleteGatewayRequest -
    
    Returns:
    
    Result of the DeleteGateway operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - deleteHypervisor
```
DeleteHypervisorResult deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest)
```
    Deletes a hypervisor.
    
    Parameters:
    
    deleteHypervisorRequest -
    
    Returns:
    
    Result of the DeleteHypervisor operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    AccessDeniedException - The operation cannot proceed because you have insufficient permissions.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - disassociateGatewayFromServer
```
DisassociateGatewayFromServerResult disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest)
```
    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.
    
    Parameters:
    
    disassociateGatewayFromServerRequest -
    
    Returns:
    
    Result of the DisassociateGatewayFromServer operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - getBandwidthRateLimitSchedule
```
GetBandwidthRateLimitScheduleResult getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest)
```
    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.
    
    Parameters:
    
    getBandwidthRateLimitScheduleRequest -
    
    Returns:
    
    Result of the GetBandwidthRateLimitSchedule operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - getGateway
```
GetGatewayResult getGateway(GetGatewayRequest getGatewayRequest)
```
    By providing the ARN (Amazon Resource Name), this API returns the gateway.
    
    Parameters:
    
    getGatewayRequest -
    
    Returns:
    
    Result of the GetGateway operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - getHypervisor
```
GetHypervisorResult getHypervisor(GetHypervisorRequest getHypervisorRequest)
```
    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.
    
    Parameters:
    
    getHypervisorRequest -
    
    Returns:
    
    Result of the GetHypervisor operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - getHypervisorPropertyMappings
```
GetHypervisorPropertyMappingsResult getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest)
```
    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.
    
    Parameters:
    
    getHypervisorPropertyMappingsRequest -
    
    Returns:
    
    Result of the GetHypervisorPropertyMappings operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - getVirtualMachine
```
GetVirtualMachineResult getVirtualMachine(GetVirtualMachineRequest getVirtualMachineRequest)
```
    By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
    
    Parameters:
    
    getVirtualMachineRequest -
    
    Returns:
    
    Result of the GetVirtualMachine operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - importHypervisorConfiguration
```
ImportHypervisorConfigurationResult importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest)
```
    Connect to a hypervisor by importing its configuration.
    
    Parameters:
    
    importHypervisorConfigurationRequest -
    
    Returns:
    
    Result of the ImportHypervisorConfiguration operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    AccessDeniedException - The operation cannot proceed because you have insufficient permissions.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - listGateways
```
ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest)
```
    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).
    
    Parameters:
    
    listGatewaysRequest -
    
    Returns:
    
    Result of the ListGateways operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - listHypervisors
```
ListHypervisorsResult listHypervisors(ListHypervisorsRequest listHypervisorsRequest)
```
    Lists your hypervisors.
    
    Parameters:
    
    listHypervisorsRequest -
    
    Returns:
    
    Result of the ListHypervisors operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - listVirtualMachines
```
ListVirtualMachinesResult listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest)
```
    Lists your virtual machines.
    
    Parameters:
    
    listVirtualMachinesRequest -
    
    Returns:
    
    Result of the ListVirtualMachines operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - putBandwidthRateLimitSchedule
```
PutBandwidthRateLimitScheduleResult putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest)
```
    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.
    
    Parameters:
    
    putBandwidthRateLimitScheduleRequest -
    
    Returns:
    
    Result of the PutBandwidthRateLimitSchedule operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - putHypervisorPropertyMappings
```
PutHypervisorPropertyMappingsResult putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest)
```
    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.
    
    Parameters:
    
    putHypervisorPropertyMappingsRequest -
    
    Returns:
    
    Result of the PutHypervisorPropertyMappings operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    AccessDeniedException - The operation cannot proceed because you have insufficient permissions.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - putMaintenanceStartTime
```
PutMaintenanceStartTimeResult putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest)
```
    Set the maintenance start time for a gateway.
    
    Parameters:
    
    putMaintenanceStartTimeRequest -
    
    Returns:
    
    Result of the PutMaintenanceStartTime operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - startVirtualMachinesMetadataSync
```
StartVirtualMachinesMetadataSyncResult startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest)
```
    This action sends a request to sync metadata across the specified virtual machines.
    
    Parameters:
    
    startVirtualMachinesMetadataSyncRequest -
    
    Returns:
    
    Result of the StartVirtualMachinesMetadataSync operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    AccessDeniedException - The operation cannot proceed because you have insufficient permissions.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Tag the resource.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - testHypervisorConfiguration
```
TestHypervisorConfigurationResult testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest)
```
    Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
    
    Parameters:
    
    testHypervisorConfigurationRequest -
    
    Returns:
    
    Result of the TestHypervisorConfiguration operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from the resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - updateGatewayInformation
```
UpdateGatewayInformationResult updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
```
    Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
    
    Parameters:
    
    updateGatewayInformationRequest -
    
    Returns:
    
    Result of the UpdateGatewayInformation operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - updateGatewaySoftwareNow
```
UpdateGatewaySoftwareNowResult updateGatewaySoftwareNow(UpdateGatewaySoftwareNowRequest updateGatewaySoftwareNowRequest)
```
    Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.
    
    When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.
    
    Parameters:
    
    updateGatewaySoftwareNowRequest -
    
    Returns:
    
    Result of the UpdateGatewaySoftwareNow operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - updateHypervisor
```
UpdateHypervisorResult updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest)
```
    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.
    
    Parameters:
    
    updateHypervisorRequest -
    
    Returns:
    
    Result of the UpdateHypervisor operation returned by the service.
    
    Throws:
    
    ValidationException - The operation did not succeed because a validation error occurred.
    
    ConflictException - The operation cannot proceed because it is not supported.
    
    InternalServerException - The operation did not succeed because an internal error occurred. Try again later.
    
    AccessDeniedException - The operation cannot proceed because you have insufficient permissions.
    
    ResourceNotFoundException - A resource that is required for the action wasn't found.
    
    ThrottlingException - TPS has been limited to protect against intentional or unintentional high request volumes.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.773

Interface AWSBackupGateway

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

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

shutdown

getCachedResponseMetadata