com.amazonaws.services.backupgateway

Class AWSBackupGatewayClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.backupgateway.AWSBackupGatewayClient

All Implemented Interfaces:

AWSBackupGateway

Direct Known Subclasses:

AWSBackupGatewayAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBackupGatewayClient
extends AmazonWebServiceClient
implements AWSBackupGateway

Client for accessing AWS Backup Gateway. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.backupgateway.AWSBackupGateway

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateGatewayToServerResult	associateGatewayToServer(AssociateGatewayToServerRequest request) Associates a backup gateway with your server.
static AWSBackupGatewayClientBuilder	builder()
CreateGatewayResult	createGateway(CreateGatewayRequest request) Creates a backup gateway.
DeleteGatewayResult	deleteGateway(DeleteGatewayRequest request) Deletes a backup gateway.
DeleteHypervisorResult	deleteHypervisor(DeleteHypervisorRequest request) Deletes a hypervisor.
DisassociateGatewayFromServerResult	disassociateGatewayFromServer(DisassociateGatewayFromServerRequest request) Disassociates a backup gateway from the specified server.
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.
ImportHypervisorConfigurationResult	importHypervisorConfiguration(ImportHypervisorConfigurationRequest request) Connect to a hypervisor by importing its configuration.
ListGatewaysResult	listGateways(ListGatewaysRequest request) Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
ListHypervisorsResult	listHypervisors(ListHypervisorsRequest request) Lists your hypervisors.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
ListVirtualMachinesResult	listVirtualMachines(ListVirtualMachinesRequest request) Lists your virtual machines.
PutMaintenanceStartTimeResult	putMaintenanceStartTime(PutMaintenanceStartTimeRequest request) Set the maintenance start time for a gateway.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Tag the resource.
TestHypervisorConfigurationResult	testHypervisorConfiguration(TestHypervisorConfigurationRequest request) Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from the resource.
UpdateGatewayInformationResult	updateGatewayInformation(UpdateGatewayInformationRequest request) Updates a gateway's name.
UpdateHypervisorResult	updateHypervisor(UpdateHypervisorRequest request) Updates a hypervisor metadata, including its host, username, and password.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSBackupGatewayClientBuilder builder()

associateGatewayToServer

public AssociateGatewayToServerResult associateGatewayToServer(AssociateGatewayToServerRequest request)

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Specified by:

associateGatewayToServer in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

createGateway

public CreateGatewayResult createGateway(CreateGatewayRequest request)

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Specified by:

createGateway in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

deleteGateway

public DeleteGatewayResult deleteGateway(DeleteGatewayRequest request)

Deletes a backup gateway.

Specified by:

deleteGateway in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

deleteHypervisor

public DeleteHypervisorResult deleteHypervisor(DeleteHypervisorRequest request)

Deletes a hypervisor.

Specified by:

deleteHypervisor in interface AWSBackupGateway

Parameters:

deleteHypervisorRequest -

Returns:

Result of the DeleteHypervisor 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.

See Also:

AWS API Documentation

disassociateGatewayFromServer

public DisassociateGatewayFromServerResult disassociateGatewayFromServer(DisassociateGatewayFromServerRequest request)

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.

Specified by:

disassociateGatewayFromServer in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

importHypervisorConfiguration

public ImportHypervisorConfigurationResult importHypervisorConfiguration(ImportHypervisorConfigurationRequest request)

Connect to a hypervisor by importing its configuration.

Specified by:

importHypervisorConfiguration in interface AWSBackupGateway

Parameters:

importHypervisorConfigurationRequest -

Returns:

Result of the ImportHypervisorConfiguration 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.

See Also:

AWS API Documentation

listGateways

public ListGatewaysResult listGateways(ListGatewaysRequest request)

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

Specified by:

listGateways in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

listHypervisors

public ListHypervisorsResult listHypervisors(ListHypervisorsRequest request)

Lists your hypervisors.

Specified by:

listHypervisors in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Specified by:

listTagsForResource in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

listVirtualMachines

public ListVirtualMachinesResult listVirtualMachines(ListVirtualMachinesRequest request)

Lists your virtual machines.

Specified by:

listVirtualMachines in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

putMaintenanceStartTime

public PutMaintenanceStartTimeResult putMaintenanceStartTime(PutMaintenanceStartTimeRequest request)

Set the maintenance start time for a gateway.

Specified by:

putMaintenanceStartTime in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Tag the resource.

Specified by:

tagResource in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

testHypervisorConfiguration

public TestHypervisorConfigurationResult testHypervisorConfiguration(TestHypervisorConfigurationRequest request)

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Specified by:

testHypervisorConfiguration in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from the resource.

Specified by:

untagResource in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

updateGatewayInformation

public UpdateGatewayInformationResult updateGatewayInformation(UpdateGatewayInformationRequest request)

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Specified by:

updateGatewayInformation in interface AWSBackupGateway

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.

See Also:

AWS API Documentation

updateHypervisor

public UpdateHypervisorResult updateHypervisor(UpdateHypervisorRequest request)

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.

Specified by:

updateHypervisor in interface AWSBackupGateway

Parameters:

updateHypervisorRequest -

Returns:

Result of the UpdateHypervisor 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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSBackupGateway

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSBackupGateway

Overrides:

shutdown in class AmazonWebServiceClient