Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DeleteTapeArchiveCommand

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

Example Syntax

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

import { StorageGatewayClient, DeleteTapeArchiveCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, DeleteTapeArchiveCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // DeleteTapeArchiveInput
  TapeARN: "STRING_VALUE", // required
  BypassGovernanceRetention: true || false,
};
const command = new DeleteTapeArchiveCommand(input);
const response = await client.send(command);
// { // DeleteTapeArchiveOutput
//   TapeARN: "STRING_VALUE",
// };

Example Usage

Loading code editorLoading code editor

DeleteTapeArchiveCommand Input

See DeleteTapeArchiveCommandInput for more details

Parameter	Type	Description
`TapeARN` Required	`string \| undefined`	The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
`BypassGovernanceRetention`	`boolean \| undefined`	Set to `TRUE` to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to `governance` can be deleted. Archived tapes with tape retention lock set to `compliance` can't be deleted.

DeleteTapeArchiveCommand Output

See DeleteTapeArchiveCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`TapeARN`	`string \| undefined`	The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).

Throws

Name	Fault	Details
InternalServerError	server	An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException	client	An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
StorageGatewayServiceException		Base exception class for all service exceptions from StorageGateway service.

Getting Started

References