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

ListVolumes

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

Request Syntax

{
   "GatewayARN": "string",
   "Limit": number,
   "Marker": "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: No

Limit

Specifies that the list of volumes returned be limited to the specified number of items.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Marker

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

Type: String

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

Required: No

Response Syntax

{
   "GatewayARN": "string",
   "Marker": "string",
   "VolumeInfos": [ 
      { 
         "GatewayARN": "string",
         "GatewayId": "string",
         "VolumeARN": "string",
         "VolumeId": "string",
         "VolumeSizeInBytes": number,
         "VolumeType": "string"
      }
   ]
}

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.

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.

Marker

Type: String

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

VolumeInfos

Type: Array of VolumeInfo objects

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 ListVolumes request in this example does not specify a limit or marker field in the response body. If the number of volumes in the gateway is greater than 100, the response returns first 100.

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.ListVolumes
{
   "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: 346
{
   "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
   "VolumeInfos": [
      {
         "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
         "GatewayId": "sgw-12A3456B",
         "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
         "VolumeId": "vol-1122AABB",
         "VolumeSizeInBytes: "107374182400",
         "VolumeType": "STORED"
      },
      {
         "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-13B4567C",
         "GatewayId": "sgw-gw-13B4567C",
         "VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD",
         VolumeId": "vol-1122AABB",
         "VolumeSizeInBytes: "107374182400",
         "VolumeType": "STORED"
      },
   ]
}
               

See Also

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