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 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 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 operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation 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 operation, 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.
Parameters:
-
file_system_ids
(Optional[FileSystemIds], default:
None
)
–
IDs of the file systems whose descriptions you want to retrieve (String).
-
max_results
(Optional[MaxResults], default:
None
)
–
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
(Optional[NextToken], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_fsx/_services/f_sx.py
| def describe_file_systems(
self,
*,
config_overrides: Optional[FSxClientConfig] = None,
file_system_ids: Optional[
"capo_fsx.types.file_system_ids.FileSystemIds"
] = None,
max_results: Optional["capo_fsx.types.max_results.MaxResults"] = None,
next_token: Optional["capo_fsx.types.next_token.NextToken"] = None,
) -> "capo_fsx.types.describe_file_systems_response.DescribeFileSystemsResponse":
"""<p>Returns the description of specific Amazon FSx file systems, if a <code>FileSystemIds</code> value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.</p> <p>When retrieving all file system descriptions, you can optionally specify the <code>MaxResults</code> parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response.</p> <p>This operation is used in an iterative process to retrieve a list of your file system descriptions. <code>DescribeFileSystems</code> is called first without a <code>NextToken</code>value. Then the operation continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code>.</p> <p>When using this operation, keep the following in mind:</p> <ul> <li> <p>The implementation might return fewer than <code>MaxResults</code> file system descriptions while still including a <code>NextToken</code> value.</p> </li> <li> <p>The order of file systems returned in the response of one <code>DescribeFileSystems</code> call and the order of file systems returned across the responses of a multicall iteration is unspecified.</p> </li> </ul>
Args:
file_system_ids: <p>IDs of the file systems whose descriptions you want to retrieve (String).</p>
max_results: <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: <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>
Raises:
capo_fsx.errors.bad_request.BadRequest: <p>A generic error indicating a failure with a client request.</p>
capo_fsx.errors.file_system_not_found.FileSystemNotFound: <p>No Amazon FSx file systems were found based upon supplied parameters.</p>
capo_fsx.errors.internal_server_error.InternalServerError: <p>A generic error indicating a server-side failure.</p>
capo_fsx.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_fsx.types.describe_file_systems_request.DescribeFileSystemsRequest]",
) -> OperationResponse[
"capo_fsx.types.describe_file_systems_response.DescribeFileSystemsResponse"
]:
import capo_fsx._operations.aws_simba_api_service_v20180301.describe_file_systems
output, http_response = (
capo_fsx._operations.aws_simba_api_service_v20180301.describe_file_systems.describe_file_systems(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_fsx.types.describe_file_systems_response.DescribeFileSystemsResponse",
) -> dict[str, Any]:
import capo_fsx.types.describe_file_systems_response
return capo_fsx.types.describe_file_systems_response.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("DescribeFileSystems", redact_output=_redact_output),
)
input_: capo_fsx.types.describe_file_systems_request.DescribeFileSystemsRequest = {}
if file_system_ids is not None:
input_["file_system_ids"] = file_system_ids
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|