@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface BackupGatewayClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AssociateGatewayToServerResponse |
associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest)
Associates a backup gateway with your server.
|
default AssociateGatewayToServerResponse |
associateGatewayToServer(Consumer<AssociateGatewayToServerRequest.Builder> associateGatewayToServerRequest)
Associates a backup gateway with your server.
|
static BackupGatewayClientBuilder |
builder()
Create a builder that can be used to configure and create a
BackupGatewayClient. |
static BackupGatewayClient |
create()
Create a
BackupGatewayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateGatewayResponse |
createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest)
Creates a backup gateway.
|
default CreateGatewayResponse |
createGateway(CreateGatewayRequest createGatewayRequest)
Creates a backup gateway.
|
default DeleteGatewayResponse |
deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest)
Deletes a backup gateway.
|
default DeleteGatewayResponse |
deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
Deletes a backup gateway.
|
default DeleteHypervisorResponse |
deleteHypervisor(Consumer<DeleteHypervisorRequest.Builder> deleteHypervisorRequest)
Deletes a hypervisor.
|
default DeleteHypervisorResponse |
deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest)
Deletes a hypervisor.
|
default DisassociateGatewayFromServerResponse |
disassociateGatewayFromServer(Consumer<DisassociateGatewayFromServerRequest.Builder> disassociateGatewayFromServerRequest)
Disassociates a backup gateway from the specified server.
|
default DisassociateGatewayFromServerResponse |
disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest)
Disassociates a backup gateway from the specified server.
|
default ImportHypervisorConfigurationResponse |
importHypervisorConfiguration(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest)
Connect to a hypervisor by importing its configuration.
|
default ImportHypervisorConfigurationResponse |
importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest)
Connect to a hypervisor by importing its configuration.
|
default ListGatewaysResponse |
listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default ListGatewaysResponse |
listGateways(ListGatewaysRequest listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default ListGatewaysIterable |
listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default ListGatewaysIterable |
listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest)
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
|
default ListHypervisorsResponse |
listHypervisors(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)
Lists your hypervisors.
|
default ListHypervisorsResponse |
listHypervisors(ListHypervisorsRequest listHypervisorsRequest)
Lists your hypervisors.
|
default ListHypervisorsIterable |
listHypervisorsPaginator(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest)
Lists your hypervisors.
|
default ListHypervisorsIterable |
listHypervisorsPaginator(ListHypervisorsRequest listHypervisorsRequest)
Lists your hypervisors.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
|
default ListVirtualMachinesResponse |
listVirtualMachines(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)
Lists your virtual machines.
|
default ListVirtualMachinesResponse |
listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest)
Lists your virtual machines.
|
default ListVirtualMachinesIterable |
listVirtualMachinesPaginator(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest)
Lists your virtual machines.
|
default ListVirtualMachinesIterable |
listVirtualMachinesPaginator(ListVirtualMachinesRequest listVirtualMachinesRequest)
Lists your virtual machines.
|
default PutMaintenanceStartTimeResponse |
putMaintenanceStartTime(Consumer<PutMaintenanceStartTimeRequest.Builder> putMaintenanceStartTimeRequest)
Set the maintenance start time for a gateway.
|
default PutMaintenanceStartTimeResponse |
putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest)
Set the maintenance start time for a gateway.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tag the resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Tag the resource.
|
default TestHypervisorConfigurationResponse |
testHypervisorConfiguration(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its
resources.
|
default TestHypervisorConfigurationResponse |
testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest)
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its
resources.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the resource.
|
default UpdateGatewayInformationResponse |
updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest)
Updates a gateway's name.
|
default UpdateGatewayInformationResponse |
updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest)
Updates a gateway's name.
|
default UpdateHypervisorResponse |
updateHypervisor(Consumer<UpdateHypervisorRequest.Builder> updateHypervisorRequest)
Updates a hypervisor metadata, including its host, username, and password.
|
default UpdateHypervisorResponse |
updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest)
Updates a hypervisor metadata, including its host, username, and password.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static BackupGatewayClient create()
BackupGatewayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BackupGatewayClientBuilder builder()
BackupGatewayClient.default AssociateGatewayToServerResponse associateGatewayToServer(AssociateGatewayToServerRequest associateGatewayToServerRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
associateGatewayToServerRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AssociateGatewayToServerResponse associateGatewayToServer(Consumer<AssociateGatewayToServerRequest.Builder> associateGatewayToServerRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
This is a convenience which creates an instance of the AssociateGatewayToServerRequest.Builder avoiding
the need to create one manually via AssociateGatewayToServerRequest.builder()
associateGatewayToServerRequest - A Consumer that will call methods on AssociateGatewayToServerInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGatewayResponse createGateway(CreateGatewayRequest createGatewayRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Creates a backup gateway. After you create a gateway, you can associate it with a server using the
AssociateGatewayToServer operation.
createGatewayRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGatewayResponse createGateway(Consumer<CreateGatewayRequest.Builder> createGatewayRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Creates a backup gateway. After you create a gateway, you can associate it with a server using the
AssociateGatewayToServer operation.
This is a convenience which creates an instance of the CreateGatewayRequest.Builder avoiding the need to
create one manually via CreateGatewayRequest.builder()
createGatewayRequest - A Consumer that will call methods on CreateGatewayInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponse deleteGateway(DeleteGatewayRequest deleteGatewayRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Deletes a backup gateway.
deleteGatewayRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponse deleteGateway(Consumer<DeleteGatewayRequest.Builder> deleteGatewayRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Deletes a backup gateway.
This is a convenience which creates an instance of the DeleteGatewayRequest.Builder avoiding the need to
create one manually via DeleteGatewayRequest.builder()
deleteGatewayRequest - A Consumer that will call methods on DeleteGatewayInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteHypervisorResponse deleteHypervisor(DeleteHypervisorRequest deleteHypervisorRequest) throws ValidationException, InternalServerException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Deletes a hypervisor.
deleteHypervisorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteHypervisorResponse deleteHypervisor(Consumer<DeleteHypervisorRequest.Builder> deleteHypervisorRequest) throws ValidationException, InternalServerException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Deletes a hypervisor.
This is a convenience which creates an instance of the DeleteHypervisorRequest.Builder avoiding the need
to create one manually via DeleteHypervisorRequest.builder()
deleteHypervisorRequest - A Consumer that will call methods on DeleteHypervisorInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateGatewayFromServerResponse disassociateGatewayFromServer(DisassociateGatewayFromServerRequest disassociateGatewayFromServerRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
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.
disassociateGatewayFromServerRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisassociateGatewayFromServerResponse disassociateGatewayFromServer(Consumer<DisassociateGatewayFromServerRequest.Builder> disassociateGatewayFromServerRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
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.
This is a convenience which creates an instance of the DisassociateGatewayFromServerRequest.Builder
avoiding the need to create one manually via DisassociateGatewayFromServerRequest.builder()
disassociateGatewayFromServerRequest - A Consumer that will call methods on DisassociateGatewayFromServerInput.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportHypervisorConfigurationResponse importHypervisorConfiguration(ImportHypervisorConfigurationRequest importHypervisorConfigurationRequest) throws ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, BackupGatewayException
Connect to a hypervisor by importing its configuration.
importHypervisorConfigurationRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportHypervisorConfigurationResponse importHypervisorConfiguration(Consumer<ImportHypervisorConfigurationRequest.Builder> importHypervisorConfigurationRequest) throws ValidationException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, BackupGatewayException
Connect to a hypervisor by importing its configuration.
This is a convenience which creates an instance of the ImportHypervisorConfigurationRequest.Builder
avoiding the need to create one manually via ImportHypervisorConfigurationRequest.builder()
importHypervisorConfigurationRequest - A Consumer that will call methods on ImportHypervisorConfigurationInput.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysResponse listGateways(ListGatewaysRequest listGatewaysRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
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).
listGatewaysRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysResponse listGateways(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
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).
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysIterable listGatewaysPaginator(ListGatewaysRequest listGatewaysRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
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).
This is a variant of
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client
.listGatewaysPaginator(request);
for (software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation.
listGatewaysRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListGatewaysIterable listGatewaysPaginator(Consumer<ListGatewaysRequest.Builder> listGatewaysRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
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).
This is a variant of
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client
.listGatewaysPaginator(request);
for (software.amazon.awssdk.services.backupgateway.model.ListGatewaysResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupgateway.paginators.ListGatewaysIterable responses = client.listGatewaysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGateways(software.amazon.awssdk.services.backupgateway.model.ListGatewaysRequest) operation.
This is a convenience which creates an instance of the ListGatewaysRequest.Builder avoiding the need to
create one manually via ListGatewaysRequest.builder()
listGatewaysRequest - A Consumer that will call methods on ListGatewaysInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListHypervisorsResponse listHypervisors(ListHypervisorsRequest listHypervisorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your hypervisors.
listHypervisorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListHypervisorsResponse listHypervisors(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your hypervisors.
This is a convenience which creates an instance of the ListHypervisorsRequest.Builder avoiding the need
to create one manually via ListHypervisorsRequest.builder()
listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListHypervisorsIterable listHypervisorsPaginator(ListHypervisorsRequest listHypervisorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your hypervisors.
This is a variant of
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client
.listHypervisorsPaginator(request);
for (software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation.
listHypervisorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListHypervisorsIterable listHypervisorsPaginator(Consumer<ListHypervisorsRequest.Builder> listHypervisorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your hypervisors.
This is a variant of
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client
.listHypervisorsPaginator(request);
for (software.amazon.awssdk.services.backupgateway.model.ListHypervisorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupgateway.paginators.ListHypervisorsIterable responses = client.listHypervisorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHypervisors(software.amazon.awssdk.services.backupgateway.model.ListHypervisorsRequest)
operation.
This is a convenience which creates an instance of the ListHypervisorsRequest.Builder avoiding the need
to create one manually via ListHypervisorsRequest.builder()
listHypervisorsRequest - A Consumer that will call methods on ListHypervisorsInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVirtualMachinesResponse listVirtualMachines(ListVirtualMachinesRequest listVirtualMachinesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your virtual machines.
listVirtualMachinesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVirtualMachinesResponse listVirtualMachines(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your virtual machines.
This is a convenience which creates an instance of the ListVirtualMachinesRequest.Builder avoiding the
need to create one manually via ListVirtualMachinesRequest.builder()
listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVirtualMachinesIterable listVirtualMachinesPaginator(ListVirtualMachinesRequest listVirtualMachinesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your virtual machines.
This is a variant of
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client
.listVirtualMachinesPaginator(request);
for (software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation.
listVirtualMachinesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVirtualMachinesIterable listVirtualMachinesPaginator(Consumer<ListVirtualMachinesRequest.Builder> listVirtualMachinesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, BackupGatewayException
Lists your virtual machines.
This is a variant of
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client
.listVirtualMachinesPaginator(request);
for (software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupgateway.paginators.ListVirtualMachinesIterable responses = client.listVirtualMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVirtualMachines(software.amazon.awssdk.services.backupgateway.model.ListVirtualMachinesRequest)
operation.
This is a convenience which creates an instance of the ListVirtualMachinesRequest.Builder avoiding the
need to create one manually via ListVirtualMachinesRequest.builder()
listVirtualMachinesRequest - A Consumer that will call methods on ListVirtualMachinesInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMaintenanceStartTimeResponse putMaintenanceStartTime(PutMaintenanceStartTimeRequest putMaintenanceStartTimeRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Set the maintenance start time for a gateway.
putMaintenanceStartTimeRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMaintenanceStartTimeResponse putMaintenanceStartTime(Consumer<PutMaintenanceStartTimeRequest.Builder> putMaintenanceStartTimeRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Set the maintenance start time for a gateway.
This is a convenience which creates an instance of the PutMaintenanceStartTimeRequest.Builder avoiding
the need to create one manually via PutMaintenanceStartTimeRequest.builder()
putMaintenanceStartTimeRequest - A Consumer that will call methods on PutMaintenanceStartTimeInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Tag the resource.
tagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Tag the resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestHypervisorConfigurationResponse testHypervisorConfiguration(TestHypervisorConfigurationRequest testHypervisorConfigurationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
testHypervisorConfigurationRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestHypervisorConfigurationResponse testHypervisorConfiguration(Consumer<TestHypervisorConfigurationRequest.Builder> testHypervisorConfigurationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
This is a convenience which creates an instance of the TestHypervisorConfigurationRequest.Builder
avoiding the need to create one manually via TestHypervisorConfigurationRequest.builder()
testHypervisorConfigurationRequest - A Consumer that will call methods on TestHypervisorConfigurationInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Removes tags from the resource.
untagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Removes tags from the resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewayInformationResponse updateGatewayInformation(UpdateGatewayInformationRequest updateGatewayInformationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
updateGatewayInformationRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewayInformationResponse updateGatewayInformation(Consumer<UpdateGatewayInformationRequest.Builder> updateGatewayInformationRequest) throws ValidationException, ConflictException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
This is a convenience which creates an instance of the UpdateGatewayInformationRequest.Builder avoiding
the need to create one manually via UpdateGatewayInformationRequest.builder()
updateGatewayInformationRequest - A Consumer that will call methods on UpdateGatewayInformationInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateHypervisorResponse updateHypervisor(UpdateHypervisorRequest updateHypervisorRequest) throws ValidationException, InternalServerException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
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.
updateHypervisorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateHypervisorResponse updateHypervisor(Consumer<UpdateHypervisorRequest.Builder> updateHypervisorRequest) throws ValidationException, InternalServerException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupGatewayException
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.
This is a convenience which creates an instance of the UpdateHypervisorRequest.Builder avoiding the need
to create one manually via UpdateHypervisorRequest.builder()
updateHypervisorRequest - A Consumer that will call methods on UpdateHypervisorInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupGatewayException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.