Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Tape Structure

Describes a virtual tape object.

Type: object Properties: 13
BackupFile StorageGatewayHybrid CloudStorage

Tape is a JSON Structure definition published by Amazon Storage Gateway, describing 13 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

TapeARN TapeBarcode TapeCreatedDate TapeSizeInBytes TapeStatus VTLDevice Progress TapeUsedInBytes KMSKey PoolId Worm RetentionStartDate PoolEntryDate

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-tape-structure.json",
  "name": "Tape",
  "description": "Describes a virtual tape object.",
  "properties": {
    "TapeARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TapeARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the virtual tape."
        }
      ]
    },
    "TapeBarcode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TapeBarcode"
        },
        {
          "description": "The barcode that identifies a specific virtual tape."
        }
      ]
    },
    "TapeCreatedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Time"
        },
        {
          "description": "The date the virtual tape was created."
        }
      ]
    },
    "TapeSizeInBytes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TapeSize"
        },
        {
          "description": "The size, in bytes, of the virtual tape capacity."
        }
      ]
    },
    "TapeStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TapeStatus"
        },
        {
          "description": "The current state of the virtual tape."
        }
      ]
    },
    "VTLDevice": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VTLDeviceARN"
        },
        {
          "description": "The virtual tape library (VTL) device that the virtual tape is associated with."
        }
      ]
    },
    "Progress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DoubleObject"
        },
        {
          "description": "<p>For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.</p> <p>Range: 0 (not started) to 100 (complete).</p>"
        }
      ]
    },
    "TapeUsedInBytes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TapeUsage"
        },
        {
          "description": "<p>The size, in bytes, of data stored on the virtual tape.</p> <note> <p>This value is not available for tapes created prior to May 13, 2015.</p> </note>"
        }
      ]
    },
    "KMSKey": {
      "$ref": "#/components/schemas/KMSKey"
    },
    "PoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PoolId"
        },
        {
          "description": "The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool."
        }
      ]
    },
    "Worm": {
      "allOf": [
        {
          "$ref": "#/components/schemas/boolean"
        },
        {
          "description": "If the tape is archived as write-once-read-many (WORM), this value is <code>true</code>."
        }
      ]
    },
    "RetentionStartDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Time"
        },
        {
          "description": "The date that the tape is first archived with tape retention lock enabled."
        }
      ]
    },
    "PoolEntryDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Time"
        },
        {
          "description": "The date that the tape enters a custom tape pool."
        }
      ]
    }
  }
}