Amazon EBS · JSON Structure

Ebs Openapi Volume Structure

Volume schema from Amazon EBS Amazon Elastic Block Store (EBS) API

Type: object Properties: 13
Amazon Web ServicesBlock StorageEBSEC2SnapshotsStorageVolumes

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

Properties

volumeId size volumeType state availabilityZone createTime encrypted kmsKeyId iops throughput snapshotId attachments tags

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ebs/refs/heads/main/json-structure/ebs-openapi-volume-structure.json",
  "name": "Volume",
  "description": "Volume schema from Amazon EBS Amazon Elastic Block Store (EBS) API",
  "type": "object",
  "properties": {
    "volumeId": {
      "type": "string",
      "description": "The ID of the volume."
    },
    "size": {
      "type": "int32",
      "description": "The size of the volume, in GiBs."
    },
    "volumeType": {
      "type": "string",
      "description": "The volume type."
    },
    "state": {
      "type": "string",
      "enum": [
        "creating",
        "available",
        "in-use",
        "deleting",
        "deleted",
        "error"
      ],
      "description": "The volume state."
    },
    "availabilityZone": {
      "type": "string",
      "description": "The Availability Zone for the volume."
    },
    "createTime": {
      "type": "datetime",
      "description": "The time stamp when volume creation was initiated."
    },
    "encrypted": {
      "type": "boolean",
      "description": "Indicates whether the volume is encrypted."
    },
    "kmsKeyId": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the KMS key."
    },
    "iops": {
      "type": "int32",
      "description": "The number of I/O operations per second."
    },
    "throughput": {
      "type": "int32",
      "description": "The throughput that the volume supports, in MiB/s."
    },
    "snapshotId": {
      "type": "string",
      "description": "The snapshot from which the volume was created."
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "volumeId": {
            "type": "string"
          },
          "instanceId": {
            "type": "string"
          },
          "device": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "attachTime": {
            "type": "datetime"
          }
        }
      },
      "description": "Information about the volume attachments."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "description": "Any tags assigned to the volume."
    }
  }
}