aws_sdk_fsx/client/describe_file_systems.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`DescribeFileSystems`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`file_system_ids(impl Into<String>)`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::file_system_ids) / [`set_file_system_ids(Option<Vec::<String>>)`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::set_file_system_ids):<br>required: **false**<br><p>IDs of the file systems whose descriptions you want to retrieve (String).</p><br>
8 /// - [`max_results(i32)`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::set_max_results):<br>required: **false**<br><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><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
10 /// - On success, responds with [`DescribeFileSystemsOutput`](crate::operation::describe_file_systems::DescribeFileSystemsOutput) with field(s):
11 /// - [`file_systems(Option<Vec::<FileSystem>>)`](crate::operation::describe_file_systems::DescribeFileSystemsOutput::file_systems): <p>An array of file system descriptions.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::describe_file_systems::DescribeFileSystemsOutput::next_token): <p>Present if there are more file systems than returned in the response (String). You can use the <code>NextToken</code> value in the later request to fetch the descriptions.</p>
13 /// - On failure, responds with [`SdkError<DescribeFileSystemsError>`](crate::operation::describe_file_systems::DescribeFileSystemsError)
14 pub fn describe_file_systems(&self) -> crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder {
15 crate::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder::new(self.handle.clone())
16 }
17}