/AWS1/CL_EFS=>DESCRIBEFILESYSTEMS()
¶
About DescribeFileSystems¶
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.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_MAXITEMS
TYPE /AWS1/EFSMAXITEMS
/AWS1/EFSMAXITEMS
¶
(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.
IV_MARKER
TYPE /AWS1/EFSMARKER
/AWS1/EFSMARKER
¶
(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.
IV_CREATIONTOKEN
TYPE /AWS1/EFSCREATIONTOKEN
/AWS1/EFSCREATIONTOKEN
¶
(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.
IV_FILESYSTEMID
TYPE /AWS1/EFSFILESYSTEMID
/AWS1/EFSFILESYSTEMID
¶
(Optional) ID of the file system whose description you want to retrieve (String).