amazonka-storagegateway-1.0.1: Amazon Storage Gateway SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StorageGateway.ListVolumes

Contents

Description

This operation 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 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.

See: AWS API Reference for ListVolumes.

This operation returns paginated results.

Synopsis

Creating a Request

listVolumes Source

Creates a value of ListVolumes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ListVolumes Source

A JSON object that contains one or more of the following fields:

  • ListVolumesInput$Limit
  • ListVolumesInput$Marker

See: listVolumes smart constructor.

Request Lenses

lvMarker :: Lens' ListVolumes (Maybe Text) Source

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.

lvLimit :: Lens' ListVolumes (Maybe Natural) Source

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

lvGatewayARN :: Lens' ListVolumes Text Source

Undocumented member.

Destructuring the Response

listVolumesResponse Source

Creates a value of ListVolumesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

lvrsStatus :: Lens' ListVolumesResponse Int Source

The response status code.