/* * Copyright 2018-2023 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 org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.backupgateway.AWSBackupGatewayClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.backupgateway.model.*; import com.amazonaws.services.backupgateway.model.transform.*; /** * 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 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. *
* */ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSBackupGatewayClient extends AmazonWebServiceClient implements AWSBackupGateway { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSBackupGateway.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "backup-gateway"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.0") .withSupportsCbor(false) .withSupportsIon(false) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessDeniedException").withExceptionUnmarshaller( com.amazonaws.services.backupgateway.model.transform.AccessDeniedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller( com.amazonaws.services.backupgateway.model.transform.ConflictExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.backupgateway.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller( com.amazonaws.services.backupgateway.model.transform.ThrottlingExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.backupgateway.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller( com.amazonaws.services.backupgateway.model.transform.InternalServerExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.backupgateway.model.AWSBackupGatewayException.class)); public static AWSBackupGatewayClientBuilder builder() { return AWSBackupGatewayClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS Backup Gateway using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSBackupGatewayClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS Backup Gateway using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSBackupGatewayClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("backup-gateway.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/backupgateway/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/backupgateway/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.AssociateGatewayToServer * @see AWS API Documentation */ @Override public AssociateGatewayToServerResult associateGatewayToServer(AssociateGatewayToServerRequest request) { request = beforeClientExecution(request); return executeAssociateGatewayToServer(request); } @SdkInternalApi final AssociateGatewayToServerResult executeAssociateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest) { ExecutionContext executionContext = createExecutionContext(associateGatewayToServerRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Creates a backup gateway. After you create a gateway, you can associate it with a server using the
* AssociateGatewayToServer
operation.
*
* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.DeleteGateway * @see AWS * API Documentation */ @Override public DeleteGatewayResult deleteGateway(DeleteGatewayRequest request) { request = beforeClientExecution(request); return executeDeleteGateway(request); } @SdkInternalApi final DeleteGatewayResult executeDeleteGateway(DeleteGatewayRequest deleteGatewayRequest) { ExecutionContext executionContext = createExecutionContext(deleteGatewayRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 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 AccessDeniedException * The operation cannot proceed because you have insufficient permissions. * @throws ResourceNotFoundException * A resource that is required for the action wasn't found. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.DeleteHypervisor * @see AWS API Documentation */ @Override public DeleteHypervisorResult deleteHypervisor(DeleteHypervisorRequest request) { request = beforeClientExecution(request); return executeDeleteHypervisor(request); } @SdkInternalApi final DeleteHypervisorResult executeDeleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest) { ExecutionContext executionContext = createExecutionContext(deleteHypervisorRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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. *
* * @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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.DisassociateGatewayFromServer * @see AWS API Documentation */ @Override public DisassociateGatewayFromServerResult disassociateGatewayFromServer(DisassociateGatewayFromServerRequest request) { request = beforeClientExecution(request); return executeDisassociateGatewayFromServer(request); } @SdkInternalApi final DisassociateGatewayFromServerResult executeDisassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest) { ExecutionContext executionContext = createExecutionContext(disassociateGatewayFromServerRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getBandwidthRateLimitScheduleRequest * @return Result of the GetBandwidthRateLimitSchedule 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.GetBandwidthRateLimitSchedule * @see AWS API Documentation */ @Override public GetBandwidthRateLimitScheduleResult getBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest request) { request = beforeClientExecution(request); return executeGetBandwidthRateLimitSchedule(request); } @SdkInternalApi final GetBandwidthRateLimitScheduleResult executeGetBandwidthRateLimitSchedule(GetBandwidthRateLimitScheduleRequest getBandwidthRateLimitScheduleRequest) { ExecutionContext executionContext = createExecutionContext(getBandwidthRateLimitScheduleRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* By providing the ARN (Amazon Resource Name), this API returns the gateway. *
* * @param getGatewayRequest * @return Result of the GetGateway 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.GetGateway * @see AWS API * Documentation */ @Override public GetGatewayResult getGateway(GetGatewayRequest request) { request = beforeClientExecution(request); return executeGetGateway(request); } @SdkInternalApi final GetGatewayResult executeGetGateway(GetGatewayRequest getGatewayRequest) { ExecutionContext executionContext = createExecutionContext(getGatewayRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getHypervisorRequest * @return Result of the GetHypervisor 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.GetHypervisor * @see AWS * API Documentation */ @Override public GetHypervisorResult getHypervisor(GetHypervisorRequest request) { request = beforeClientExecution(request); return executeGetHypervisor(request); } @SdkInternalApi final GetHypervisorResult executeGetHypervisor(GetHypervisorRequest getHypervisorRequest) { ExecutionContext executionContext = createExecutionContext(getHypervisorRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param getHypervisorPropertyMappingsRequest * @return Result of the GetHypervisorPropertyMappings 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.GetHypervisorPropertyMappings * @see AWS API Documentation */ @Override public GetHypervisorPropertyMappingsResult getHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest request) { request = beforeClientExecution(request); return executeGetHypervisorPropertyMappings(request); } @SdkInternalApi final GetHypervisorPropertyMappingsResult executeGetHypervisorPropertyMappings(GetHypervisorPropertyMappingsRequest getHypervisorPropertyMappingsRequest) { ExecutionContext executionContext = createExecutionContext(getHypervisorPropertyMappingsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* By providing the ARN (Amazon Resource Name), this API returns the virtual machine. *
* * @param getVirtualMachineRequest * @return Result of the GetVirtualMachine 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.GetVirtualMachine * @see AWS API Documentation */ @Override public GetVirtualMachineResult getVirtualMachine(GetVirtualMachineRequest request) { request = beforeClientExecution(request); return executeGetVirtualMachine(request); } @SdkInternalApi final GetVirtualMachineResult executeGetVirtualMachine(GetVirtualMachineRequest getVirtualMachineRequest) { ExecutionContext executionContext = createExecutionContext(getVirtualMachineRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 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 AccessDeniedException * The operation cannot proceed because you have insufficient permissions. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.ImportHypervisorConfiguration * @see AWS API Documentation */ @Override public ImportHypervisorConfigurationResult importHypervisorConfiguration(ImportHypervisorConfigurationRequest request) { request = beforeClientExecution(request); return executeImportHypervisorConfiguration(request); } @SdkInternalApi final ImportHypervisorConfigurationResult executeImportHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest) { ExecutionContext executionContext = createExecutionContext(importHypervisorConfigurationRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); 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). *
* * @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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.ListGateways * @see AWS * API Documentation */ @Override public ListGatewaysResult listGateways(ListGatewaysRequest request) { request = beforeClientExecution(request); return executeListGateways(request); } @SdkInternalApi final ListGatewaysResult executeListGateways(ListGatewaysRequest listGatewaysRequest) { ExecutionContext executionContext = createExecutionContext(listGatewaysRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.ListHypervisors * @see AWS * API Documentation */ @Override public ListHypervisorsResult listHypervisors(ListHypervisorsRequest request) { request = beforeClientExecution(request); return executeListHypervisors(request); } @SdkInternalApi final ListHypervisorsResult executeListHypervisors(ListHypervisorsRequest listHypervisorsRequest) { ExecutionContext executionContext = createExecutionContext(listHypervisorsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.ListTagsForResource * @see AWS API Documentation */ @Override public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) { request = beforeClientExecution(request); return executeListTagsForResource(request); } @SdkInternalApi final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) { ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.ListVirtualMachines * @see AWS API Documentation */ @Override public ListVirtualMachinesResult listVirtualMachines(ListVirtualMachinesRequest request) { request = beforeClientExecution(request); return executeListVirtualMachines(request); } @SdkInternalApi final ListVirtualMachinesResult executeListVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest) { ExecutionContext executionContext = createExecutionContext(listVirtualMachinesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param putBandwidthRateLimitScheduleRequest * @return Result of the PutBandwidthRateLimitSchedule 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.PutBandwidthRateLimitSchedule * @see AWS API Documentation */ @Override public PutBandwidthRateLimitScheduleResult putBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest request) { request = beforeClientExecution(request); return executePutBandwidthRateLimitSchedule(request); } @SdkInternalApi final PutBandwidthRateLimitScheduleResult executePutBandwidthRateLimitSchedule(PutBandwidthRateLimitScheduleRequest putBandwidthRateLimitScheduleRequest) { ExecutionContext executionContext = createExecutionContext(putBandwidthRateLimitScheduleRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @param putHypervisorPropertyMappingsRequest * @return Result of the PutHypervisorPropertyMappings 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 AccessDeniedException * The operation cannot proceed because you have insufficient permissions. * @throws ResourceNotFoundException * A resource that is required for the action wasn't found. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.PutHypervisorPropertyMappings * @see AWS API Documentation */ @Override public PutHypervisorPropertyMappingsResult putHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest request) { request = beforeClientExecution(request); return executePutHypervisorPropertyMappings(request); } @SdkInternalApi final PutHypervisorPropertyMappingsResult executePutHypervisorPropertyMappings(PutHypervisorPropertyMappingsRequest putHypervisorPropertyMappingsRequest) { ExecutionContext executionContext = createExecutionContext(putHypervisorPropertyMappingsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.PutMaintenanceStartTime * @see AWS API Documentation */ @Override public PutMaintenanceStartTimeResult putMaintenanceStartTime(PutMaintenanceStartTimeRequest request) { request = beforeClientExecution(request); return executePutMaintenanceStartTime(request); } @SdkInternalApi final PutMaintenanceStartTimeResult executePutMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest) { ExecutionContext executionContext = createExecutionContext(putMaintenanceStartTimeRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* This action sends a request to sync metadata across the specified virtual machines. *
* * @param startVirtualMachinesMetadataSyncRequest * @return Result of the StartVirtualMachinesMetadataSync 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.StartVirtualMachinesMetadataSync * @see AWS API Documentation */ @Override public StartVirtualMachinesMetadataSyncResult startVirtualMachinesMetadataSync(StartVirtualMachinesMetadataSyncRequest request) { request = beforeClientExecution(request); return executeStartVirtualMachinesMetadataSync(request); } @SdkInternalApi final StartVirtualMachinesMetadataSyncResult executeStartVirtualMachinesMetadataSync( StartVirtualMachinesMetadataSyncRequest startVirtualMachinesMetadataSyncRequest) { ExecutionContext executionContext = createExecutionContext(startVirtualMachinesMetadataSyncRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.TagResource * @see AWS API * Documentation */ @Override public TagResourceResult tagResource(TagResourceRequest request) { request = beforeClientExecution(request); return executeTagResource(request); } @SdkInternalApi final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) { ExecutionContext executionContext = createExecutionContext(tagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.TestHypervisorConfiguration * @see AWS API Documentation */ @Override public TestHypervisorConfigurationResult testHypervisorConfiguration(TestHypervisorConfigurationRequest request) { request = beforeClientExecution(request); return executeTestHypervisorConfiguration(request); } @SdkInternalApi final TestHypervisorConfigurationResult executeTestHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest) { ExecutionContext executionContext = createExecutionContext(testHypervisorConfigurationRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.UntagResource * @see AWS * API Documentation */ @Override public UntagResourceResult untagResource(UntagResourceRequest request) { request = beforeClientExecution(request); return executeUntagResource(request); } @SdkInternalApi final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) { ExecutionContext executionContext = createExecutionContext(untagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.UpdateGatewayInformation * @see AWS API Documentation */ @Override public UpdateGatewayInformationResult updateGatewayInformation(UpdateGatewayInformationRequest request) { request = beforeClientExecution(request); return executeUpdateGatewayInformation(request); } @SdkInternalApi final UpdateGatewayInformationResult executeUpdateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest) { ExecutionContext executionContext = createExecutionContext(updateGatewayInformationRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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.
*
* 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 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 AccessDeniedException * The operation cannot proceed because you have insufficient permissions. * @throws ResourceNotFoundException * A resource that is required for the action wasn't found. * @throws ThrottlingException * TPS has been limited to protect against intentional or unintentional high request volumes. * @sample AWSBackupGateway.UpdateHypervisor * @see AWS API Documentation */ @Override public UpdateHypervisorResult updateHypervisor(UpdateHypervisorRequest request) { request = beforeClientExecution(request); return executeUpdateHypervisor(request); } @SdkInternalApi final UpdateHypervisorResult executeUpdateHypervisor(UpdateHypervisorRequest updateHypervisorRequest) { ExecutionContext executionContext = createExecutionContext(updateHypervisorRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private