Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

DescribeWorkingStorage

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.

Note

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.

Request Syntax

{
   "GatewayARN": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

Response Syntax

{
   "DiskIds": [ "string" ],
   "GatewayARN": "string",
   "WorkingStorageAllocatedInBytes": number,
   "WorkingStorageUsedInBytes": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DiskIds

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.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 300.

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

WorkingStorageAllocatedInBytes

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

Type: Long

WorkingStorageUsedInBytes

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

Type: Long

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Example

Example Request

The following example shows a request to obtain a description of a gateway's working storage.

Sample Request


POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20120630.DescribeWorkingStorage
{
   "GatewayARN":"arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
               

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 241
{
   "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-2:111122223333:gateway/sgw-12A3456B",
   "WorkingStorageAllocatedInBytes": 2199023255552,
   "WorkingStorageUsedInBytes": 789207040
}
               

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: