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
Use a bare-bones client and the command you need to make an API call.
Returns the description of a specific Amazon EFS file system if either the file system
CreationTokenor theFileSystemIdis 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
MaxItemsparameter 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 aNextMarker, an opaque token, in the response. In this case, you should send a subsequent request with theMarkerrequest parameter set to the value ofNextMarker.To retrieve a list of your file system descriptions, this operation is used in an iterative process, where
DescribeFileSystemsis called first without theMarkerand then the operation continues to call it with theMarkerparameter set to the value of theNextMarkerfrom the previous response until the response has noNextMarker.The order of file systems returned in the response of one
DescribeFileSystemscall and the order of file systems returned across the responses of a multi-call iteration is unspecified.This operation requires permissions for the
elasticfilesystem:DescribeFileSystemsaction.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 command = new DescribeFileSystemsCommand(input); const response = await client.send(command);DescribeFileSystemsCommandInput for command's
inputshape.DescribeFileSystemsCommandOutput for command's
responseshape.config for EFSClient's
configshape.