Network.AWS.StorageGateway.ListVolumes

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.

Creating a Request

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

• lvGatewayARN
• lvMarker
• lvLimit

data ListVolumes

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

• ListVolumesInputLimit>
• ListVolumesInputMarker>

See: listVolumes smart constructor.

Instances

Eq ListVolumes

Methods

(==) :: ListVolumes -> ListVolumes -> Bool

(/=) :: ListVolumes -> ListVolumes -> Bool

Data ListVolumes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListVolumes -> c ListVolumes

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListVolumes

toConstr :: ListVolumes -> Constr

dataTypeOf :: ListVolumes -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListVolumes)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListVolumes)

gmapT :: (forall b. Data b => b -> b) -> ListVolumes -> ListVolumes

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListVolumes -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListVolumes -> r

gmapQ :: (forall d. Data d => d -> u) -> ListVolumes -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListVolumes -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListVolumes -> m ListVolumes

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVolumes -> m ListVolumes

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVolumes -> m ListVolumes

Read ListVolumes

Methods

readsPrec :: Int -> ReadS ListVolumes

readList :: ReadS [ListVolumes]

readPrec :: ReadPrec ListVolumes

readListPrec :: ReadPrec [ListVolumes]

Show ListVolumes

Methods

showsPrec :: Int -> ListVolumes -> ShowS

show :: ListVolumes -> String

showList :: [ListVolumes] -> ShowS

Generic ListVolumes

Associated Types

type Rep ListVolumes :: * -> *

Methods

from :: ListVolumes -> Rep ListVolumes x

to :: Rep ListVolumes x -> ListVolumes

Hashable ListVolumes

Methods

hashWithSalt :: Int -> ListVolumes -> Int

hash :: ListVolumes -> Int

NFData ListVolumes

Methods

rnf :: ListVolumes -> ()

AWSPager ListVolumes

Methods

page :: ListVolumes -> Rs ListVolumes -> Maybe ListVolumes

AWSRequest ListVolumes

Associated Types

type Rs ListVolumes :: *

Methods

request :: ListVolumes -> Request ListVolumes

response :: MonadResource m => Logger -> Service -> Proxy * ListVolumes -> ClientResponse -> m (Response ListVolumes)

ToPath ListVolumes

Methods

toPath :: ListVolumes -> ByteString

ToHeaders ListVolumes

Methods

toHeaders :: ListVolumes -> [Header]

ToQuery ListVolumes

Methods

toQuery :: ListVolumes -> QueryString

ToJSON ListVolumes

Methods

toJSON :: ListVolumes -> Value

toEncoding :: ListVolumes -> Encoding

type Rep ListVolumes

type Rep ListVolumes = D1 (MetaData "ListVolumes" "Network.AWS.StorageGateway.ListVolumes" "amazonka-storagegateway-1.4.4-HOInns2Rr9V9xD6G5ZVbNW" False) (C1 (MetaCons "ListVolumes'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lvGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lvMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lvLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))

type Rs ListVolumes

type Rs ListVolumes = ListVolumesResponse

Request Lenses

lvGatewayARN :: Lens' ListVolumes (Maybe Text)

Undocumented member.

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.

Destructuring the Response

listVolumesResponse

Arguments

:: Int

lvrsResponseStatus

-> 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
• lvrsResponseStatus

data ListVolumesResponse

See: listVolumesResponse smart constructor.

Instances

Eq ListVolumesResponse

Methods

(==) :: ListVolumesResponse -> ListVolumesResponse -> Bool

(/=) :: ListVolumesResponse -> ListVolumesResponse -> Bool

Data ListVolumesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListVolumesResponse -> c ListVolumesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListVolumesResponse

toConstr :: ListVolumesResponse -> Constr

dataTypeOf :: ListVolumesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListVolumesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListVolumesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListVolumesResponse -> ListVolumesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListVolumesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListVolumesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListVolumesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListVolumesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListVolumesResponse -> m ListVolumesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVolumesResponse -> m ListVolumesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVolumesResponse -> m ListVolumesResponse

Read ListVolumesResponse

Methods

readsPrec :: Int -> ReadS ListVolumesResponse

readList :: ReadS [ListVolumesResponse]

readPrec :: ReadPrec ListVolumesResponse

readListPrec :: ReadPrec [ListVolumesResponse]

Show ListVolumesResponse

Methods

showsPrec :: Int -> ListVolumesResponse -> ShowS

show :: ListVolumesResponse -> String

showList :: [ListVolumesResponse] -> ShowS

Generic ListVolumesResponse

Associated Types

type Rep ListVolumesResponse :: * -> *

Methods

from :: ListVolumesResponse -> Rep ListVolumesResponse x

to :: Rep ListVolumesResponse x -> ListVolumesResponse

NFData ListVolumesResponse

Methods

rnf :: ListVolumesResponse -> ()

type Rep ListVolumesResponse

type Rep ListVolumesResponse = D1 (MetaData "ListVolumesResponse" "Network.AWS.StorageGateway.ListVolumes" "amazonka-storagegateway-1.4.4-HOInns2Rr9V9xD6G5ZVbNW" False) (C1 (MetaCons "ListVolumesResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lvrsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lvrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lvrsVolumeInfos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [VolumeInfo]))) (S1 (MetaSel (Just Symbol "_lvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lvrsGatewayARN :: Lens' ListVolumesResponse (Maybe Text)

Undocumented member.

lvrsMarker :: Lens' ListVolumesResponse (Maybe Text)

Undocumented member.

lvrsVolumeInfos :: Lens' ListVolumesResponse [VolumeInfo]

Undocumented member.

lvrsResponseStatus :: Lens' ListVolumesResponse Int

The response status code.