Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

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

Query parameters

Limitstring

Pagination limit

Markerstring

Pagination token

Headers

X-Amz-Target'StorageGateway_20130630.DescribeTapes' required

Request body

GatewayARNstring required

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

TapeARNsTapeARN[]

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

Markerstring
<p>A marker value, obtained in a previous call to <code>DescribeTapes</code>. This marker indicates which page of results to retrieve.</p> <p>If not specified, the first page of results is retrieved.</p>
Limitinteger
<p>Specifies that the number of virtual tapes described be limited to the specified number.</p> <note> <p>Amazon Web Services may impose its own limit, if this field is not set.</p> </note>

Response

Success

Markerstring
<p>An opaque string that can be used as part of a subsequent <code>DescribeTapes</code> call to retrieve the next page of results.</p> <p>If a response does not contain a marker, then there are no more results to be retrieved.</p>

Example response

{
  "Marker": "1",
  "Tapes": [
    {
      "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1",
      "TapeBarcode": "TEST04A2A1",
      "TapeSizeInBytes": 107374182400,
      "TapeStatus": "AVAILABLE"
    },
    {
      "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0",
      "TapeBarcode": "TEST05A2A0",
      "TapeSizeInBytes": 107374182400,
      "TapeStatus": "AVAILABLE"
    }
  ]
}