| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.FSx.DescribeFileSystems
Description
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
MaxResultsfile system descriptions while still including aNextTokenvalue. - The order of file systems returned in the response of one
DescribeFileSystemscall and the order of file systems returned across the responses of a multicall iteration is unspecified.
This operation returns paginated results.
Synopsis
- data DescribeFileSystems = DescribeFileSystems' {
- fileSystemIds :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- newDescribeFileSystems :: DescribeFileSystems
- describeFileSystems_fileSystemIds :: Lens' DescribeFileSystems (Maybe [Text])
- describeFileSystems_maxResults :: Lens' DescribeFileSystems (Maybe Natural)
- describeFileSystems_nextToken :: Lens' DescribeFileSystems (Maybe Text)
- data DescribeFileSystemsResponse = DescribeFileSystemsResponse' {
- fileSystems :: Maybe [FileSystem]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeFileSystemsResponse :: Int -> DescribeFileSystemsResponse
- describeFileSystemsResponse_fileSystems :: Lens' DescribeFileSystemsResponse (Maybe [FileSystem])
- describeFileSystemsResponse_nextToken :: Lens' DescribeFileSystemsResponse (Maybe Text)
- describeFileSystemsResponse_httpStatus :: Lens' DescribeFileSystemsResponse Int
Creating a Request
data DescribeFileSystems Source #
The request object for DescribeFileSystems operation.
See: newDescribeFileSystems smart constructor.
Constructors
| DescribeFileSystems' | |
Fields
| |
Instances
newDescribeFileSystems :: DescribeFileSystems Source #
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]) Source #
IDs of the file systems whose descriptions you want to retrieve (String).
describeFileSystems_maxResults :: Lens' DescribeFileSystems (Maybe Natural) Source #
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) Source #
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 Source #
The response object for DescribeFileSystems operation.
See: newDescribeFileSystemsResponse smart constructor.
Constructors
| DescribeFileSystemsResponse' | |
Fields
| |
Instances
newDescribeFileSystemsResponse Source #
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]) Source #
An array of file system descriptions.
describeFileSystemsResponse_nextToken :: Lens' DescribeFileSystemsResponse (Maybe Text) Source #
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 Source #
The response's http status code.