AmazonFSxClient.DescribeFileSystems Method (DescribeFileSystemsRequest)

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 MaxResults file system descriptions while still including a NextToken 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 multicall iteration is unspecified.

Note:

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

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

Syntax

public virtual DescribeFileSystemsResponse DescribeFileSystems(
         DescribeFileSystemsRequest request
)

Parameters

request: Type: Amazon.FSx.Model.DescribeFileSystemsRequest

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

Return Value

Type: DescribeFileSystemsResponse

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

Exceptions

Exception	Condition
BadRequestException	A generic error indicating a failure with a client request.
FileSystemNotFoundException	No Amazon FSx file systems were found based upon supplied parameters.
InternalServerErrorException	A generic error indicating a server-side failure.

Examples

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

To describe an Amazon FSx file system


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

List<FileSystem> fileSystems = response.FileSystems;

Version Information

.NET Framework:
Supported in: 4.7.2 and newer

AmazonFSxClient.DescribeFileSystems (DescribeFileSystemsRequest)

Method