Amazonka.FSx.DescribeVolumes

Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.

This operation returns paginated results.

Creating a Request

data DescribeVolumes

See: newDescribeVolumes smart constructor.

Constructors

DescribeVolumes'

Fields

• filters :: Maybe [VolumeFilter]

  Enter a filter Name and Values pair to view a select set of volumes.

• maxResults :: Maybe Natural
• nextToken :: Maybe Text
• volumeIds :: Maybe [Text]

  The IDs of the volumes whose descriptions you want to retrieve.

Instances

ToJSON DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

toJSON :: DescribeVolumes -> Value

toEncoding :: DescribeVolumes -> Encoding

toJSONList :: [DescribeVolumes] -> Value

toEncodingList :: [DescribeVolumes] -> Encoding

ToHeaders DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

toHeaders :: DescribeVolumes -> [Header]

ToPath DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

toPath :: DescribeVolumes -> ByteString

ToQuery DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

toQuery :: DescribeVolumes -> QueryString

AWSPager DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

page :: DescribeVolumes -> AWSResponse DescribeVolumes -> Maybe DescribeVolumes

AWSRequest DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Associated Types

type AWSResponse DescribeVolumes

Methods

request :: (Service -> Service) -> DescribeVolumes -> Request DescribeVolumes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeVolumes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeVolumes)))

Generic DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Associated Types

type Rep DescribeVolumes :: Type -> Type

Methods

from :: DescribeVolumes -> Rep DescribeVolumes x

to :: Rep DescribeVolumes x -> DescribeVolumes

Read DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

readsPrec :: Int -> ReadS DescribeVolumes

readList :: ReadS [DescribeVolumes]

readPrec :: ReadPrec DescribeVolumes

readListPrec :: ReadPrec [DescribeVolumes]

Show DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

showsPrec :: Int -> DescribeVolumes -> ShowS

show :: DescribeVolumes -> String

showList :: [DescribeVolumes] -> ShowS

NFData DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

rnf :: DescribeVolumes -> ()

Eq DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

(==) :: DescribeVolumes -> DescribeVolumes -> Bool

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

Hashable DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

Methods

hashWithSalt :: Int -> DescribeVolumes -> Int

hash :: DescribeVolumes -> Int

type AWSResponse DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

type AWSResponse DescribeVolumes = DescribeVolumesResponse

type Rep DescribeVolumes

Defined in Amazonka.FSx.DescribeVolumes

type Rep DescribeVolumes = D1 ('MetaData "DescribeVolumes" "Amazonka.FSx.DescribeVolumes" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeVolumes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VolumeFilter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "volumeIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeVolumes :: DescribeVolumes

Create a value of DescribeVolumes 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:filters:DescribeVolumes', describeVolumes_filters - Enter a filter Name and Values pair to view a select set of volumes.

$sel:maxResults:DescribeVolumes', describeVolumes_maxResults - Undocumented member.

DescribeVolumes, describeVolumes_nextToken - Undocumented member.

$sel:volumeIds:DescribeVolumes', describeVolumes_volumeIds - The IDs of the volumes whose descriptions you want to retrieve.

Request Lenses

describeVolumes_filters :: Lens' DescribeVolumes (Maybe [VolumeFilter])

Enter a filter Name and Values pair to view a select set of volumes.

describeVolumes_maxResults :: Lens' DescribeVolumes (Maybe Natural)

Undocumented member.

describeVolumes_nextToken :: Lens' DescribeVolumes (Maybe Text)

Undocumented member.

describeVolumes_volumeIds :: Lens' DescribeVolumes (Maybe [Text])

The IDs of the volumes whose descriptions you want to retrieve.

Destructuring the Response

data DescribeVolumesResponse

See: newDescribeVolumesResponse smart constructor.

Constructors

DescribeVolumesResponse'

Fields

• nextToken :: Maybe Text
• volumes :: Maybe [Volume]

  Returned after a successful DescribeVolumes operation, describing each volume.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeVolumesResponse

Defined in Amazonka.FSx.DescribeVolumes

Associated Types

type Rep DescribeVolumesResponse :: Type -> Type

Methods

from :: DescribeVolumesResponse -> Rep DescribeVolumesResponse x

to :: Rep DescribeVolumesResponse x -> DescribeVolumesResponse

Read DescribeVolumesResponse

Defined in Amazonka.FSx.DescribeVolumes

Methods

readsPrec :: Int -> ReadS DescribeVolumesResponse

readList :: ReadS [DescribeVolumesResponse]

readPrec :: ReadPrec DescribeVolumesResponse

readListPrec :: ReadPrec [DescribeVolumesResponse]

Show DescribeVolumesResponse

Defined in Amazonka.FSx.DescribeVolumes

Methods

showsPrec :: Int -> DescribeVolumesResponse -> ShowS

show :: DescribeVolumesResponse -> String

showList :: [DescribeVolumesResponse] -> ShowS

NFData DescribeVolumesResponse

Defined in Amazonka.FSx.DescribeVolumes

Methods

rnf :: DescribeVolumesResponse -> ()

Eq DescribeVolumesResponse

Defined in Amazonka.FSx.DescribeVolumes

Methods

(==) :: DescribeVolumesResponse -> DescribeVolumesResponse -> Bool

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

type Rep DescribeVolumesResponse

Defined in Amazonka.FSx.DescribeVolumes

type Rep DescribeVolumesResponse = D1 ('MetaData "DescribeVolumesResponse" "Amazonka.FSx.DescribeVolumes" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeVolumesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Volume])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeVolumesResponse

Arguments

:: Int

$sel:httpStatus:DescribeVolumesResponse'

-> DescribeVolumesResponse

Create a value of DescribeVolumesResponse 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:

DescribeVolumes, describeVolumesResponse_nextToken - Undocumented member.

$sel:volumes:DescribeVolumesResponse', describeVolumesResponse_volumes - Returned after a successful DescribeVolumes operation, describing each volume.

$sel:httpStatus:DescribeVolumesResponse', describeVolumesResponse_httpStatus - The response's http status code.

Response Lenses

describeVolumesResponse_nextToken :: Lens' DescribeVolumesResponse (Maybe Text)

Undocumented member.

describeVolumesResponse_volumes :: Lens' DescribeVolumesResponse (Maybe [Volume])

Returned after a successful DescribeVolumes operation, describing each volume.

describeVolumesResponse_httpStatus :: Lens' DescribeVolumesResponse Int

The response's http status code.