DeleteTapeArchive
Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.
Request Syntax
{
"BypassGovernanceRetention": boolean,
"TapeARN": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- BypassGovernanceRetention
-
Set to
TRUEto delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set togovernancecan be deleted. Archived tapes with tape retention lock set tocompliancecan't be deleted.Type: Boolean
Required: No
- TapeARN
-
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$Required: Yes
Response Syntax
{
"TapeARN": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- TapeARN
-
The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error has occurred during the request. For more information, see the error and message fields.
HTTP Status Code: 400
- InvalidGatewayRequestException
-
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
