Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

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, Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

post/#X-Amz-Target=StorageGateway_20130630.DescribeTapeArchives

Query parameters

Limitstring

Pagination limit

Markerstring

Pagination token

Headers

X-Amz-Target'StorageGateway_20130630.DescribeTapeArchives' required

Request body

TapeARNsTapeARN[]

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

Markerstring

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

Limitinteger

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

Response

Success

Markerstring

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.

Example response

{
  "Marker": "1",
  "TapeArchives": [
    {
      "CompletionTime": "2016-12-16T13:50Z",
      "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD",
      "TapeBarcode": "AM08A1AD",
      "TapeSizeInBytes": 107374182400,
      "TapeStatus": "ARCHIVED"
    },
    {
      "CompletionTime": "2016-12-16T13:59Z",
      "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4",
      "TapeBarcode": "AMZN01A2A4",
      "TapeSizeInBytes": 429496729600,
      "TapeStatus": "ARCHIVED"
    }
  ]
}