Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DeleteTape

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

Request Syntax


{
   "BypassGovernanceRetention": boolean,
   "GatewayARN": "string",
   "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 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.

Type: Boolean

Required: No

GatewayARN

The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

TapeARN

The Amazon Resource Name (ARN) of the virtual tape to delete.

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 deleted virtual tape.

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

Examples

Delete a tape from a gateway

The following example deletes a tape from a tape gateway with ID sgw-12A3456B. The request identifies the tape by its ARN. The operation deletes the tapes from the specified gateway's virtual tape library (VTL). In the response, tape gateway returns the ARN of deleted tape.

Sample Request


POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20131025T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9EXAMPLE
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.DeleteTape

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:123456789012:gateway/sgw-12A3456B",
    "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST05A2A0"
}

Sample Response


{
    "TapeARN": "arn:aws:storagegateway:us-east-2:123456789012:tape/TEST05A2A0"
}