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

DescribeUploadBuffer

Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space 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",
   "UploadBufferAllocatedInBytes": number,
   "UploadBufferUsedInBytes": 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

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.

UploadBufferAllocatedInBytes

Type: Long

UploadBufferUsedInBytes

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
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20120630.DescribeUploadBuffer

{
   "GatewayARN":"arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}

            

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 271

{
  "DiskIds": [
    "pci-0000:03:00.0-scsi-0:0:0:0",
    "pci-0000:04:00.0-scsi-0:1:0:0"
  ],
  "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
  "UploadBufferAllocatedInBytes": 161061273600,
  "UploadBufferUsedInBytes": 0
}

            

See Also

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