Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Describe Tapes Input Structure

DescribeTapesInput

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

DescribeTapesInput 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 TapeARNs 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-tapes-input-structure.json",
  "name": "DescribeTapesInput",
  "description": "DescribeTapesInput",
  "properties": {
    "GatewayARN": {
      "$ref": "#/components/schemas/GatewayARN"
    },
    "TapeARNs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TapeARNs"
        },
        {
          "description": "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."
        }
      ]
    },
    "Marker": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Marker"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PositiveIntObject"
        },
        {
          "description": "<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>"
        }
      ]
    }
  },
  "required": [
    "GatewayARN"
  ]
}