import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class BackupGateway extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: BackupGateway.Types.ClientConfiguration) config: Config & BackupGateway.Types.ClientConfiguration; /** * Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway. */ associateGatewayToServer(params: BackupGateway.Types.AssociateGatewayToServerInput, callback?: (err: AWSError, data: BackupGateway.Types.AssociateGatewayToServerOutput) => void): Request; /** * Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway. */ associateGatewayToServer(callback?: (err: AWSError, data: BackupGateway.Types.AssociateGatewayToServerOutput) => void): Request; /** * Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation. */ createGateway(params: BackupGateway.Types.CreateGatewayInput, callback?: (err: AWSError, data: BackupGateway.Types.CreateGatewayOutput) => void): Request; /** * Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation. */ createGateway(callback?: (err: AWSError, data: BackupGateway.Types.CreateGatewayOutput) => void): Request; /** * Deletes a backup gateway. */ deleteGateway(params: BackupGateway.Types.DeleteGatewayInput, callback?: (err: AWSError, data: BackupGateway.Types.DeleteGatewayOutput) => void): Request; /** * Deletes a backup gateway. */ deleteGateway(callback?: (err: AWSError, data: BackupGateway.Types.DeleteGatewayOutput) => void): Request; /** * Deletes a hypervisor. */ deleteHypervisor(params: BackupGateway.Types.DeleteHypervisorInput, callback?: (err: AWSError, data: BackupGateway.Types.DeleteHypervisorOutput) => void): Request; /** * Deletes a hypervisor. */ deleteHypervisor(callback?: (err: AWSError, data: BackupGateway.Types.DeleteHypervisorOutput) => void): Request; /** * Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server. */ disassociateGatewayFromServer(params: BackupGateway.Types.DisassociateGatewayFromServerInput, callback?: (err: AWSError, data: BackupGateway.Types.DisassociateGatewayFromServerOutput) => void): Request; /** * Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server. */ disassociateGatewayFromServer(callback?: (err: AWSError, data: BackupGateway.Types.DisassociateGatewayFromServerOutput) => void): Request; /** * By providing the ARN (Amazon Resource Name), this API returns the gateway. */ getGateway(params: BackupGateway.Types.GetGatewayInput, callback?: (err: AWSError, data: BackupGateway.Types.GetGatewayOutput) => void): Request; /** * By providing the ARN (Amazon Resource Name), this API returns the gateway. */ getGateway(callback?: (err: AWSError, data: BackupGateway.Types.GetGatewayOutput) => void): Request; /** * Connect to a hypervisor by importing its configuration. */ importHypervisorConfiguration(params: BackupGateway.Types.ImportHypervisorConfigurationInput, callback?: (err: AWSError, data: BackupGateway.Types.ImportHypervisorConfigurationOutput) => void): Request; /** * Connect to a hypervisor by importing its configuration. */ importHypervisorConfiguration(callback?: (err: AWSError, data: BackupGateway.Types.ImportHypervisorConfigurationOutput) => void): Request; /** * Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN). */ listGateways(params: BackupGateway.Types.ListGatewaysInput, callback?: (err: AWSError, data: BackupGateway.Types.ListGatewaysOutput) => void): Request; /** * Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN). */ listGateways(callback?: (err: AWSError, data: BackupGateway.Types.ListGatewaysOutput) => void): Request; /** * Lists your hypervisors. */ listHypervisors(params: BackupGateway.Types.ListHypervisorsInput, callback?: (err: AWSError, data: BackupGateway.Types.ListHypervisorsOutput) => void): Request; /** * Lists your hypervisors. */ listHypervisors(callback?: (err: AWSError, data: BackupGateway.Types.ListHypervisorsOutput) => void): Request; /** * Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). */ listTagsForResource(params: BackupGateway.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: BackupGateway.Types.ListTagsForResourceOutput) => void): Request; /** * Lists the tags applied to the resource identified by its Amazon Resource Name (ARN). */ listTagsForResource(callback?: (err: AWSError, data: BackupGateway.Types.ListTagsForResourceOutput) => void): Request; /** * Lists your virtual machines. */ listVirtualMachines(params: BackupGateway.Types.ListVirtualMachinesInput, callback?: (err: AWSError, data: BackupGateway.Types.ListVirtualMachinesOutput) => void): Request; /** * Lists your virtual machines. */ listVirtualMachines(callback?: (err: AWSError, data: BackupGateway.Types.ListVirtualMachinesOutput) => void): Request; /** * Set the maintenance start time for a gateway. */ putMaintenanceStartTime(params: BackupGateway.Types.PutMaintenanceStartTimeInput, callback?: (err: AWSError, data: BackupGateway.Types.PutMaintenanceStartTimeOutput) => void): Request; /** * Set the maintenance start time for a gateway. */ putMaintenanceStartTime(callback?: (err: AWSError, data: BackupGateway.Types.PutMaintenanceStartTimeOutput) => void): Request; /** * Tag the resource. */ tagResource(params: BackupGateway.Types.TagResourceInput, callback?: (err: AWSError, data: BackupGateway.Types.TagResourceOutput) => void): Request; /** * Tag the resource. */ tagResource(callback?: (err: AWSError, data: BackupGateway.Types.TagResourceOutput) => void): Request; /** * Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources. */ testHypervisorConfiguration(params: BackupGateway.Types.TestHypervisorConfigurationInput, callback?: (err: AWSError, data: BackupGateway.Types.TestHypervisorConfigurationOutput) => void): Request; /** * Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources. */ testHypervisorConfiguration(callback?: (err: AWSError, data: BackupGateway.Types.TestHypervisorConfigurationOutput) => void): Request; /** * Removes tags from the resource. */ untagResource(params: BackupGateway.Types.UntagResourceInput, callback?: (err: AWSError, data: BackupGateway.Types.UntagResourceOutput) => void): Request; /** * Removes tags from the resource. */ untagResource(callback?: (err: AWSError, data: BackupGateway.Types.UntagResourceOutput) => void): Request; /** * Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request. */ updateGatewayInformation(params: BackupGateway.Types.UpdateGatewayInformationInput, callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewayInformationOutput) => void): Request; /** * Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request. */ updateGatewayInformation(callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewayInformationOutput) => void): Request; /** * Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. */ updateGatewaySoftwareNow(params: BackupGateway.Types.UpdateGatewaySoftwareNowInput, callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request; /** * Updates the gateway virtual machine (VM) software. The request immediately triggers the software update. When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. */ updateGatewaySoftwareNow(callback?: (err: AWSError, data: BackupGateway.Types.UpdateGatewaySoftwareNowOutput) => void): Request; /** * 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. */ updateHypervisor(params: BackupGateway.Types.UpdateHypervisorInput, callback?: (err: AWSError, data: BackupGateway.Types.UpdateHypervisorOutput) => void): Request; /** * 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. */ updateHypervisor(callback?: (err: AWSError, data: BackupGateway.Types.UpdateHypervisorOutput) => void): Request; } declare namespace BackupGateway { export type ActivationKey = string; export interface AssociateGatewayToServerInput { /** * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. */ GatewayArn: GatewayArn; /** * The Amazon Resource Name (ARN) of the server that hosts your virtual machines. */ ServerArn: ServerArn; } export interface AssociateGatewayToServerOutput { /** * The Amazon Resource Name (ARN) of a gateway. */ GatewayArn?: GatewayArn; } export interface CreateGatewayInput { /** * The activation key of the created gateway. */ ActivationKey: ActivationKey; /** * The display name of the created gateway. */ GatewayDisplayName: Name; /** * The type of created gateway. */ GatewayType: GatewayType; /** * A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair. */ Tags?: Tags; } export interface CreateGatewayOutput { /** * The Amazon Resource Name (ARN) of the gateway you create. */ GatewayArn?: GatewayArn; } export type DayOfMonth = number; export type DayOfWeek = number; export interface DeleteGatewayInput { /** * The Amazon Resource Name (ARN) of the gateway to delete. */ GatewayArn: GatewayArn; } export interface DeleteGatewayOutput { /** * The Amazon Resource Name (ARN) of the gateway you deleted. */ GatewayArn?: GatewayArn; } export interface DeleteHypervisorInput { /** * The Amazon Resource Name (ARN) of the hypervisor to delete. */ HypervisorArn: ServerArn; } export interface DeleteHypervisorOutput { /** * The Amazon Resource Name (ARN) of the hypervisor you deleted. */ HypervisorArn?: ServerArn; } export interface DisassociateGatewayFromServerInput { /** * The Amazon Resource Name (ARN) of the gateway to disassociate. */ GatewayArn: GatewayArn; } export interface DisassociateGatewayFromServerOutput { /** * The Amazon Resource Name (ARN) of the gateway you disassociated. */ GatewayArn?: GatewayArn; } export interface Gateway { /** * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. */ GatewayArn?: GatewayArn; /** * The display name of the gateway. */ GatewayDisplayName?: Name; /** * The type of the gateway. */ GatewayType?: GatewayType; /** * The hypervisor ID of the gateway. */ HypervisorId?: HypervisorId; /** * The last time Backup gateway communicated with the gateway, in Unix format and UTC time. */ LastSeenTime?: Time; } export type GatewayArn = string; export interface GatewayDetails { /** * The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. */ GatewayArn?: GatewayArn; /** * The display name of the gateway. */ GatewayDisplayName?: Name; /** * The type of the gateway type. */ GatewayType?: GatewayType; /** * The hypervisor ID of the gateway. */ HypervisorId?: HypervisorId; /** * Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time. */ LastSeenTime?: Time; /** * Details showing the next update availability time of the gateway. */ NextUpdateAvailabilityTime?: Time; /** * The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway. */ VpcEndpoint?: VpcEndpoint; } export type GatewayType = "BACKUP_VM"|string; export type Gateways = Gateway[]; export interface GetGatewayInput { /** * The Amazon Resource Name (ARN) of the gateway. */ GatewayArn: GatewayArn; } export interface GetGatewayOutput { /** * By providing the ARN (Amazon Resource Name), this API returns the gateway. */ Gateway?: GatewayDetails; } export type Host = string; export type HourOfDay = number; export interface Hypervisor { /** * The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). */ Host?: Host; /** * The Amazon Resource Name (ARN) of the hypervisor. */ HypervisorArn?: ServerArn; /** * The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor. */ KmsKeyArn?: KmsKeyArn; /** * The name of the hypervisor. */ Name?: Name; /** * The state of the hypervisor. */ State?: HypervisorState; } export type HypervisorId = string; export type HypervisorState = "PENDING"|"ONLINE"|"OFFLINE"|"ERROR"|string; export type Hypervisors = Hypervisor[]; export interface ImportHypervisorConfigurationInput { /** * The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). */ Host: Host; /** * The Key Management Service for the hypervisor. */ KmsKeyArn?: KmsKeyArn; /** * The name of the hypervisor. */ Name: Name; /** * The password for the hypervisor. */ Password?: Password; /** * The tags of the hypervisor configuration to import. */ Tags?: Tags; /** * The username for the hypervisor. */ Username?: Username; } export interface ImportHypervisorConfigurationOutput { /** * The Amazon Resource Name (ARN) of the hypervisor you disassociated. */ HypervisorArn?: ServerArn; } export type KmsKeyArn = string; export interface ListGatewaysInput { /** * The maximum number of gateways to list. */ MaxResults?: MaxResults; /** * The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token. */ NextToken?: NextToken; } export interface ListGatewaysOutput { /** * A list of your gateways. */ Gateways?: Gateways; /** * The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token. */ NextToken?: NextToken; } export interface ListHypervisorsInput { /** * The maximum number of hypervisors to list. */ MaxResults?: MaxResults; /** * The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token. */ NextToken?: NextToken; } export interface ListHypervisorsOutput { /** * A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs). */ Hypervisors?: Hypervisors; /** * The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token. */ NextToken?: NextToken; } export interface ListTagsForResourceInput { /** * The Amazon Resource Name (ARN) of the resource's tags to list. */ ResourceArn: ResourceArn; } export interface ListTagsForResourceOutput { /** * The Amazon Resource Name (ARN) of the resource's tags that you listed. */ ResourceArn?: ResourceArn; /** * A list of the resource's tags. */ Tags?: Tags; } export interface ListVirtualMachinesInput { /** * The maximum number of virtual machines to list. */ MaxResults?: MaxResults; /** * The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token. */ NextToken?: NextToken; } export interface ListVirtualMachinesOutput { /** * The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token. */ NextToken?: NextToken; /** * A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs). */ VirtualMachines?: VirtualMachines; } export type MaxResults = number; export type MinuteOfHour = number; export type Name = string; export type NextToken = string; export type Password = string; export type Path = string; export interface PutMaintenanceStartTimeInput { /** * The day of the month start maintenance on a gateway. Valid values range from Sunday to Saturday. */ DayOfMonth?: DayOfMonth; /** * The day of the week to start maintenance on a gateway. */ DayOfWeek?: DayOfWeek; /** * The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time. */ GatewayArn: GatewayArn; /** * The hour of the day to start maintenance on a gateway. */ HourOfDay: HourOfDay; /** * The minute of the hour to start maintenance on a gateway. */ MinuteOfHour: MinuteOfHour; } export interface PutMaintenanceStartTimeOutput { /** * The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time. */ GatewayArn?: GatewayArn; } export type ResourceArn = string; export type ServerArn = string; export interface Tag { /** * The key part of a tag's key-value pair. The key can't start with aws:. */ Key: TagKey; /** * The value part of a tag's key-value pair. */ Value: TagValue; } export type TagKey = string; export type TagKeys = TagKey[]; export interface TagResourceInput { /** * The Amazon Resource Name (ARN) of the resource to tag. */ ResourceARN: ResourceArn; /** * A list of tags to assign to the resource. */ Tags: Tags; } export interface TagResourceOutput { /** * The Amazon Resource Name (ARN) of the resource you tagged. */ ResourceARN?: ResourceArn; } export type TagValue = string; export type Tags = Tag[]; export interface TestHypervisorConfigurationInput { /** * The Amazon Resource Name (ARN) of the gateway to the hypervisor to test. */ GatewayArn: GatewayArn; /** * The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). */ Host: Host; /** * The password for the hypervisor. */ Password?: Password; /** * The username for the hypervisor. */ Username?: Username; } export interface TestHypervisorConfigurationOutput { } export type Time = Date; export interface UntagResourceInput { /** * The Amazon Resource Name (ARN) of the resource from which to remove tags. */ ResourceARN: ResourceArn; /** * The list of tag keys specifying which tags to remove. */ TagKeys: TagKeys; } export interface UntagResourceOutput { /** * The Amazon Resource Name (ARN) of the resource from which you removed tags. */ ResourceARN?: ResourceArn; } export interface UpdateGatewayInformationInput { /** * The Amazon Resource Name (ARN) of the gateway to update. */ GatewayArn: GatewayArn; /** * The updated display name of the gateway. */ GatewayDisplayName?: Name; } export interface UpdateGatewayInformationOutput { /** * The Amazon Resource Name (ARN) of the gateway you updated. */ GatewayArn?: GatewayArn; } export interface UpdateGatewaySoftwareNowInput { /** * The Amazon Resource Name (ARN) of the gateway to be updated. */ GatewayArn: GatewayArn; } export interface UpdateGatewaySoftwareNowOutput { /** * The Amazon Resource Name (ARN) of the gateway you updated. */ GatewayArn?: GatewayArn; } export interface UpdateHypervisorInput { /** * The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN). */ Host?: Host; /** * The Amazon Resource Name (ARN) of the hypervisor to update. */ HypervisorArn: ServerArn; /** * The updated name for the hypervisor */ Name?: Name; /** * The updated password for the hypervisor. */ Password?: Password; /** * The updated username for the hypervisor. */ Username?: Username; } export interface UpdateHypervisorOutput { /** * The Amazon Resource Name (ARN) of the hypervisor you updated. */ HypervisorArn?: ServerArn; } export type Username = string; export interface VirtualMachine { /** * The host name of the virtual machine. */ HostName?: Name; /** * The ID of the virtual machine's hypervisor. */ HypervisorId?: string; /** * The most recent date a virtual machine was backed up, in Unix format and UTC time. */ LastBackupDate?: Time; /** * The name of the virtual machine. */ Name?: Name; /** * The path of the virtual machine. */ Path?: Path; /** * The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL. */ ResourceArn?: ResourceArn; } export type VirtualMachines = VirtualMachine[]; export type VpcEndpoint = string; /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2021-01-01"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the BackupGateway client. */ export import Types = BackupGateway; } export = BackupGateway;