AmazonStorageGatewayClient.ListVolumes Method (ListVolumesRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListVolumesAsync.

Namespace: Amazon.StorageGateway
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

public virtual ListVolumesResponse ListVolumes(
         ListVolumesRequest request
)

Parameters

request: Type: Amazon.StorageGateway.Model.ListVolumesRequest

Container for the necessary parameters to execute the ListVolumes service method.

Return Value

Type: ListVolumesResponse

The response from the ListVolumes service method, as returned by StorageGateway.

Exceptions

Exception	Condition
InternalServerErrorException	An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException	An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

Examples

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.

To list the iSCSI stored volumes of a gateway


var client = new AmazonStorageGatewayClient();
var response = client.ListVolumes(new ListVolumesRequest 
{
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
    Limit = 2,
    Marker = "1"
});

string gatewayARN = response.GatewayARN;
string marker = response.Marker;
List<VolumeInfo> volumeInfos = response.VolumeInfos;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonStorageGatewayClient.ListVolumes (ListVolumesRequest)

Method