Container for the parameters to the DescribeFileSystems operation.
Returns the description of a specific Amazon EFS file system if either the file system
CreationToken or the FileSystemId is provided. Otherwise, it returns
descriptions of all file systems owned by the caller's 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 MaxItems
parameter to limit the number of descriptions in a response. This number is automatically
set to 100. If more file system descriptions remain, Amazon EFS returns a NextMarker,
an opaque token, in the response. In this case, you should send a subsequent request
with the Marker request parameter set to the value of NextMarker.
To retrieve a list of your file system descriptions, this operation is used in an
iterative process, where DescribeFileSystems is called first without the Marker
and then the operation continues to call it with the Marker parameter set to
the value of the NextMarker from the previous response until the response has
no NextMarker.
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 multi-call iteration
is unspecified.
This operation requires permissions for the elasticfilesystem:DescribeFileSystems
action.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.ElasticFileSystem.AmazonElasticFileSystemRequest
Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest
Namespace: Amazon.ElasticFileSystem.Model
Assembly: AWSSDK.ElasticFileSystem.dll
Version: 3.x.y.z
Syntax
public class DescribeFileSystemsRequest : AmazonElasticFileSystemRequest IAmazonWebServiceRequest
The DescribeFileSystemsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeFileSystemsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CreationToken | System.String |
Gets and sets the property CreationToken. (Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system. |
|
|
FileSystemId | System.String |
Gets and sets the property FileSystemId. (Optional) ID of the file system whose description you want to retrieve (String). |
|
|
Marker | System.String |
Gets and sets the property Marker.
(Optional) Opaque pagination token returned from a previous |
|
|
MaxItems | System.Int32 |
Gets and sets the property MaxItems. (Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems. |
Examples
This operation describes all of the EFS file systems in an account.
To describe an EFS file system
var client = new AmazonElasticFileSystemClient();
var response = client.DescribeFileSystems(new DescribeFileSystemsRequest
{
});
List<FileSystemDescription> fileSystems = response.FileSystems;
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5