@aws-sdk/client-backup-gateway 3.312.0 → 3.316.0

package/dist-types/BackupGateway.d.ts

@@ -25,219 +25,169 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { UpdateGatewayInformationCommandInput, UpdateGatewayInformationCommandOutput } from "./commands/UpdateGatewayInformationCommand";
 import { UpdateGatewaySoftwareNowCommandInput, UpdateGatewaySoftwareNowCommandOutput } from "./commands/UpdateGatewaySoftwareNowCommand";
 import { UpdateHypervisorCommandInput, UpdateHypervisorCommandOutput } from "./commands/UpdateHypervisorCommand";
-/**
- * @public
- * <fullname>Backup gateway</fullname>
- *          <p>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.</p>
- *          <p>Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.</p>
- *          <p>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.</p>
- *          <p>To download the Amazon Web Services software to get started, navigate to the Backup console, choose <b>Gateways</b>, then choose <b>Create gateway</b>.</p>
- */
-export declare class BackupGateway extends BackupGatewayClient {
+export interface BackupGateway {
     /**
-     * @public
-     * <p>Associates a backup gateway with your server. After you complete the association process,
-     *       you can back up and restore your VMs through the gateway.</p>
+     * @see {@link AssociateGatewayToServerCommand}
      */
     associateGatewayToServer(args: AssociateGatewayToServerCommandInput, options?: __HttpHandlerOptions): Promise<AssociateGatewayToServerCommandOutput>;
     associateGatewayToServer(args: AssociateGatewayToServerCommandInput, cb: (err: any, data?: AssociateGatewayToServerCommandOutput) => void): void;
     associateGatewayToServer(args: AssociateGatewayToServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateGatewayToServerCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Creates a backup gateway. After you create a gateway, you can associate it with a server
-     *       using the <code>AssociateGatewayToServer</code> operation.</p>
+     * @see {@link CreateGatewayCommand}
      */
     createGateway(args: CreateGatewayCommandInput, options?: __HttpHandlerOptions): Promise<CreateGatewayCommandOutput>;
     createGateway(args: CreateGatewayCommandInput, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
     createGateway(args: CreateGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGatewayCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes a backup gateway.</p>
+     * @see {@link DeleteGatewayCommand}
      */
     deleteGateway(args: DeleteGatewayCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGatewayCommandOutput>;
     deleteGateway(args: DeleteGatewayCommandInput, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
     deleteGateway(args: DeleteGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGatewayCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Deletes a hypervisor.</p>
+     * @see {@link DeleteHypervisorCommand}
      */
     deleteHypervisor(args: DeleteHypervisorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHypervisorCommandOutput>;
     deleteHypervisor(args: DeleteHypervisorCommandInput, cb: (err: any, data?: DeleteHypervisorCommandOutput) => void): void;
     deleteHypervisor(args: DeleteHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHypervisorCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link DisassociateGatewayFromServerCommand}
      */
     disassociateGatewayFromServer(args: DisassociateGatewayFromServerCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateGatewayFromServerCommandOutput>;
     disassociateGatewayFromServer(args: DisassociateGatewayFromServerCommandInput, cb: (err: any, data?: DisassociateGatewayFromServerCommandOutput) => void): void;
     disassociateGatewayFromServer(args: DisassociateGatewayFromServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateGatewayFromServerCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link GetBandwidthRateLimitScheduleCommand}
      */
     getBandwidthRateLimitSchedule(args: GetBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions): Promise<GetBandwidthRateLimitScheduleCommandOutput>;
     getBandwidthRateLimitSchedule(args: GetBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void): void;
     getBandwidthRateLimitSchedule(args: GetBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBandwidthRateLimitScheduleCommandOutput) => void): void;
     /**
-     * @public
-     * <p>By providing the ARN (Amazon Resource Name), this
-     *       API returns the gateway.</p>
+     * @see {@link GetGatewayCommand}
      */
     getGateway(args: GetGatewayCommandInput, options?: __HttpHandlerOptions): Promise<GetGatewayCommandOutput>;
     getGateway(args: GetGatewayCommandInput, cb: (err: any, data?: GetGatewayCommandOutput) => void): void;
     getGateway(args: GetGatewayCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGatewayCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link GetHypervisorCommand}
      */
     getHypervisor(args: GetHypervisorCommandInput, options?: __HttpHandlerOptions): Promise<GetHypervisorCommandOutput>;
     getHypervisor(args: GetHypervisorCommandInput, cb: (err: any, data?: GetHypervisorCommandOutput) => void): void;
     getHypervisor(args: GetHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHypervisorCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link GetHypervisorPropertyMappingsCommand}
      */
     getHypervisorPropertyMappings(args: GetHypervisorPropertyMappingsCommandInput, options?: __HttpHandlerOptions): Promise<GetHypervisorPropertyMappingsCommandOutput>;
     getHypervisorPropertyMappings(args: GetHypervisorPropertyMappingsCommandInput, cb: (err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void): void;
     getHypervisorPropertyMappings(args: GetHypervisorPropertyMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetHypervisorPropertyMappingsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>By providing the ARN (Amazon Resource Name), this API returns the virtual machine.</p>
+     * @see {@link GetVirtualMachineCommand}
      */
     getVirtualMachine(args: GetVirtualMachineCommandInput, options?: __HttpHandlerOptions): Promise<GetVirtualMachineCommandOutput>;
     getVirtualMachine(args: GetVirtualMachineCommandInput, cb: (err: any, data?: GetVirtualMachineCommandOutput) => void): void;
     getVirtualMachine(args: GetVirtualMachineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVirtualMachineCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Connect to a hypervisor by importing its configuration.</p>
+     * @see {@link ImportHypervisorConfigurationCommand}
      */
     importHypervisorConfiguration(args: ImportHypervisorConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<ImportHypervisorConfigurationCommandOutput>;
     importHypervisorConfiguration(args: ImportHypervisorConfigurationCommandInput, cb: (err: any, data?: ImportHypervisorConfigurationCommandOutput) => void): void;
     importHypervisorConfiguration(args: ImportHypervisorConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportHypervisorConfigurationCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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).</p>
+     * @see {@link ListGatewaysCommand}
      */
     listGateways(args: ListGatewaysCommandInput, options?: __HttpHandlerOptions): Promise<ListGatewaysCommandOutput>;
     listGateways(args: ListGatewaysCommandInput, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
     listGateways(args: ListGatewaysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGatewaysCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists your hypervisors.</p>
+     * @see {@link ListHypervisorsCommand}
      */
     listHypervisors(args: ListHypervisorsCommandInput, options?: __HttpHandlerOptions): Promise<ListHypervisorsCommandOutput>;
     listHypervisors(args: ListHypervisorsCommandInput, cb: (err: any, data?: ListHypervisorsCommandOutput) => void): void;
     listHypervisors(args: ListHypervisorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListHypervisorsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists the tags applied to the resource identified by its Amazon Resource Name
-     *       (ARN).</p>
+     * @see {@link ListTagsForResourceCommand}
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Lists your virtual machines.</p>
+     * @see {@link ListVirtualMachinesCommand}
      */
     listVirtualMachines(args: ListVirtualMachinesCommandInput, options?: __HttpHandlerOptions): Promise<ListVirtualMachinesCommandOutput>;
     listVirtualMachines(args: ListVirtualMachinesCommandInput, cb: (err: any, data?: ListVirtualMachinesCommandOutput) => void): void;
     listVirtualMachines(args: ListVirtualMachinesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVirtualMachinesCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link PutBandwidthRateLimitScheduleCommand}
      */
     putBandwidthRateLimitSchedule(args: PutBandwidthRateLimitScheduleCommandInput, options?: __HttpHandlerOptions): Promise<PutBandwidthRateLimitScheduleCommandOutput>;
     putBandwidthRateLimitSchedule(args: PutBandwidthRateLimitScheduleCommandInput, cb: (err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void): void;
     putBandwidthRateLimitSchedule(args: PutBandwidthRateLimitScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBandwidthRateLimitScheduleCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link PutHypervisorPropertyMappingsCommand}
      */
     putHypervisorPropertyMappings(args: PutHypervisorPropertyMappingsCommandInput, options?: __HttpHandlerOptions): Promise<PutHypervisorPropertyMappingsCommandOutput>;
     putHypervisorPropertyMappings(args: PutHypervisorPropertyMappingsCommandInput, cb: (err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void): void;
     putHypervisorPropertyMappings(args: PutHypervisorPropertyMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutHypervisorPropertyMappingsCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Set the maintenance start time for a gateway.</p>
+     * @see {@link PutMaintenanceStartTimeCommand}
      */
     putMaintenanceStartTime(args: PutMaintenanceStartTimeCommandInput, options?: __HttpHandlerOptions): Promise<PutMaintenanceStartTimeCommandOutput>;
     putMaintenanceStartTime(args: PutMaintenanceStartTimeCommandInput, cb: (err: any, data?: PutMaintenanceStartTimeCommandOutput) => void): void;
     putMaintenanceStartTime(args: PutMaintenanceStartTimeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMaintenanceStartTimeCommandOutput) => void): void;
     /**
-     * @public
-     * <p>This action sends a request to sync metadata across the specified virtual machines.</p>
+     * @see {@link StartVirtualMachinesMetadataSyncCommand}
      */
     startVirtualMachinesMetadataSync(args: StartVirtualMachinesMetadataSyncCommandInput, options?: __HttpHandlerOptions): Promise<StartVirtualMachinesMetadataSyncCommandOutput>;
     startVirtualMachinesMetadataSync(args: StartVirtualMachinesMetadataSyncCommandInput, cb: (err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void): void;
     startVirtualMachinesMetadataSync(args: StartVirtualMachinesMetadataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartVirtualMachinesMetadataSyncCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Tag the resource.</p>
+     * @see {@link TagResourceCommand}
      */
     tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Tests your hypervisor configuration to validate that backup gateway can connect with the
-     *       hypervisor and its resources.</p>
+     * @see {@link TestHypervisorConfigurationCommand}
      */
     testHypervisorConfiguration(args: TestHypervisorConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<TestHypervisorConfigurationCommandOutput>;
     testHypervisorConfiguration(args: TestHypervisorConfigurationCommandInput, cb: (err: any, data?: TestHypervisorConfigurationCommandOutput) => void): void;
     testHypervisorConfiguration(args: TestHypervisorConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestHypervisorConfigurationCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Removes tags from the resource.</p>
+     * @see {@link UntagResourceCommand}
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name
-     *       (ARN) of the gateway in your request.</p>
+     * @see {@link UpdateGatewayInformationCommand}
      */
     updateGatewayInformation(args: UpdateGatewayInformationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGatewayInformationCommandOutput>;
     updateGatewayInformation(args: UpdateGatewayInformationCommandInput, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void): void;
     updateGatewayInformation(args: UpdateGatewayInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewayInformationCommandOutput) => void): void;
     /**
-     * @public
-     * <p>Updates the gateway virtual machine (VM) software.
-     *       The request immediately triggers the software update.</p>
-     *          <note>
-     *             <p>When you make this request, you get a <code>200 OK</code>
-     *         success response immediately. However, it might take some
-     *         time for the update to complete.</p>
-     *          </note>
+     * @see {@link UpdateGatewaySoftwareNowCommand}
      */
     updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGatewaySoftwareNowCommandOutput>;
     updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void): void;
     updateGatewaySoftwareNow(args: UpdateGatewaySoftwareNowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGatewaySoftwareNowCommandOutput) => void): void;
     /**
-     * @public
-     * <p>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.</p>
+     * @see {@link UpdateHypervisorCommand}
      */
     updateHypervisor(args: UpdateHypervisorCommandInput, options?: __HttpHandlerOptions): Promise<UpdateHypervisorCommandOutput>;
     updateHypervisor(args: UpdateHypervisorCommandInput, cb: (err: any, data?: UpdateHypervisorCommandOutput) => void): void;
     updateHypervisor(args: UpdateHypervisorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHypervisorCommandOutput) => void): void;
 }
+/**
+ * @public
+ * <fullname>Backup gateway</fullname>
+ *          <p>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.</p>
+ *          <p>Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.</p>
+ *          <p>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.</p>
+ *          <p>To download the Amazon Web Services software to get started, navigate to the Backup console, choose <b>Gateways</b>, then choose <b>Create gateway</b>.</p>
+ */
+export declare class BackupGateway extends BackupGatewayClient implements BackupGateway {
+}

package/dist-types/ts3.4/BackupGateway.d.ts

@@ -100,7 +100,7 @@ import {
   UpdateHypervisorCommandInput,
   UpdateHypervisorCommandOutput,
 } from "./commands/UpdateHypervisorCommand";
-export declare class BackupGateway extends BackupGatewayClient {
+export interface BackupGateway {
   associateGatewayToServer(
     args: AssociateGatewayToServerCommandInput,
     options?: __HttpHandlerOptions
@@ -427,3 +427,6 @@ export declare class BackupGateway extends BackupGatewayClient {
     cb: (err: any, data?: UpdateHypervisorCommandOutput) => void
   ): void;
 }
+export declare class BackupGateway
+  extends BackupGatewayClient
+  implements BackupGateway {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-backup-gateway",
   "description": "AWS SDK for JavaScript Backup Gateway Client for Node.js, Browser and React Native",
-  "version": "3.312.0",
+  "version": "3.316.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.312.0",
+    "@aws-sdk/client-sts": "3.316.0",
     "@aws-sdk/config-resolver": "3.310.0",
-    "@aws-sdk/credential-provider-node": "3.310.0",
+    "@aws-sdk/credential-provider-node": "3.316.0",
     "@aws-sdk/fetch-http-handler": "3.310.0",
     "@aws-sdk/hash-node": "3.310.0",
     "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
     "@aws-sdk/node-config-provider": "3.310.0",
     "@aws-sdk/node-http-handler": "3.310.0",
     "@aws-sdk/protocol-http": "3.310.0",
-    "@aws-sdk/smithy-client": "3.310.0",
+    "@aws-sdk/smithy-client": "3.316.0",
     "@aws-sdk/types": "3.310.0",
     "@aws-sdk/url-parser": "3.310.0",
     "@aws-sdk/util-base64": "3.310.0",
     "@aws-sdk/util-body-length-browser": "3.310.0",
     "@aws-sdk/util-body-length-node": "3.310.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.310.0",
-    "@aws-sdk/util-defaults-mode-node": "3.310.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.316.0",
+    "@aws-sdk/util-defaults-mode-node": "3.316.0",
     "@aws-sdk/util-endpoints": "3.310.0",
     "@aws-sdk/util-retry": "3.310.0",
     "@aws-sdk/util-user-agent-browser": "3.310.0",