Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Describe Vtl Devices Input Structure

DescribeVTLDevicesInput

Type: object Properties: 4 Required: 1
BackupFile StorageGatewayHybrid CloudStorage

DescribeVTLDevicesInput is a JSON Structure definition published by Amazon Storage Gateway, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

GatewayARN VTLDeviceARNs Marker Limit

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-structure/amazon-storage-gateway-describe-vtl-devices-input-structure.json",
  "name": "DescribeVTLDevicesInput",
  "description": "DescribeVTLDevicesInput",
  "properties": {
    "GatewayARN": {
      "$ref": "#/components/schemas/GatewayARN"
    },
    "VTLDeviceARNs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VTLDeviceARNs"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "Marker": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Marker"
        },
        {
          "description": "An opaque string that indicates the position at which to begin describing the VTL devices."
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PositiveIntObject"
        },
        {
          "description": "Specifies that the number of VTL devices described be limited to the specified number."
        }
      ]
    }
  },
  "required": [
    "GatewayARN"
  ]
}