amazonka-fsx-2.0: Amazon FSx SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FSx.DescribeVolumes

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeVolumes Source #

See: newDescribeVolumes smart constructor.

Constructors

DescribeVolumes' 

Fields

Instances

Instances details
ToJSON DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

ToHeaders DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

ToPath DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

ToQuery DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

AWSPager DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

AWSRequest DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Associated Types

type AWSResponse DescribeVolumes #

Generic DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Associated Types

type Rep DescribeVolumes :: Type -> Type #

Read DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Show DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

NFData DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Methods

rnf :: DescribeVolumes -> () #

Eq DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Hashable DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

type AWSResponse DescribeVolumes Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

type Rep DescribeVolumes Source # 
Instance details

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 Source #

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]) Source #

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

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

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

Destructuring the Response

data DescribeVolumesResponse Source #

See: newDescribeVolumesResponse smart constructor.

Constructors

DescribeVolumesResponse' 

Fields

Instances

Instances details
Generic DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Associated Types

type Rep DescribeVolumesResponse :: Type -> Type #

Read DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Show DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

NFData DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

Methods

rnf :: DescribeVolumesResponse -> () #

Eq DescribeVolumesResponse Source # 
Instance details

Defined in Amazonka.FSx.DescribeVolumes

type Rep DescribeVolumesResponse Source # 
Instance details

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 Source #

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_volumes :: Lens' DescribeVolumesResponse (Maybe [Volume]) Source #

Returned after a successful DescribeVolumes operation, describing each volume.