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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribeFileSystemsAsync.

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

Syntax

C#
public abstract DescribeFileSystemsResponse DescribeFileSystems(
         DescribeFileSystemsRequest request
)
Parameters
request
Type: Amazon.ElasticFileSystem.Model.DescribeFileSystemsRequest

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

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 does not exist in the requester's AWS account.
InternalServerErrorException Returned if an error occurred on the server side.

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 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

See Also