AWS SDK Version 4 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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.7.2 or higher.

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

Syntax

C#
public virtual Task<DescribeFileSystemsResponse> DescribeFileSystemsAsync(
         DescribeFileSystemsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest

Container for the necessary parameters to execute the DescribeFileSystems service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeFileSystems service method, as returned by ElasticFileSystem.

Exceptions

ExceptionCondition
BadRequestException Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
FileSystemNotFoundException Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
InternalServerErrorException Returned if an error occurred on the server side.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer

See Also