AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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 AWS account in the AWS 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. 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 implementation may return fewer than MaxItems file system descriptions while still including a NextMarker 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 multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticFileSystem.AmazonElasticFileSystemRequest
      Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest

Namespace: Amazon.ElasticFileSystem.Model
Assembly: AWSSDK.ElasticFileSystem.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeFileSystemsRequest : AmazonElasticFileSystemRequest
         IAmazonWebServiceRequest

The DescribeFileSystemsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property 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.

Public Property FileSystemId System.String

Gets and sets the property FileSystemId.

(Optional) ID of the file system whose description you want to retrieve (String).

Public Property Marker System.String

Gets and sets the property Marker.

(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.

Public Property MaxItems System.Int32

Gets and sets the property MaxItems.

(Optional) Specifies the 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 EFS returns is the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

Examples

This operation describes all of the EFS file systems in an account.

To describe an EFS file system


var response = client.DescribeFileSystems(new DescribeFileSystemsRequest 
{
});

List fileSystems = response.FileSystems;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms