Copyright | (c) 2013-2016 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 |
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.
This operation returns paginated results.
- listVolumes :: ListVolumes
- data ListVolumes
- lvGatewayARN :: Lens' ListVolumes (Maybe Text)
- lvMarker :: Lens' ListVolumes (Maybe Text)
- lvLimit :: Lens' ListVolumes (Maybe Natural)
- listVolumesResponse :: Int -> ListVolumesResponse
- data ListVolumesResponse
- lvrsGatewayARN :: Lens' ListVolumesResponse (Maybe Text)
- lvrsMarker :: Lens' ListVolumesResponse (Maybe Text)
- lvrsVolumeInfos :: Lens' ListVolumesResponse [VolumeInfo]
- lvrsResponseStatus :: Lens' ListVolumesResponse Int
Creating a Request
listVolumes :: 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:
lvGatewayARN
- Undocumented member.lvMarker
- 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
- Specifies that the list of volumes returned be limited to the specified number of items.
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
lvGatewayARN :: Lens' ListVolumes (Maybe Text) Source #
Undocumented member.
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.
Destructuring the Response
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:
lvrsGatewayARN
- Undocumented member.lvrsMarker
- Undocumented member.lvrsVolumeInfos
- Undocumented member.lvrsResponseStatus
- -- | The response status code.
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.
lvrsResponseStatus :: Lens' ListVolumesResponse Int Source #
- - | The response status code.