Network.AWS.StorageGateway.ListVolumes

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.

Creating a Request

listVolumes

Arguments

:: Text

lvGatewayARN

-> 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:

• lvMarker
• lvLimit
• lvGatewayARN

data ListVolumes

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

• ListVolumesInput$Limit
• ListVolumesInput$Marker

See: listVolumes smart constructor.

Instances

Eq ListVolumes

Data ListVolumes

Read ListVolumes

Show ListVolumes

Generic ListVolumes

ToJSON ListVolumes

AWSPager ListVolumes

AWSRequest ListVolumes

ToPath ListVolumes

ToHeaders ListVolumes

ToQuery ListVolumes

Typeable * ListVolumes

type Rep ListVolumes

type Sv ListVolumes = StorageGateway

type Rs ListVolumes = ListVolumesResponse

Request Lenses

lvMarker :: Lens' ListVolumes (Maybe Text)

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)

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

lvGatewayARN :: Lens' ListVolumes Text

Undocumented member.

Destructuring the Response

listVolumesResponse

Arguments

:: Int

lvrsStatus

-> 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:

• lvrsGatewayARN
• lvrsMarker
• lvrsVolumeInfos
• lvrsStatus

data ListVolumesResponse

See: listVolumesResponse smart constructor.

Instances

Eq ListVolumesResponse

Data ListVolumesResponse

Read ListVolumesResponse

Show ListVolumesResponse

Generic ListVolumesResponse

Typeable * ListVolumesResponse

type Rep ListVolumesResponse

Response Lenses

lvrsGatewayARN :: Lens' ListVolumesResponse (Maybe Text)

Undocumented member.

lvrsMarker :: Lens' ListVolumesResponse (Maybe Text)

Undocumented member.

lvrsVolumeInfos :: Lens' ListVolumesResponse [VolumeInfo]

Undocumented member.

lvrsStatus :: Lens' ListVolumesResponse Int

The response status code.