AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

The operation cannot proceed because you have insufficient permissions.

Class AssociateGatewayToServerRequest

Container for the parameters to the AssociateGatewayToServer operation. Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Class AssociateGatewayToServerResponse

This is the response object from the AssociateGatewayToServer operation.

Class BackupGatewayPaginatorFactory

Paginators for the BackupGateway service

Class BandwidthRateLimitInterval

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

Class ConflictException

The operation cannot proceed because it is not supported.

Class CreateGatewayRequest

Container for the parameters to the CreateGateway operation. Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Class CreateGatewayResponse

This is the response object from the CreateGateway operation.

Class DeleteGatewayRequest

Container for the parameters to the DeleteGateway operation. Deletes a backup gateway.

Class DeleteGatewayResponse

This is the response object from the DeleteGateway operation.

Class DeleteHypervisorRequest

Container for the parameters to the DeleteHypervisor operation. Deletes a hypervisor.

Class DeleteHypervisorResponse

This is the response object from the DeleteHypervisor operation.

Class DisassociateGatewayFromServerRequest

Container for the parameters to the DisassociateGatewayFromServer operation. 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.

Class DisassociateGatewayFromServerResponse

This is the response object from the DisassociateGatewayFromServer operation.

Class Gateway

A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.

Class GatewayDetails

The details of gateway.

Class GetBandwidthRateLimitScheduleRequest

Container for the parameters to the GetBandwidthRateLimitSchedule operation. 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.

Class GetBandwidthRateLimitScheduleResponse

This is the response object from the GetBandwidthRateLimitSchedule operation.

Class GetGatewayRequest

Container for the parameters to the GetGateway operation. By providing the ARN (Amazon Resource Name), this API returns the gateway.

Class GetGatewayResponse

This is the response object from the GetGateway operation.

Class GetHypervisorPropertyMappingsRequest

Container for the parameters to the GetHypervisorPropertyMappings operation. 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.

Class GetHypervisorPropertyMappingsResponse

This is the response object from the GetHypervisorPropertyMappings operation.

Class GetHypervisorRequest

Container for the parameters to the GetHypervisor operation. 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.

Class GetHypervisorResponse

This is the response object from the GetHypervisor operation.

Class GetVirtualMachineRequest

Container for the parameters to the GetVirtualMachine operation. By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

Class GetVirtualMachineResponse

This is the response object from the GetVirtualMachine operation.

Class Hypervisor

Represents the hypervisor's permissions to which the gateway will connect.

A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Class HypervisorDetails

These are the details of the specified hypervisor. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Class ImportHypervisorConfigurationRequest

Container for the parameters to the ImportHypervisorConfiguration operation. Connect to a hypervisor by importing its configuration.

Class ImportHypervisorConfigurationResponse

This is the response object from the ImportHypervisorConfiguration operation.

Class InternalServerException

The operation did not succeed because an internal error occurred. Try again later.

Class ListGatewaysRequest

Container for the parameters to the ListGateways operation. 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).

Class ListGatewaysResponse

This is the response object from the ListGateways operation.

Class ListHypervisorsRequest

Container for the parameters to the ListHypervisors operation. Lists your hypervisors.

Class ListHypervisorsResponse

This is the response object from the ListHypervisors operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListVirtualMachinesRequest

Container for the parameters to the ListVirtualMachines operation. Lists your virtual machines.

Class ListVirtualMachinesResponse

This is the response object from the ListVirtualMachines operation.

Class MaintenanceStartTime

This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

Class PutBandwidthRateLimitScheduleRequest

Container for the parameters to the PutBandwidthRateLimitSchedule operation. 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.

Class PutBandwidthRateLimitScheduleResponse

This is the response object from the PutBandwidthRateLimitSchedule operation.

Class PutHypervisorPropertyMappingsRequest

Container for the parameters to the PutHypervisorPropertyMappings operation. 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.

Class PutHypervisorPropertyMappingsResponse

This is the response object from the PutHypervisorPropertyMappings operation.

Class PutMaintenanceStartTimeRequest

Container for the parameters to the PutMaintenanceStartTime operation. Set the maintenance start time for a gateway.

Class PutMaintenanceStartTimeResponse

This is the response object from the PutMaintenanceStartTime operation.

Class ResourceNotFoundException

A resource that is required for the action wasn't found.

Class StartVirtualMachinesMetadataSyncRequest

Container for the parameters to the StartVirtualMachinesMetadataSync operation. This action sends a request to sync metadata across the specified virtual machines.

Class StartVirtualMachinesMetadataSyncResponse

This is the response object from the StartVirtualMachinesMetadataSync operation.

Class Tag

A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Tag the resource.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TestHypervisorConfigurationRequest

Container for the parameters to the TestHypervisorConfiguration operation. Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Class TestHypervisorConfigurationResponse

This is the response object from the TestHypervisorConfiguration operation.

Class ThrottlingException

TPS has been limited to protect against intentional or unintentional high request volumes.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes tags from the resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateGatewayInformationRequest

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

Class UpdateGatewayInformationResponse

This is the response object from the UpdateGatewayInformation operation.

Class UpdateGatewaySoftwareNowRequest

Container for the parameters to the UpdateGatewaySoftwareNow operation. 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.

Class UpdateGatewaySoftwareNowResponse

This is the response object from the UpdateGatewaySoftwareNow operation.

Class UpdateHypervisorRequest

Container for the parameters to the UpdateHypervisor operation. 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.

Class UpdateHypervisorResponse

This is the response object from the UpdateHypervisor operation.

Class ValidationException

The operation did not succeed because a validation error occurred.

Class VirtualMachine

A virtual machine that is on a hypervisor.

Class VirtualMachineDetails

Your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

Class VmwareTag

A VMware tag is a tag attached to a specific virtual machine. A tag is a key-value pair you can use to manage, filter, and search for your resources.

The content of VMware tags can be matched to Amazon Web Services tags.

Class VmwareToAwsTagMapping

This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.

Interfaces

NameDescription
Interface IBackupGatewayPaginatorFactory

Paginators for the BackupGateway service

Interface IListGatewaysPaginator

Paginator for the ListGateways operation

Interface IListHypervisorsPaginator

Paginator for the ListHypervisors operation

Interface IListVirtualMachinesPaginator

Paginator for the ListVirtualMachines operation