Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

RetrieveTapeArchive

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

Request Syntax

{
   "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.

GatewayARN

The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.

You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.

Type: String

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

Required: Yes

TapeARN

The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

Type: String

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

Pattern: ^arn:(aws|aws-cn):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{7,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 retrieved virtual tape.

Type: String

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

Pattern: ^arn:(aws|aws-cn):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{7,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

Example

Retrieve a Tape

The following example request retrieves an archived tape from VTS to a gateway with the ID sgw-12A3456B. In the request, the tape is identified by its ARN. In the ARN the trailing string is the tape barcode. The string 999999999999 is your AWS account number. It takes about 24 hours for retrieval to complete. After the operation is complete, the tape appears in the specified gateway's virtual tape library (VTL).

Sample Request


POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.RetrieveTapeArchive
{
  "TapeARN": "arn:aws:storagegateway:us-east-2:999999999999:tape/TEST0AA2AF",
   "GatewayARN": "arn:aws:storagegateway:us-east-2:999999999999:gateway/sgw-12A3456B"
 }
               

Sample Response


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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: