- 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.
DeleteGatewayCommand
Deletes a backup gateway.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { BackupGatewayClient, DeleteGatewayCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import
// const { BackupGatewayClient, DeleteGatewayCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import
const client = new BackupGatewayClient(config);
const input = { // DeleteGatewayInput
GatewayArn: "STRING_VALUE", // required
};
const command = new DeleteGatewayCommand(input);
const response = await client.send(command);
// { // DeleteGatewayOutput
// GatewayArn: "STRING_VALUE",
// };
DeleteGatewayCommand Input
See DeleteGatewayCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
GatewayArn Required | string | undefined | The Amazon Resource Name (ARN) of the gateway to delete. |
DeleteGatewayCommand Output
See DeleteGatewayCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
GatewayArn | string | undefined | The Amazon Resource Name (ARN) of the gateway you deleted. |
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. |