AWS Storage Gateway
User Guide (API Version 2012-06-30)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

AddWorkingStorage

Description

This operation configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture (see How AWS Storage Gateway Works).

Note

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

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

Request

Syntax

POST / HTTP/1.1 
Host: storagegateway.region.amazonaws.com
Authorization: authorization
Content-Type: application/x-amz-json-1.1
x-amz-date: date
x-amz-target: StorageGateway_20120630.AddWorkingStorage

{
  "GatewayARN": "String",
  "DiskIds": [
     "String",
     ...
  ]
}

JSON Fields

DiskIds

An array of strings that identify disks that are to be configured as working storage. Each string in the array must be minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

Required: Yes

Type: Array

GatewayARN

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

Required: yes

Type: String

Response

Syntax

HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Content-Type: application/x-amz-json-1.1
Content-length: payloadLength
Date: date

{
  "GatewayARN": "String"
}

JSON Fields

GatewayARN

The ARN of the gateway for which working storage was configured.

Type: String

Errors

This operation returns the following error codes in addition to exceptions common to all operations. For information about these errors and common exceptions, see Error Responses.

  • DiskAlreadyAllocated

  • DiskDoesNotExist

  • GatewayInternalError

  • GatewayNotConnected

  • GatewayNotFound

  • GatewayProxyNetworkConnectionBusy

  • InternalError

  • InvalidParameters

  • LocalStorageLimitExceeded

  • NotSupported

  • UnsupportedOperationForGatewayType

Examples

Example Request

The following example shows a request that specifies that two local disks of a gateway are to be configured as working storage.

POST / HTTP/1.1 
Host: storagegateway.us-east-1.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20120630.AddWorkingStorage

{
  "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway"
  "DiskIds": [   
     "pci-0000:03:00.0-scsi-0:0:0:0", 
     "pci-0000:03:00.0-scsi-0:0:1:0"
  ]  
}

Example 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: 85

{
  "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway"
}