Amazon EBS · Schema
Volume
Volume schema from Amazon EBS Amazon Elastic Block Store (EBS) API
Amazon Web ServicesBlock StorageEBSEC2SnapshotsStorageVolumes
Properties
| Name | Type | Description |
|---|---|---|
| volumeId | string | The ID of the volume. |
| size | integer | The size of the volume, in GiBs. |
| volumeType | string | The volume type. |
| state | string | The volume state. |
| availabilityZone | string | The Availability Zone for the volume. |
| createTime | string | The time stamp when volume creation was initiated. |
| encrypted | boolean | Indicates whether the volume is encrypted. |
| kmsKeyId | string | The Amazon Resource Name (ARN) of the KMS key. |
| iops | integer | The number of I/O operations per second. |
| throughput | integer | The throughput that the volume supports, in MiB/s. |
| snapshotId | string | The snapshot from which the volume was created. |
| attachments | array | Information about the volume attachments. |
| tags | array | Any tags assigned to the volume. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ebs/refs/heads/main/json-schema/ebs-openapi-volume-schema.json",
"title": "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": "integer",
"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": "string",
"format": "date-time",
"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": "integer",
"description": "The number of I/O operations per second."
},
"throughput": {
"type": "integer",
"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": "string",
"format": "date-time"
}
}
},
"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."
}
}
}