Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Disk Structure

Represents a gateway's local disk.

Type: object Properties: 8
BackupFile StorageGatewayHybrid CloudStorage

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

Properties

DiskId DiskPath DiskNode DiskStatus DiskSizeInBytes DiskAllocationType DiskAllocationResource DiskAttributeList

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-disk-structure.json",
  "name": "Disk",
  "description": "Represents a gateway's local disk.",
  "properties": {
    "DiskId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DiskId"
        },
        {
          "description": "The unique device ID or other distinguishing data that identifies a local disk."
        }
      ]
    },
    "DiskPath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/string"
        },
        {
          "description": "The path of a local disk in the gateway virtual machine (VM)."
        }
      ]
    },
    "DiskNode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/string"
        },
        {
          "description": "The device node of a local disk as assigned by the virtualization environment."
        }
      ]
    },
    "DiskStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/string"
        },
        {
          "description": "A value that represents the status of a local disk."
        }
      ]
    },
    "DiskSizeInBytes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/long"
        },
        {
          "description": "The local disk size in bytes."
        }
      ]
    },
    "DiskAllocationType": {
      "$ref": "#/components/schemas/DiskAllocationType"
    },
    "DiskAllocationResource": {
      "allOf": [
        {
          "$ref": "#/components/schemas/string"
        },
        {
          "description": "The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is <i>targetIqn::LUNNumber::region-volumeId</i>."
        }
      ]
    },
    "DiskAttributeList": {
      "$ref": "#/components/schemas/DiskAttributeList"
    }
  }
}