com.amazonaws.services.backupgateway.AWSBackupGateway Maven / Gradle / Ivy
Show all versions of aws-java-sdk-backupgateway Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.backupgateway;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.backupgateway.model.*;
/**
* Interface for accessing AWS Backup Gateway.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.backupgateway.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.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBackupGateway {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "backup-gateway";
/**
*
* Associates a backup gateway with your server. After you complete the association process, you can back up and
* restore your VMs through the gateway.
*
*
* @param associateGatewayToServerRequest
* @return Result of the AssociateGatewayToServer operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws ConflictException
* The operation cannot proceed because it is not supported.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @sample AWSBackupGateway.AssociateGatewayToServer
* @see AWS API Documentation
*/
AssociateGatewayToServerResult associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest);
/**
*
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the
* AssociateGatewayToServer operation.
*
*
* @param createGatewayRequest
* @return Result of the CreateGateway operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @sample AWSBackupGateway.CreateGateway
* @see AWS
* API Documentation
*/
CreateGatewayResult createGateway(CreateGatewayRequest createGatewayRequest);
/**
*
* Deletes a backup gateway.
*
*
* @param deleteGatewayRequest
* @return Result of the DeleteGateway operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.DeleteGateway
* @see AWS
* API Documentation
*/
DeleteGatewayResult deleteGateway(DeleteGatewayRequest deleteGatewayRequest);
/**
*
* Deletes a hypervisor.
*
*
* @param deleteHypervisorRequest
* @return Result of the DeleteHypervisor operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws AccessDeniedException
* The operation cannot proceed because you have insufficient permissions.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.DeleteHypervisor
* @see AWS API Documentation
*/
DeleteHypervisorResult deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest);
/**
*
* 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.
*
*
* @param disassociateGatewayFromServerRequest
* @return Result of the DisassociateGatewayFromServer operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws ConflictException
* The operation cannot proceed because it is not supported.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.DisassociateGatewayFromServer
* @see AWS API Documentation
*/
DisassociateGatewayFromServerResult disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest);
/**
*
* Connect to a hypervisor by importing its configuration.
*
*
* @param importHypervisorConfigurationRequest
* @return Result of the ImportHypervisorConfiguration operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws AccessDeniedException
* The operation cannot proceed because you have insufficient permissions.
* @sample AWSBackupGateway.ImportHypervisorConfiguration
* @see AWS API Documentation
*/
ImportHypervisorConfigurationResult importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest);
/**
*
* 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).
*
*
* @param listGatewaysRequest
* @return Result of the ListGateways operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @sample AWSBackupGateway.ListGateways
* @see AWS
* API Documentation
*/
ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest);
/**
*
* Lists your hypervisors.
*
*
* @param listHypervisorsRequest
* @return Result of the ListHypervisors operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @sample AWSBackupGateway.ListHypervisors
* @see AWS
* API Documentation
*/
ListHypervisorsResult listHypervisors(ListHypervisorsRequest listHypervisorsRequest);
/**
*
* Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists your virtual machines.
*
*
* @param listVirtualMachinesRequest
* @return Result of the ListVirtualMachines operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @sample AWSBackupGateway.ListVirtualMachines
* @see AWS API Documentation
*/
ListVirtualMachinesResult listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest);
/**
*
* Set the maintenance start time for a gateway.
*
*
* @param putMaintenanceStartTimeRequest
* @return Result of the PutMaintenanceStartTime operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws ConflictException
* The operation cannot proceed because it is not supported.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.PutMaintenanceStartTime
* @see AWS API Documentation
*/
PutMaintenanceStartTimeResult putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest);
/**
*
* Tag the resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its
* resources.
*
*
* @param testHypervisorConfigurationRequest
* @return Result of the TestHypervisorConfiguration operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws ConflictException
* The operation cannot proceed because it is not supported.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.TestHypervisorConfiguration
* @see AWS API Documentation
*/
TestHypervisorConfigurationResult testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest);
/**
*
* Removes tags from the resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in
* your request.
*
*
* @param updateGatewayInformationRequest
* @return Result of the UpdateGatewayInformation operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws ConflictException
* The operation cannot proceed because it is not supported.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.UpdateGatewayInformation
* @see AWS API Documentation
*/
UpdateGatewayInformationResult updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest);
/**
*
* 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.
*
*
* @param updateHypervisorRequest
* @return Result of the UpdateHypervisor operation returned by the service.
* @throws ValidationException
* The operation did not succeed because a validation error occurred.
* @throws InternalServerException
* The operation did not succeed because an internal error occurred. Try again later.
* @throws AccessDeniedException
* The operation cannot proceed because you have insufficient permissions.
* @throws ResourceNotFoundException
* A resource that is required for the action wasn't found.
* @sample AWSBackupGateway.UpdateHypervisor
* @see AWS API Documentation
*/
UpdateHypervisorResult updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}