DeleteBackupVaultCommand

Suggest an Edit

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BackupClient, DeleteBackupVaultCommand } from "@aws-sdk/client-backup"; // ES Modules import
// const { BackupClient, DeleteBackupVaultCommand } = require("@aws-sdk/client-backup"); // CommonJS import
const client = new BackupClient(config);
const input = { // DeleteBackupVaultInput
  BackupVaultName: "STRING_VALUE", // required
};
const command = new DeleteBackupVaultCommand(input);
const response = await client.send(command);
// {};

DeleteBackupVaultCommand Input

See DeleteBackupVaultCommandInput for more details

Parameter
Type
Description
BackupVaultName
Required
string | undefined

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

DeleteBackupVaultCommand Output

See DeleteBackupVaultCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidParameterValueException
client

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

InvalidRequestException
client

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

MissingParameterValueException
client

Indicates that a required parameter is missing.

ResourceNotFoundException
client

A resource that is required for the action doesn't exist.

ServiceUnavailableException
server

The request failed due to a temporary failure of the server.

BackupServiceException
Base exception class for all service exceptions from Backup service.