| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.StorageGateway.ListVolumes
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.
- listVolumes :: Text -> ListVolumes
- data ListVolumes
- lvMarker :: Lens' ListVolumes (Maybe Text)
- lvLimit :: Lens' ListVolumes (Maybe Natural)
- lvGatewayARN :: Lens' ListVolumes Text
- listVolumesResponse :: Int -> ListVolumesResponse
- data ListVolumesResponse
- lvrsGatewayARN :: Lens' ListVolumesResponse (Maybe Text)
- lvrsMarker :: Lens' ListVolumesResponse (Maybe Text)
- lvrsVolumeInfos :: Lens' ListVolumesResponse [VolumeInfo]
- lvrsStatus :: Lens' ListVolumesResponse Int
Creating a Request
Arguments
| :: Text | |
| -> ListVolumes |
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.
Instances
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
Arguments
| :: Int | |
| -> ListVolumesResponse |
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:
data ListVolumesResponse Source
See: listVolumesResponse smart constructor.
Response Lenses
lvrsGatewayARN :: Lens' ListVolumesResponse (Maybe Text) Source
Undocumented member.
lvrsMarker :: Lens' ListVolumesResponse (Maybe Text) Source
Undocumented member.
lvrsVolumeInfos :: Lens' ListVolumesResponse [VolumeInfo] Source
Undocumented member.
lvrsStatus :: Lens' ListVolumesResponse Int Source
The response status code.