DescribeFileSystemsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EFSClient, DescribeFileSystemsCommand } from "@aws-sdk/client-efs"; // ES Modules import
// const { EFSClient, DescribeFileSystemsCommand } = require("@aws-sdk/client-efs"); // CommonJS import
const client = new EFSClient(config);
const input = { // DescribeFileSystemsRequest
  MaxItems: Number("int"),
  Marker: "STRING_VALUE",
  CreationToken: "STRING_VALUE",
  FileSystemId: "STRING_VALUE",
};
const command = new DescribeFileSystemsCommand(input);
const response = await client.send(command);
// { // DescribeFileSystemsResponse
//   Marker: "STRING_VALUE",
//   FileSystems: [ // FileSystemDescriptions
//     { // FileSystemDescription
//       OwnerId: "STRING_VALUE", // required
//       CreationToken: "STRING_VALUE", // required
//       FileSystemId: "STRING_VALUE", // required
//       FileSystemArn: "STRING_VALUE",
//       CreationTime: new Date("TIMESTAMP"), // required
//       LifeCycleState: "creating" || "available" || "updating" || "deleting" || "deleted" || "error", // required
//       Name: "STRING_VALUE",
//       NumberOfMountTargets: Number("int"), // required
//       SizeInBytes: { // FileSystemSize
//         Value: Number("long"), // required
//         Timestamp: new Date("TIMESTAMP"),
//         ValueInIA: Number("long"),
//         ValueInStandard: Number("long"),
//         ValueInArchive: Number("long"),
//       },
//       PerformanceMode: "generalPurpose" || "maxIO", // required
//       Encrypted: true || false,
//       KmsKeyId: "STRING_VALUE",
//       ThroughputMode: "bursting" || "provisioned" || "elastic",
//       ProvisionedThroughputInMibps: Number("double"),
//       AvailabilityZoneName: "STRING_VALUE",
//       AvailabilityZoneId: "STRING_VALUE",
//       Tags: [ // Tags // required
//         { // Tag
//           Key: "STRING_VALUE", // required
//           Value: "STRING_VALUE", // required
//         },
//       ],
//       FileSystemProtection: { // FileSystemProtectionDescription
//         ReplicationOverwriteProtection: "ENABLED" || "DISABLED" || "REPLICATING",
//       },
//     },
//   ],
//   NextMarker: "STRING_VALUE",
// };

DescribeFileSystemsCommand Input

See DescribeFileSystemsCommandInput for more details

Parameter
Type
Description
CreationToken
string | undefined

(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
string | undefined

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

Marker
string | undefined

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

MaxItems
number | undefined

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

DescribeFileSystemsCommand Output

See DescribeFileSystemsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FileSystems
FileSystemDescription[] | undefined

An array of file system descriptions.

Marker
string | undefined

Present if provided by caller in the request (String).

NextMarker
string | undefined

Present if there are more file systems than returned in the response (String). You can use the NextMarker in the subsequent request to fetch the descriptions.

Throws

Name
Fault
Details
BadRequest
client

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

FileSystemNotFound
client

Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.

InternalServerError
server

Returned if an error occurred on the server side.

EFSServiceException
Base exception class for all service exceptions from EFS service.