Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information.

This operation is only supported in the tape gateway type.

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

Query parameters

Limitstring

Pagination limit

Markerstring

Pagination token

Headers

X-Amz-Target'StorageGateway_20130630.DescribeVTLDevices' 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.

VTLDeviceARNsVTLDeviceARN[]
<p>An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.</p> <note> <p>All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.</p> </note>
Markerstring

An opaque string that indicates the position at which to begin describing the VTL devices.

Limitinteger

Specifies that the number of VTL devices described be limited to the specified number.

Response

Success

GatewayARNstring

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.

Markerstring

An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

Example response

{
  "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B",
  "Marker": "1",
  "VTLDevices": [
    {
      "DeviceiSCSIAttributes": {
        "ChapEnabled": false,
        "NetworkInterfaceId": "10.243.43.207",
        "NetworkInterfacePort": 3260,
        "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger"
      },
      "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001",
      "VTLDeviceProductIdentifier": "L700",
      "VTLDeviceType": "Medium Changer",
      "VTLDeviceVendor": "STK"
    },
    {
      "DeviceiSCSIAttributes": {
        "ChapEnabled": false,
        "NetworkInterfaceId": "10.243.43.209",
        "NetworkInterfacePort": 3260,
        "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01"
      },
      "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001",
      "VTLDeviceProductIdentifier": "ULT3580-TD5",
      "VTLDeviceType": "Tape Drive",
      "VTLDeviceVendor": "IBM"
    },
    {
      "DeviceiSCSIAttributes": {
        "ChapEnabled": false,
        "NetworkInterfaceId": "10.243.43.209",
        "NetworkInterfacePort": 3260,
        "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02"
      },
      "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002",
      "VTLDeviceProductIdentifier": "ULT3580-TD5",
      "VTLDeviceType": "Tape Drive",
      "VTLDeviceVendor": "IBM"
    }
  ]
}