/* * Copyright 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. */ /* * Do not modify this file. This file is generated from the backup-gateway-2021-01-01.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.BackupGateway.Model; namespace Amazon.BackupGateway { /// /// Interface for accessing BackupGateway /// /// Backup gateway /// /// Backup gateway connects Backup to your hypervisor, so you can create, store, and restore /// backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware /// Cloud (VMC) on Amazon Web Services. /// /// /// /// Add on-premises resources by connecting to a hypervisor through a gateway. Backup /// will automatically discover the resources in your hypervisor. /// /// /// /// Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand /// backups. Once you have backed up your resources, you can view them and restore them /// like any resource supported by Backup. /// /// /// /// To download the Amazon Web Services software to get started, navigate to the Backup /// console, choose Gateways, then choose Create gateway. /// /// /// /// public partial interface IAmazonBackupGateway : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IBackupGatewayPaginatorFactory Paginators { get; } #endif #region AssociateGatewayToServer /// /// Associates a backup gateway with your server. After you complete the association process, /// you can back up and restore your VMs through the gateway. /// /// Container for the necessary parameters to execute the AssociateGatewayToServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AssociateGatewayToServer service method, as returned by BackupGateway. /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for AssociateGatewayToServer Operation Task AssociateGatewayToServerAsync(AssociateGatewayToServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateGateway /// /// Creates a backup gateway. After you create a gateway, you can associate it with a /// server using the AssociateGatewayToServer operation. /// /// Container for the necessary parameters to execute the CreateGateway service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateGateway service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for CreateGateway Operation Task CreateGatewayAsync(CreateGatewayRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteGateway /// /// Deletes a backup gateway. /// /// Container for the necessary parameters to execute the DeleteGateway service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteGateway service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for DeleteGateway Operation Task DeleteGatewayAsync(DeleteGatewayRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteHypervisor /// /// Deletes a hypervisor. /// /// Container for the necessary parameters to execute the DeleteHypervisor service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteHypervisor service method, as returned by BackupGateway. /// /// The operation cannot proceed because you have insufficient permissions. /// /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for DeleteHypervisor Operation Task DeleteHypervisorAsync(DeleteHypervisorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DisassociateGatewayFromServer /// /// 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. /// /// Container for the necessary parameters to execute the DisassociateGatewayFromServer service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DisassociateGatewayFromServer service method, as returned by BackupGateway. /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for DisassociateGatewayFromServer Operation Task DisassociateGatewayFromServerAsync(DisassociateGatewayFromServerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetBandwidthRateLimitSchedule /// /// 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. /// /// Container for the necessary parameters to execute the GetBandwidthRateLimitSchedule service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetBandwidthRateLimitSchedule service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for GetBandwidthRateLimitSchedule Operation Task GetBandwidthRateLimitScheduleAsync(GetBandwidthRateLimitScheduleRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetGateway /// /// By providing the ARN (Amazon Resource Name), this API returns the gateway. /// /// Container for the necessary parameters to execute the GetGateway service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetGateway service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for GetGateway Operation Task GetGatewayAsync(GetGatewayRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetHypervisor /// /// 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. /// /// Container for the necessary parameters to execute the GetHypervisor service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetHypervisor service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for GetHypervisor Operation Task GetHypervisorAsync(GetHypervisorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetHypervisorPropertyMappings /// /// 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. /// /// Container for the necessary parameters to execute the GetHypervisorPropertyMappings service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetHypervisorPropertyMappings service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for GetHypervisorPropertyMappings Operation Task GetHypervisorPropertyMappingsAsync(GetHypervisorPropertyMappingsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetVirtualMachine /// /// By providing the ARN (Amazon Resource Name), this API returns the virtual machine. /// /// Container for the necessary parameters to execute the GetVirtualMachine service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetVirtualMachine service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for GetVirtualMachine Operation Task GetVirtualMachineAsync(GetVirtualMachineRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ImportHypervisorConfiguration /// /// Connect to a hypervisor by importing its configuration. /// /// Container for the necessary parameters to execute the ImportHypervisorConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ImportHypervisorConfiguration service method, as returned by BackupGateway. /// /// The operation cannot proceed because you have insufficient permissions. /// /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for ImportHypervisorConfiguration Operation Task ImportHypervisorConfigurationAsync(ImportHypervisorConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListGateways /// /// 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). /// /// Container for the necessary parameters to execute the ListGateways service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListGateways service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for ListGateways Operation Task ListGatewaysAsync(ListGatewaysRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListHypervisors /// /// Lists your hypervisors. /// /// Container for the necessary parameters to execute the ListHypervisors service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListHypervisors service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for ListHypervisors Operation Task ListHypervisorsAsync(ListHypervisorsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForResource /// /// Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForResource service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for ListTagsForResource Operation Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListVirtualMachines /// /// Lists your virtual machines. /// /// Container for the necessary parameters to execute the ListVirtualMachines service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListVirtualMachines service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for ListVirtualMachines Operation Task ListVirtualMachinesAsync(ListVirtualMachinesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutBandwidthRateLimitSchedule /// /// 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. /// /// Container for the necessary parameters to execute the PutBandwidthRateLimitSchedule service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutBandwidthRateLimitSchedule service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for PutBandwidthRateLimitSchedule Operation Task PutBandwidthRateLimitScheduleAsync(PutBandwidthRateLimitScheduleRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutHypervisorPropertyMappings /// /// 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. /// /// Container for the necessary parameters to execute the PutHypervisorPropertyMappings service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutHypervisorPropertyMappings service method, as returned by BackupGateway. /// /// The operation cannot proceed because you have insufficient permissions. /// /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for PutHypervisorPropertyMappings Operation Task PutHypervisorPropertyMappingsAsync(PutHypervisorPropertyMappingsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutMaintenanceStartTime /// /// Set the maintenance start time for a gateway. /// /// Container for the necessary parameters to execute the PutMaintenanceStartTime service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutMaintenanceStartTime service method, as returned by BackupGateway. /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for PutMaintenanceStartTime Operation Task PutMaintenanceStartTimeAsync(PutMaintenanceStartTimeRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region StartVirtualMachinesMetadataSync /// /// This action sends a request to sync metadata across the specified virtual machines. /// /// Container for the necessary parameters to execute the StartVirtualMachinesMetadataSync service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the StartVirtualMachinesMetadataSync service method, as returned by BackupGateway. /// /// The operation cannot proceed because you have insufficient permissions. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for StartVirtualMachinesMetadataSync Operation Task StartVirtualMachinesMetadataSyncAsync(StartVirtualMachinesMetadataSyncRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TagResource /// /// Tag the resource. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TagResource service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for TagResource Operation Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region TestHypervisorConfiguration /// /// Tests your hypervisor configuration to validate that backup gateway can connect with /// the hypervisor and its resources. /// /// Container for the necessary parameters to execute the TestHypervisorConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the TestHypervisorConfiguration service method, as returned by BackupGateway. /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for TestHypervisorConfiguration Operation Task TestHypervisorConfigurationAsync(TestHypervisorConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UntagResource /// /// Removes tags from the resource. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UntagResource service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for UntagResource Operation Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateGatewayInformation /// /// Updates a gateway's name. Specify which gateway to update using the Amazon Resource /// Name (ARN) of the gateway in your request. /// /// Container for the necessary parameters to execute the UpdateGatewayInformation service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateGatewayInformation service method, as returned by BackupGateway. /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for UpdateGatewayInformation Operation Task UpdateGatewayInformationAsync(UpdateGatewayInformationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateGatewaySoftwareNow /// /// 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. /// /// /// /// Container for the necessary parameters to execute the UpdateGatewaySoftwareNow service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateGatewaySoftwareNow service method, as returned by BackupGateway. /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for UpdateGatewaySoftwareNow Operation Task UpdateGatewaySoftwareNowAsync(UpdateGatewaySoftwareNowRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateHypervisor /// /// 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. /// /// Container for the necessary parameters to execute the UpdateHypervisor service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateHypervisor service method, as returned by BackupGateway. /// /// The operation cannot proceed because you have insufficient permissions. /// /// /// The operation cannot proceed because it is not supported. /// /// /// The operation did not succeed because an internal error occurred. Try again later. /// /// /// A resource that is required for the action wasn't found. /// /// /// TPS has been limited to protect against intentional or unintentional high request /// volumes. /// /// /// The operation did not succeed because a validation error occurred. /// /// REST API Reference for UpdateHypervisor Operation Task UpdateHypervisorAsync(UpdateHypervisorRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }