Amazon Storage Gateway · Schema
VolumeInfo
Describes a storage volume object.
BackupFile StorageGatewayHybrid CloudStorage
Properties
| Name | Type | Description |
|---|---|---|
| VolumeARN | object | |
| VolumeId | object | |
| GatewayARN | object | |
| GatewayId | object | |
| VolumeType | object | |
| VolumeSizeInBytes | object | |
| VolumeAttachmentStatus | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-schema/amazon-storage-gateway-volume-info-schema.json",
"title": "VolumeInfo",
"description": "Describes a storage volume object.",
"type": "object",
"properties": {
"VolumeARN": {
"allOf": [
{
"$ref": "#/components/schemas/VolumeARN"
},
{
"description": "<p>The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:</p> <p> <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB</code> </p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>"
}
]
},
"VolumeId": {
"allOf": [
{
"$ref": "#/components/schemas/VolumeId"
},
{
"description": "<p>The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.</p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>"
}
]
},
"GatewayARN": {
"$ref": "#/components/schemas/GatewayARN"
},
"GatewayId": {
"allOf": [
{
"$ref": "#/components/schemas/GatewayId"
},
{
"description": "<p>The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.</p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>"
}
]
},
"VolumeType": {
"allOf": [
{
"$ref": "#/components/schemas/VolumeType"
},
{
"description": "One of the VolumeType enumeration values describing the type of the volume."
}
]
},
"VolumeSizeInBytes": {
"allOf": [
{
"$ref": "#/components/schemas/long"
},
{
"description": "<p>The size of the volume in bytes.</p> <p>Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).</p>"
}
]
},
"VolumeAttachmentStatus": {
"allOf": [
{
"$ref": "#/components/schemas/VolumeAttachmentStatus"
},
{
"description": "One of the VolumeStatus values that indicates the state of the storage volume."
}
]
}
}
}