v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

post/#X-Amz-Target=StorageGateway_20130630.DescribeWorkingStorage

Headers

X-Amz-Target'StorageGateway_20130630.DescribeWorkingStorage' required

Request body

GatewayARNstring required

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

Response

Success

GatewayARNstring

The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.

DiskIdsDiskId[]

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

WorkingStorageUsedInBytesinteger

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

WorkingStorageAllocatedInBytesinteger

The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

Example response

{
  "DiskIds": [
    "pci-0000:03:00.0-scsi-0:0:0:0",
    "pci-0000:03:00.0-scsi-0:0:1:0"
  ],
  "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  "WorkingStorageAllocatedInBytes": 2199023255552,
  "WorkingStorageUsedInBytes": 789207040
}