Amazonka.FSx.DescribeFileSystems

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

• The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
• The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

This operation returns paginated results.

Creating a Request

data DescribeFileSystems

The request object for DescribeFileSystems operation.

See: newDescribeFileSystems smart constructor.

Constructors

DescribeFileSystems'

Fields

• fileSystemIds :: Maybe [Text]

  IDs of the file systems whose descriptions you want to retrieve (String).

• maxResults :: Maybe Natural

  Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

• nextToken :: Maybe Text

  Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

Instances

ToJSON DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

toJSON :: DescribeFileSystems -> Value

toEncoding :: DescribeFileSystems -> Encoding

toJSONList :: [DescribeFileSystems] -> Value

toEncodingList :: [DescribeFileSystems] -> Encoding

ToHeaders DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

toHeaders :: DescribeFileSystems -> [Header]

ToPath DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

toPath :: DescribeFileSystems -> ByteString

ToQuery DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

toQuery :: DescribeFileSystems -> QueryString

AWSPager DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

page :: DescribeFileSystems -> AWSResponse DescribeFileSystems -> Maybe DescribeFileSystems

AWSRequest DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Associated Types

type AWSResponse DescribeFileSystems

Methods

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

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

Generic DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Associated Types

type Rep DescribeFileSystems :: Type -> Type

Methods

from :: DescribeFileSystems -> Rep DescribeFileSystems x

to :: Rep DescribeFileSystems x -> DescribeFileSystems

Read DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

readsPrec :: Int -> ReadS DescribeFileSystems

readList :: ReadS [DescribeFileSystems]

readPrec :: ReadPrec DescribeFileSystems

readListPrec :: ReadPrec [DescribeFileSystems]

Show DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

showsPrec :: Int -> DescribeFileSystems -> ShowS

show :: DescribeFileSystems -> String

showList :: [DescribeFileSystems] -> ShowS

NFData DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

rnf :: DescribeFileSystems -> ()

Eq DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

(==) :: DescribeFileSystems -> DescribeFileSystems -> Bool

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

Hashable DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

Methods

hashWithSalt :: Int -> DescribeFileSystems -> Int

hash :: DescribeFileSystems -> Int

type AWSResponse DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

type AWSResponse DescribeFileSystems = DescribeFileSystemsResponse

type Rep DescribeFileSystems

Defined in Amazonka.FSx.DescribeFileSystems

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

newDescribeFileSystems :: DescribeFileSystems

Create a value of DescribeFileSystems 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:fileSystemIds:DescribeFileSystems', describeFileSystems_fileSystemIds - IDs of the file systems whose descriptions you want to retrieve (String).

$sel:maxResults:DescribeFileSystems', describeFileSystems_maxResults - Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

DescribeFileSystems, describeFileSystems_nextToken - Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

Request Lenses

describeFileSystems_fileSystemIds :: Lens' DescribeFileSystems (Maybe [Text])

IDs of the file systems whose descriptions you want to retrieve (String).

describeFileSystems_maxResults :: Lens' DescribeFileSystems (Maybe Natural)

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

describeFileSystems_nextToken :: Lens' DescribeFileSystems (Maybe Text)

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

Destructuring the Response

data DescribeFileSystemsResponse

The response object for DescribeFileSystems operation.

See: newDescribeFileSystemsResponse smart constructor.

Constructors

DescribeFileSystemsResponse'

Fields

• fileSystems :: Maybe [FileSystem]

  An array of file system descriptions.

• nextToken :: Maybe Text

  Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeFileSystemsResponse

Defined in Amazonka.FSx.DescribeFileSystems

Associated Types

type Rep DescribeFileSystemsResponse :: Type -> Type

Methods

from :: DescribeFileSystemsResponse -> Rep DescribeFileSystemsResponse x

to :: Rep DescribeFileSystemsResponse x -> DescribeFileSystemsResponse

Read DescribeFileSystemsResponse

Defined in Amazonka.FSx.DescribeFileSystems

Methods

readsPrec :: Int -> ReadS DescribeFileSystemsResponse

readList :: ReadS [DescribeFileSystemsResponse]

readPrec :: ReadPrec DescribeFileSystemsResponse

readListPrec :: ReadPrec [DescribeFileSystemsResponse]

Show DescribeFileSystemsResponse

Defined in Amazonka.FSx.DescribeFileSystems

Methods

showsPrec :: Int -> DescribeFileSystemsResponse -> ShowS

show :: DescribeFileSystemsResponse -> String

showList :: [DescribeFileSystemsResponse] -> ShowS

NFData DescribeFileSystemsResponse

Defined in Amazonka.FSx.DescribeFileSystems

Methods

rnf :: DescribeFileSystemsResponse -> ()

Eq DescribeFileSystemsResponse

Defined in Amazonka.FSx.DescribeFileSystems

Methods

(==) :: DescribeFileSystemsResponse -> DescribeFileSystemsResponse -> Bool

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

type Rep DescribeFileSystemsResponse

Defined in Amazonka.FSx.DescribeFileSystems

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

newDescribeFileSystemsResponse

Arguments

:: Int

$sel:httpStatus:DescribeFileSystemsResponse'

-> DescribeFileSystemsResponse

Create a value of DescribeFileSystemsResponse 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:fileSystems:DescribeFileSystemsResponse', describeFileSystemsResponse_fileSystems - An array of file system descriptions.

DescribeFileSystems, describeFileSystemsResponse_nextToken - Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

$sel:httpStatus:DescribeFileSystemsResponse', describeFileSystemsResponse_httpStatus - The response's http status code.

Response Lenses

describeFileSystemsResponse_fileSystems :: Lens' DescribeFileSystemsResponse (Maybe [FileSystem])

An array of file system descriptions.

describeFileSystemsResponse_nextToken :: Lens' DescribeFileSystemsResponse (Maybe Text)

Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

describeFileSystemsResponse_httpStatus :: Lens' DescribeFileSystemsResponse Int

The response's http status code.