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 AWS account in
the AWS Region of the endpoint that you\'re calling.
fsx_describe_file_systems(FileSystemIds, MaxResults, NextToken)
(Optional) IDs of the file systems whose descriptions you want to retrieve (String).
(Optional) Maximum number of file systems to return in the response
(integer). This parameter value must be greater than 0. The number of
items that Amazon FSx returns is the minimum of the MaxResults
parameter specified in the request and the service\'s internal maximum
number of items per page.
(Optional) Opaque pagination token returned from a previous
DescribeFileSystems
operation (String). If a token present, the action
continues the list from where the returning call left off.
svc$describe_file_systems( FileSystemIds = list( "string" ), MaxResults = 123, NextToken = "string" )
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 action is used in an iterative process to retrieve a list of your
file system descriptions. DescribeFileSystems
is called first without
a NextToken
value. Then the action 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 action, 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.
# NOT RUN {
# This operation describes all of the Amazon FSx file systems in an
# account.
svc$describe_file_systems()
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab