feat(client-backup-gateway): Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime.

Author: awstools

clients/client-backup-gateway/src/BackupGateway.ts

@@ -28,6 +28,11 @@ import {
   DisassociateGatewayFromServerCommandOutput,
 } from "./commands/DisassociateGatewayFromServerCommand";
 import { GetGatewayCommand, GetGatewayCommandInput, GetGatewayCommandOutput } from "./commands/GetGatewayCommand";
+import {
+  GetVirtualMachineCommand,
+  GetVirtualMachineCommandInput,
+  GetVirtualMachineCommandOutput,
+} from "./commands/GetVirtualMachineCommand";
 import {
   ImportHypervisorConfigurationCommand,
   ImportHypervisorConfigurationCommandInput,
@@ -287,6 +292,38 @@ export class BackupGateway extends BackupGatewayClient {
     }
   }
 
+  /**
+   * <p>By providing the ARN (Amazon Resource Name), this API returns the virtual machine.</p>
+   */
+  public getVirtualMachine(
+    args: GetVirtualMachineCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetVirtualMachineCommandOutput>;
+  public getVirtualMachine(
+    args: GetVirtualMachineCommandInput,
+    cb: (err: any, data?: GetVirtualMachineCommandOutput) => void
+  ): void;
+  public getVirtualMachine(
+    args: GetVirtualMachineCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetVirtualMachineCommandOutput) => void
+  ): void;
+  public getVirtualMachine(
+    args: GetVirtualMachineCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetVirtualMachineCommandOutput) => void),
+    cb?: (err: any, data?: GetVirtualMachineCommandOutput) => void
+  ): Promise<GetVirtualMachineCommandOutput> | void {
+    const command = new GetVirtualMachineCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
+
   /**
    * <p>Connect to a hypervisor by importing its configuration.</p>
    */

clients/client-backup-gateway/src/BackupGatewayClient.ts

@@ -65,6 +65,7 @@ import {
   DisassociateGatewayFromServerCommandOutput,
 } from "./commands/DisassociateGatewayFromServerCommand";
 import { GetGatewayCommandInput, GetGatewayCommandOutput } from "./commands/GetGatewayCommand";
+import { GetVirtualMachineCommandInput, GetVirtualMachineCommandOutput } from "./commands/GetVirtualMachineCommand";
 import {
   ImportHypervisorConfigurationCommandInput,
   ImportHypervisorConfigurationCommandOutput,
@@ -107,6 +108,7 @@ export type ServiceInputTypes =
   | DeleteHypervisorCommandInput
   | DisassociateGatewayFromServerCommandInput
   | GetGatewayCommandInput
+  | GetVirtualMachineCommandInput
   | ImportHypervisorConfigurationCommandInput
   | ListGatewaysCommandInput
   | ListHypervisorsCommandInput
@@ -127,6 +129,7 @@ export type ServiceOutputTypes =
   | DeleteHypervisorCommandOutput
   | DisassociateGatewayFromServerCommandOutput
   | GetGatewayCommandOutput
+  | GetVirtualMachineCommandOutput
   | ImportHypervisorConfigurationCommandOutput
   | ListGatewaysCommandOutput
   | ListHypervisorsCommandOutput

clients/client-backup-gateway/src/commands/GetVirtualMachineCommand.ts

@@ -0,0 +1,101 @@
+// smithy-typescript generated code
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import { BackupGatewayClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BackupGatewayClient";
+import {
+  GetVirtualMachineInput,
+  GetVirtualMachineInputFilterSensitiveLog,
+  GetVirtualMachineOutput,
+  GetVirtualMachineOutputFilterSensitiveLog,
+} from "../models/models_0";
+import {
+  deserializeAws_json1_0GetVirtualMachineCommand,
+  serializeAws_json1_0GetVirtualMachineCommand,
+} from "../protocols/Aws_json1_0";
+
+export interface GetVirtualMachineCommandInput extends GetVirtualMachineInput {}
+export interface GetVirtualMachineCommandOutput extends GetVirtualMachineOutput, __MetadataBearer {}
+
+/**
+ * <p>By providing the ARN (Amazon Resource Name), this API returns the virtual machine.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BackupGatewayClient, GetVirtualMachineCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import
+ * // const { BackupGatewayClient, GetVirtualMachineCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import
+ * const client = new BackupGatewayClient(config);
+ * const command = new GetVirtualMachineCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetVirtualMachineCommandInput} for command's `input` shape.
+ * @see {@link GetVirtualMachineCommandOutput} for command's `response` shape.
+ * @see {@link BackupGatewayClientResolvedConfig | config} for BackupGatewayClient's `config` shape.
+ *
+ */
+export class GetVirtualMachineCommand extends $Command<
+  GetVirtualMachineCommandInput,
+  GetVirtualMachineCommandOutput,
+  BackupGatewayClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  constructor(readonly input: GetVirtualMachineCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: BackupGatewayClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<GetVirtualMachineCommandInput, GetVirtualMachineCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "BackupGatewayClient";
+    const commandName = "GetVirtualMachineCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: GetVirtualMachineInputFilterSensitiveLog,
+      outputFilterSensitiveLog: GetVirtualMachineOutputFilterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: GetVirtualMachineCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_json1_0GetVirtualMachineCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<GetVirtualMachineCommandOutput> {
+    return deserializeAws_json1_0GetVirtualMachineCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}

clients/client-backup-gateway/src/commands/index.ts

@@ -5,6 +5,7 @@ export * from "./DeleteGatewayCommand";
 export * from "./DeleteHypervisorCommand";
 export * from "./DisassociateGatewayFromServerCommand";
 export * from "./GetGatewayCommand";
+export * from "./GetVirtualMachineCommand";
 export * from "./ImportHypervisorConfigurationCommand";
 export * from "./ListGatewaysCommand";
 export * from "./ListHypervisorsCommand";