Skip to content

DescribeFileSystemsRequest

Source code in docs_src/capo_fsx/types/describe_file_systems_request.py
class DescribeFileSystemsRequest(TypedDict, closed=True):
    file_system_ids: NotRequired["capo_fsx.types.file_system_ids.FileSystemIds"]
    """<p>IDs of the file systems whose descriptions you want to retrieve (String).</p>"""
    max_results: NotRequired["capo_fsx.types.max_results.MaxResults"]
    """<p>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 <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"""
    next_token: NotRequired["capo_fsx.types.next_token.NextToken"]
    """<p>Opaque pagination token returned from a previous <code>DescribeFileSystems</code> operation (String). If a token present, the operation continues the list from where the returning call left off.</p>"""

file_system_ids instance-attribute

file_system_ids: NotRequired[FileSystemIds]

IDs of the file systems whose descriptions you want to retrieve (String).

max_results instance-attribute

max_results: NotRequired[MaxResults]

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.

next_token instance-attribute

next_token: NotRequired[NextToken]

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.