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

DescribeTapeArchives

Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

Request Syntax

{
   "Limit": number,
   "Marker": "string",
   "TapeARNs": [ "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.

Limit

Specifies that the number of virtual tapes descried be limited to the specified number.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Marker

An opaque string that indicates the position at which to begin describing virtual tapes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

TapeARNs

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Type: Array of strings

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: No

Response Syntax

{
   "Marker": "string",
   "TapeArchives": [ 
      { 
         "CompletionTime": number,
         "RetrievedTo": "string",
         "TapeARN": "string",
         "TapeBarcode": "string",
         "TapeCreatedDate": number,
         "TapeSizeInBytes": number,
         "TapeStatus": "string",
         "TapeUsedInBytes": number
      }
   ]
}

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.

Marker

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

TapeArchives

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

Type: Array of TapeArchive objects

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 description tapes in VTS

The following example shows a request that retrieves description of two tapes archived to VTS in the AWS region specified in the request. The request identifies the tapes by their ARN value. The trailing string in the ARN is the tape barcode. If you don't provide the tape ARN, tape gateway returns information about all tapes archived to VTS.

Sample Request


POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20131028T120000Z
x-amz-target: StorageGateway_20130630.DescribeTapeArchives

{"TapeARNs":
  ["arn:aws:storagegateway:us-east-2:999999999999:tape/AM08A1AD",
   "arn:aws:storagegateway:us-east-2:999999999999:tape/AMZN01A2A4"]
}

            

Sample Response


{"TapeArchives":
  [
    {"CompletionTime": 1380308527.236,
     "TapeARN": "arn:aws:storagegateway:us-east-2:999999999:tape/AM08A1AD",
     "TapeBarcode": "AM08A1AD",
     "TapeSizeInBytes": 107374182400,
     "TapeStatus": "ARCHIVED"},
    {"CompletionTime": 1382918022.647,
     "TapeARN": "arn:aws:storagegateway:us-east-2:999999999:tape/AMZN01A2A4",
     "TapeBarcode": "AMZN01A2A4",
     "TapeSizeInBytes": 429496729600,
     "TapeStatus": "ARCHIVED"}
  ]
}

            

See Also

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