- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateGatewaySoftwareNowCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { BackupGatewayClient, UpdateGatewaySoftwareNowCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import
// const { BackupGatewayClient, UpdateGatewaySoftwareNowCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import
const client = new BackupGatewayClient(config);
const input = { // UpdateGatewaySoftwareNowInput
GatewayArn: "STRING_VALUE", // required
};
const command = new UpdateGatewaySoftwareNowCommand(input);
const response = await client.send(command);
// { // UpdateGatewaySoftwareNowOutput
// GatewayArn: "STRING_VALUE",
// };
UpdateGatewaySoftwareNowCommand Input
See UpdateGatewaySoftwareNowCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
GatewayArnRequired | string | undefined | The Amazon Resource Name (ARN) of the gateway to be updated. |
UpdateGatewaySoftwareNowCommand Output
See UpdateGatewaySoftwareNowCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
GatewayArn | string | undefined | The Amazon Resource Name (ARN) of the gateway you updated. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| ResourceNotFoundException | client | A resource that is required for the action wasn't found. |
| InternalServerException | server | The operation did not succeed because an internal error occurred. Try again later. |
| ThrottlingException | client | TPS has been limited to protect against intentional or unintentional high request volumes. |
| ValidationException | client | The operation did not succeed because a validation error occurred. |
| BackupGatewayServiceException | Base exception class for all service exceptions from BackupGateway service. |