Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StorageGateway.ListVolumes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 or the DescribeCachediSCSIVolumes 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 is only supported in the cached volume and stored volume gateway types.

This operation returns paginated results.

Synopsis

Creating a Request

data ListVolumes Source #

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

ListVolumesInput$Limit
ListVolumesInput$Marker

See: newListVolumes smart constructor.

Constructors

ListVolumes'
Fields gatewayARN :: Maybe Text marker :: 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. limit :: Maybe Natural Specifies that the list of volumes returned be limited to the specified number of items.

Instances

Instances details

Eq ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods (==) :: ListVolumes -> ListVolumes -> Bool # (/=) :: ListVolumes -> ListVolumes -> Bool #
Read ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods readsPrec :: Int -> ReadS ListVolumes # readList :: ReadS [ListVolumes] # readPrec :: ReadPrec ListVolumes # readListPrec :: ReadPrec [ListVolumes] #
Show ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods showsPrec :: Int -> ListVolumes -> ShowS # show :: ListVolumes -> String # showList :: [ListVolumes] -> ShowS #
Generic ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Associated Types type Rep ListVolumes :: Type -> Type # Methods from :: ListVolumes -> Rep ListVolumes x # to :: Rep ListVolumes x -> ListVolumes #
NFData ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods rnf :: ListVolumes -> () #
Hashable ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods hashWithSalt :: Int -> ListVolumes -> Int # hash :: ListVolumes -> Int #
ToJSON ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods toJSON :: ListVolumes -> Value # toEncoding :: ListVolumes -> Encoding # toJSONList :: [ListVolumes] -> Value # toEncodingList :: [ListVolumes] -> Encoding #
AWSPager ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods page :: ListVolumes -> AWSResponse ListVolumes -> Maybe ListVolumes #
AWSRequest ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Associated Types type AWSResponse ListVolumes # Methods request :: ListVolumes -> Request ListVolumes # response :: MonadResource m => Logger -> Service -> Proxy ListVolumes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListVolumes))) #
ToHeaders ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods toHeaders :: ListVolumes -> [Header] #
ToPath ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods toPath :: ListVolumes -> ByteString #
ToQuery ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods toQuery :: ListVolumes -> QueryString #
type Rep ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes type Rep ListVolumes = D1 ('MetaData "ListVolumes" "Amazonka.StorageGateway.ListVolumes" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "ListVolumes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListVolumes Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes type AWSResponse ListVolumes = ListVolumesResponse

newListVolumes :: ListVolumes Source #

Create a value of ListVolumes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:gatewayARN:ListVolumes', listVolumes_gatewayARN - Undocumented member.

$sel:marker:ListVolumes', listVolumes_marker - 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.

$sel:limit:ListVolumes', listVolumes_limit - Specifies that the list of volumes returned be limited to the specified number of items.

Request Lenses

listVolumes_gatewayARN :: Lens' ListVolumes (Maybe Text) Source #

Undocumented member.

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

listVolumes_limit :: Lens' ListVolumes (Maybe Natural) Source #

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

Destructuring the Response

data ListVolumesResponse Source #

A JSON object containing the following fields:

ListVolumesOutput$Marker
ListVolumesOutput$VolumeInfos

See: newListVolumesResponse smart constructor.

Constructors

ListVolumesResponse'

Fields

gatewayARN :: Maybe Text
marker :: Maybe Text
Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.
volumeInfos :: Maybe [VolumeInfo]
An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListVolumesResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods (==) :: ListVolumesResponse -> ListVolumesResponse -> Bool # (/=) :: ListVolumesResponse -> ListVolumesResponse -> Bool #
Read ListVolumesResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods readsPrec :: Int -> ReadS ListVolumesResponse # readList :: ReadS [ListVolumesResponse] # readPrec :: ReadPrec ListVolumesResponse # readListPrec :: ReadPrec [ListVolumesResponse] #
Show ListVolumesResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods showsPrec :: Int -> ListVolumesResponse -> ShowS # show :: ListVolumesResponse -> String # showList :: [ListVolumesResponse] -> ShowS #
Generic ListVolumesResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Associated Types type Rep ListVolumesResponse :: Type -> Type # Methods from :: ListVolumesResponse -> Rep ListVolumesResponse x # to :: Rep ListVolumesResponse x -> ListVolumesResponse #
NFData ListVolumesResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes Methods rnf :: ListVolumesResponse -> () #
type Rep ListVolumesResponse Source #
Instance details Defined in Amazonka.StorageGateway.ListVolumes type Rep ListVolumesResponse = D1 ('MetaData "ListVolumesResponse" "Amazonka.StorageGateway.ListVolumes" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "ListVolumesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "volumeInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VolumeInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListVolumesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListVolumesResponse'`
-> ListVolumesResponse

Create a value of ListVolumesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:gatewayARN:ListVolumes', listVolumesResponse_gatewayARN - Undocumented member.

$sel:marker:ListVolumes', listVolumesResponse_marker - Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

$sel:volumeInfos:ListVolumesResponse', listVolumesResponse_volumeInfos - An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".

$sel:httpStatus:ListVolumesResponse', listVolumesResponse_httpStatus - The response's http status code.

Response Lenses

listVolumesResponse_gatewayARN :: Lens' ListVolumesResponse (Maybe Text) Source #

Undocumented member.

listVolumesResponse_marker :: Lens' ListVolumesResponse (Maybe Text) Source #

Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

listVolumesResponse_volumeInfos :: Lens' ListVolumesResponse (Maybe [VolumeInfo]) Source #

An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".

listVolumesResponse_httpStatus :: Lens' ListVolumesResponse Int Source #

The response's http status code.